com.healthmarketscience.jackcess
Class Column

java.lang.Object
  com.healthmarketscience.jackcess.Column

All Implemented Interfaces:

java.lang.Comparable<Column>

public class Column
extends java.lang.Object
implements java.lang.Comparable<Column>

Access database column definition

Nested Class Summary

class	Column.AutoNumberGenerator Base class for the supported autonumber types.
static class	Column.SortOrder Information about the sort order (collation) for a textual column.

Field Summary

static java.lang.Object	AUTO_NUMBER Meaningless placeholder object for inserting values in an autonumber column. it is not required that this value be used (any passed in value is ignored), but using this placeholder may make code more obvious.
static byte	AUTO_NUMBER_FLAG_MASK mask for the auto number bit
static byte	AUTO_NUMBER_GUID_FLAG_MASK mask for the auto number guid bit
static byte	FIXED_LEN_FLAG_MASK mask for the fixed len bit
static Column.SortOrder	GENERAL_LEGACY_SORT_ORDER the "general" text sort order, legacy version (access 2000-2007)
static Column.SortOrder	GENERAL_SORT_ORDER the "general" text sort order, latest version (access 2010+)
static java.lang.Object	KEEP_VALUE Meaningless placeholder object for updating rows which indicates that a given column should keep its existing value.
static byte	UNKNOWN_FLAG_MASK mask for the unknown bit (possible "can be null"?)

Constructor Summary

Column()

Column(JetFormat format)

Column(Table table, java.nio.ByteBuffer buffer, int offset, int displayIndex)
Read a column definition in from a buffer

Method Summary

protected static java.lang.Object	booleanToInteger(java.lang.Object obj) Treat booleans as integers (C-style).
int	compareTo(Column other) Orders Columns by column number.
static short	countNonLongVariableLength(java.util.List<Column> columns)
static short	countVariableLength(java.util.List<Column> columns)
static java.lang.String	decodeUncompressedText(byte[] textBytes, java.nio.charset.Charset charset)
static java.nio.ByteBuffer	encodeUncompressedText(java.lang.CharSequence text, java.nio.charset.Charset charset)
Column.AutoNumberGenerator	getAutoNumberGenerator() Returns the AutoNumberGenerator for this column if this is an autonumber column, null otherwise.
protected java.nio.charset.Charset	getCharset()
int	getColumnIndex()
short	getColumnNumber()
ComplexColumnInfo<? extends ComplexValue>	getComplexInfo() Returns extended functionality for "complex" columns.
Database	getDatabase()
int	getDisplayIndex()
int	getFixedDataOffset()
JetFormat	getFormat()
short	getLength()
short	getLengthInUnits()
java.lang.String	getName()
PageChannel	getPageChannel()
byte	getPrecision()
PropertyMap	getProperties()
java.lang.Object	getRowValue(java.util.Map<java.lang.String,?> rowMap)
java.lang.Object	getRowValue(java.lang.Object[] rowArray)
byte	getScale()
int	getSQLType()
Table	getTable()
short	getTextCodePage()
Column.SortOrder	getTextSortOrder()
protected java.util.TimeZone	getTimeZone()
DataType	getType()
int	getVarLenTableIndex()
Column	getVersionHistoryColumn() Returns the column which tracks the version history for an "append only" column.
boolean	isAppendOnly() Whether or not this column is "append only" (its history is tracked by a separate version history column).
boolean	isAutoNumber()
boolean	isCompressedUnicode()
boolean	isVariableLength()
java.lang.Object	read(byte[] data) Deserialize a raw byte value for this column into an Object
java.lang.Object	read(byte[] data, java.nio.ByteOrder order) Deserialize a raw byte value for this column into an Object
void	setAutoNumber(boolean autoNumber)
void	setColumnIndex(int newColumnIndex)
void	setColumnNumber(short newColumnNumber)
void	setCompressedUnicode(boolean newCompessedUnicode)
void	setFixedDataOffset(int newOffset)
void	setLength(short length)
void	setLengthInUnits(short unitLength)
void	setName(java.lang.String name)
void	setPrecision(byte newPrecision)
java.lang.Object	setRowValue(java.util.Map<java.lang.String,java.lang.Object> rowMap, java.lang.Object value)
java.lang.Object	setRowValue(java.lang.Object[] rowArray, java.lang.Object value)
void	setScale(byte newScale)
void	setSQLType(int type)
void	setSQLType(int type, int lengthInUnits)
void	setTextSortOrder(Column.SortOrder newTextSortOrder)
void	setType(DataType type) Also sets the length and the variable length flag, inferred from the type.
void	setVariableLength(boolean variableLength)
void	setVarLenTableIndex(int idx)
void	setVersionHistoryColumn(Column versionHistoryCol)
static boolean	toBooleanValue(java.lang.Object obj) Interpret a boolean value (null == false)
static byte[]	toByteArray(java.lang.Object value)
static java.lang.CharSequence	toCharSequence(java.lang.Object value)
java.lang.String	toString()
void	validate(JetFormat format) Checks that this column definition is valid.
java.nio.ByteBuffer	write(java.lang.Object obj, int remainingRowLength) Serialize an Object into a raw byte value for this column in little endian order
java.nio.ByteBuffer	write(java.lang.Object obj, int remainingRowLength, java.nio.ByteOrder order) Serialize an Object into a raw byte value for this column
protected static void	writeDefinitions(com.healthmarketscience.jackcess.TableCreator creator, java.nio.ByteBuffer buffer) Writes the column definitions into a table definition buffer.
java.nio.ByteBuffer	writeFixedLengthField(java.lang.Object obj, java.nio.ByteOrder order) Serialize an Object into a raw byte value for this column
java.nio.ByteBuffer	writeLongValue(byte[] value, int remainingRowLength) Write an LVAL column into a ByteBuffer inline if it fits, otherwise in other data page(s).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTO_NUMBER

public static final java.lang.Object AUTO_NUMBER

Meaningless placeholder object for inserting values in an autonumber column. it is not required that this value be used (any passed in value is ignored), but using this placeholder may make code more obvious.

KEEP_VALUE

public static final java.lang.Object KEEP_VALUE

Meaningless placeholder object for updating rows which indicates that a given column should keep its existing value.

FIXED_LEN_FLAG_MASK

public static final byte FIXED_LEN_FLAG_MASK

mask for the fixed len bit

See Also:

Constant Field Values

AUTO_NUMBER_FLAG_MASK

public static final byte AUTO_NUMBER_FLAG_MASK

mask for the auto number bit

See Also:

Constant Field Values

AUTO_NUMBER_GUID_FLAG_MASK

public static final byte AUTO_NUMBER_GUID_FLAG_MASK

mask for the auto number guid bit

See Also:

Constant Field Values

UNKNOWN_FLAG_MASK

public static final byte UNKNOWN_FLAG_MASK

mask for the unknown bit (possible "can be null"?)

See Also:

Constant Field Values

GENERAL_LEGACY_SORT_ORDER

public static final Column.SortOrder GENERAL_LEGACY_SORT_ORDER

the "general" text sort order, legacy version (access 2000-2007)

GENERAL_SORT_ORDER

public static final Column.SortOrder GENERAL_SORT_ORDER

the "general" text sort order, latest version (access 2010+)

Constructor Detail

Column

public Column()

Column

public Column(JetFormat format)

Column

public Column(Table table,
              java.nio.ByteBuffer buffer,
              int offset,
              int displayIndex)
       throws java.io.IOException

Read a column definition in from a buffer

Parameters:

table - owning table

buffer - Buffer containing column definition

offset - Offset in the buffer at which the column definition starts

Throws:

java.io.IOException

Method Detail

getTable

public Table getTable()

getDatabase

public Database getDatabase()

getFormat

public JetFormat getFormat()

getPageChannel

public PageChannel getPageChannel()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isVariableLength

public boolean isVariableLength()

setVariableLength

public void setVariableLength(boolean variableLength)

isAutoNumber

public boolean isAutoNumber()

setAutoNumber

public void setAutoNumber(boolean autoNumber)

getColumnNumber

public short getColumnNumber()

setColumnNumber

public void setColumnNumber(short newColumnNumber)

getColumnIndex

public int getColumnIndex()

setColumnIndex

public void setColumnIndex(int newColumnIndex)

getDisplayIndex

public int getDisplayIndex()

setType

public void setType(DataType type)

Also sets the length and the variable length flag, inferred from the type. For types with scale/precision, sets the scale and precision to default values.

getType

public DataType getType()

getSQLType

public int getSQLType()
               throws java.sql.SQLException

Throws:

java.sql.SQLException

setSQLType

public void setSQLType(int type)
                throws java.sql.SQLException

Throws:

java.sql.SQLException

setSQLType

public void setSQLType(int type,
                       int lengthInUnits)
                throws java.sql.SQLException

Throws:

java.sql.SQLException

isCompressedUnicode

public boolean isCompressedUnicode()

setCompressedUnicode

public void setCompressedUnicode(boolean newCompessedUnicode)

getPrecision

public byte getPrecision()

setPrecision

public void setPrecision(byte newPrecision)

getScale

public byte getScale()

setScale

public void setScale(byte newScale)

getTextSortOrder

public Column.SortOrder getTextSortOrder()

setTextSortOrder

public void setTextSortOrder(Column.SortOrder newTextSortOrder)

getTextCodePage

public short getTextCodePage()

setLength

public void setLength(short length)

getLength

public short getLength()

setLengthInUnits

public void setLengthInUnits(short unitLength)

getLengthInUnits

public short getLengthInUnits()

setVarLenTableIndex

public void setVarLenTableIndex(int idx)

getVarLenTableIndex

public int getVarLenTableIndex()

setFixedDataOffset

public void setFixedDataOffset(int newOffset)

getFixedDataOffset

public int getFixedDataOffset()

getCharset

protected java.nio.charset.Charset getCharset()

getTimeZone

protected java.util.TimeZone getTimeZone()

isAppendOnly

public boolean isAppendOnly()

Whether or not this column is "append only" (its history is tracked by a separate version history column).

getVersionHistoryColumn

public Column getVersionHistoryColumn()

Returns the column which tracks the version history for an "append only" column.

setVersionHistoryColumn

public void setVersionHistoryColumn(Column versionHistoryCol)

getComplexInfo

public ComplexColumnInfo<? extends ComplexValue> getComplexInfo()

Returns extended functionality for "complex" columns.

getAutoNumberGenerator

public Column.AutoNumberGenerator getAutoNumberGenerator()

Returns the AutoNumberGenerator for this column if this is an autonumber column, null otherwise.

getProperties

public PropertyMap getProperties()
                          throws java.io.IOException

Returns:

the properties for this column

Throws:

java.io.IOException

validate

public void validate(JetFormat format)

Checks that this column definition is valid.

Throws:

java.lang.IllegalArgumentException - if this column definition is invalid.

setRowValue

public java.lang.Object setRowValue(java.lang.Object[] rowArray,
                                    java.lang.Object value)

setRowValue

public java.lang.Object setRowValue(java.util.Map<java.lang.String,java.lang.Object> rowMap,
                                    java.lang.Object value)

getRowValue

public java.lang.Object getRowValue(java.lang.Object[] rowArray)

getRowValue

public java.lang.Object getRowValue(java.util.Map<java.lang.String,?> rowMap)

read

public java.lang.Object read(byte[] data)
                      throws java.io.IOException

Deserialize a raw byte value for this column into an Object

Parameters:

data - The raw byte value

Returns:

The deserialized Object

Throws:

java.io.IOException

read

public java.lang.Object read(byte[] data,
                             java.nio.ByteOrder order)
                      throws java.io.IOException

Deserialize a raw byte value for this column into an Object

Parameters:

data - The raw byte value

order - Byte order in which the raw value is stored

Returns:

The deserialized Object

Throws:

java.io.IOException

writeLongValue

public java.nio.ByteBuffer writeLongValue(byte[] value,
                                          int remainingRowLength)
                                   throws java.io.IOException

Write an LVAL column into a ByteBuffer inline if it fits, otherwise in other data page(s).

Parameters:

value - Value of the LVAL column

Returns:

A buffer containing the LVAL definition and (possibly) the column value (unless written to other pages)

Throws:

java.io.IOException

write

public java.nio.ByteBuffer write(java.lang.Object obj,
                                 int remainingRowLength)
                          throws java.io.IOException

Serialize an Object into a raw byte value for this column in little endian order

Parameters:

obj - Object to serialize

Returns:

A buffer containing the bytes

Throws:

java.io.IOException

write

public java.nio.ByteBuffer write(java.lang.Object obj,
                                 int remainingRowLength,
                                 java.nio.ByteOrder order)
                          throws java.io.IOException

Serialize an Object into a raw byte value for this column

Parameters:

obj - Object to serialize

order - Order in which to serialize

Returns:

A buffer containing the bytes

Throws:

java.io.IOException

writeFixedLengthField

public java.nio.ByteBuffer writeFixedLengthField(java.lang.Object obj,
                                                 java.nio.ByteOrder order)
                                          throws java.io.IOException

Serialize an Object into a raw byte value for this column

Parameters:

obj - Object to serialize

order - Order in which to serialize

Returns:

A buffer containing the bytes

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

decodeUncompressedText

public static java.lang.String decodeUncompressedText(byte[] textBytes,
                                                      java.nio.charset.Charset charset)

Parameters:

textBytes - bytes of text to decode

charset - relevant charset

Returns:

the decoded string

encodeUncompressedText

public static java.nio.ByteBuffer encodeUncompressedText(java.lang.CharSequence text,
                                                         java.nio.charset.Charset charset)

Parameters:

text - Text to encode

charset - database charset

Returns:

A buffer with the text encoded

compareTo

public int compareTo(Column other)

Orders Columns by column number.

Specified by:

compareTo in interface java.lang.Comparable<Column>

countVariableLength

public static short countVariableLength(java.util.List<Column> columns)

Parameters:

columns - A list of columns in a table definition

Returns:

The number of variable length columns found in the list

countNonLongVariableLength

public static short countNonLongVariableLength(java.util.List<Column> columns)

Parameters:

columns - A list of columns in a table definition

Returns:

The number of variable length columns which are not long values found in the list

toCharSequence

public static java.lang.CharSequence toCharSequence(java.lang.Object value)
                                             throws java.io.IOException

Returns:

an appropriate CharSequence representation of the given object.

Throws:

java.io.IOException

toByteArray

public static byte[] toByteArray(java.lang.Object value)
                          throws java.io.IOException

Returns:

an appropriate byte[] representation of the given object.

Throws:

java.io.IOException

toBooleanValue

public static boolean toBooleanValue(java.lang.Object obj)

Interpret a boolean value (null == false)

booleanToInteger

protected static java.lang.Object booleanToInteger(java.lang.Object obj)

Treat booleans as integers (C-style).

writeDefinitions

protected static void writeDefinitions(com.healthmarketscience.jackcess.TableCreator creator,
                                       java.nio.ByteBuffer buffer)
                                throws java.io.IOException

Writes the column definitions into a table definition buffer.

Parameters:

buffer - Buffer to write to

columns - List of Columns to write definitions for

Throws:

java.io.IOException