ColumnImpl

java.lang.Object
- com.healthmarketscience.jackcess.impl.ColumnImpl

All Implemented Interfaces:

Column, java.lang.Comparable<ColumnImpl>

Direct Known Subclasses:

CalculatedColumnUtil.CalcBooleanColImpl, CalculatedColumnUtil.CalcColImpl, ComplexColumnImpl, LongValueColumnImpl, NumericColumnImpl, PropertyMaps.Handler.PropColumn, TextColumnImpl, UnsupportedColumnImpl
```
public class ColumnImpl
extends java.lang.Object
implements Column, java.lang.Comparable<ColumnImpl>
```
Access database column definition

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ColumnImpl.AutoNumberGenerator` Base class for the supported autonumber types.
`private class`	`ColumnImpl.ComplexTypeAutoNumberGenerator`
`private static class`	`ColumnImpl.DateExt` Date subclass which stashes the original date bits, in case we attempt to re-write the value (will not lose precision).
`private class`	`ColumnImpl.GuidAutoNumberGenerator`
`(package private) static class`	`ColumnImpl.InitArgs` Utility struct for passing params through ColumnImpl constructors.
`private class`	`ColumnImpl.LongAutoNumberGenerator`
`private static class`	`ColumnImpl.RawData` Wrapper for raw column data which can be re-written.
`static class`	`ColumnImpl.SortOrder` Information about the sort order (collation) for a textual column.
`private class`	`ColumnImpl.UnsupportedAutoNumberGenerator`

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`_autoNumber` Whether or not the column is an autonumber column
`private ColumnImpl.AutoNumberGenerator`	`_autoNumberGenerator` the auto number generator for this column (if autonumber column)
`private boolean`	`_calculated` Whether or not the column is a calculated column
`private int`	`_columnIndex` index of the data for this column within a list of row data
`private short`	`_columnLength` Maximum column length
`private short`	`_columnNumber` 0-based column number
`private int`	`_displayIndex` display index of the data for this column
`private int`	`_fixedDataOffset` the offset of the fixed data in the row
`private java.lang.String`	`_name` Column name
`private PropertyMap`	`_props` properties for this column, if any
`private TableImpl`	`_table` owning table
`private DataType`	`_type` Data type
`private ColumnValidator`	`_validator` Validator for writing new values
`private boolean`	`_variableLength` Whether or not the column is of variable length
`private int`	`_varLenTableIndex` the index of the variable length data in the var len offset table
`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
`private static byte`	`CALCULATED_EXT_FLAG_MASK`
`protected static byte`	`COMPRESSED_UNICODE_EXT_FLAG_MASK`
`static byte`	`FIXED_LEN_FLAG_MASK` mask for the fixed len bit
`static ColumnImpl.SortOrder`	`GENERAL_LEGACY_SORT_ORDER` the "general" text sort order, legacy version (access 2000-2007)
`static ColumnImpl.SortOrder`	`GENERAL_SORT_ORDER` the "general" text sort order, latest version (access 2010+)
`private static short`	`GENERAL_SORT_ORDER_VALUE` the value for the "general" sort order
`private static java.util.regex.Pattern`	`GUID_PATTERN` pattern matching textual guid strings (allows for optional surrounding '{' and '}')
`static byte`	`HYPERLINK_FLAG_MASK` mask for the hyperlink bit (on memo types)
`(package private) static int`	`INVALID_AUTO_NUMBER` auto numbers must be > 0
`protected static org.apache.commons.logging.Log`	`LOG`
`private static char`	`MAX_COMPRESS_CHAR`
`(package private) static long`	`MILLIS_BETWEEN_EPOCH_AND_1900` Access starts counting dates at Dec 30, 1899 (note, this strange date seems to be caused by MS compatibility with Lotus-1-2-3 and incorrect leap years).
`private static long`	`MILLISECONDS_PER_DAY` Access stores numeric dates in days.
`private static char`	`MIN_COMPRESS_CHAR`
`(package private) static byte`	`NUMERIC_NEGATIVE_BYTE`
`static java.lang.Object`	`RETURN_ROW_ID` Placeholder object for adding rows which indicates that the caller wants the RowId of the new row.
`private static byte[]`	`TEXT_COMPRESSION_HEADER` header used to indicate unicode text compression
`static byte`	`UNKNOWN_FLAG_MASK` mask for the unknown bit (possible "can be null"?)

Fields inherited from interface com.healthmarketscience.jackcess.Column
AUTO_NUMBER, KEEP_VALUE

Constructor Summary

Constructors
Modifier	Constructor and Description
`(package private)`	`ColumnImpl(ColumnImpl.InitArgs args)` Read a column definition in from a buffer
`protected`	`ColumnImpl(TableImpl table, java.lang.String name, DataType type, int colNumber, int fixedOffset, int varLenIndex)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static java.lang.Object`	`booleanToInteger(java.lang.Object obj)` Treat booleans as integers (C-style).
`int`	`compareTo(ColumnImpl other)` Orders Columns by column number.
`private static short`	`countNonLongVariableLength(java.util.List<ColumnBuilder> columns)`
`static short`	`countVariableLength(java.util.List<ColumnBuilder> columns)`
`static ColumnImpl`	`create(TableImpl table, java.nio.ByteBuffer buffer, int offset, java.lang.String name, int displayIndex)` Creates the appropriate ColumnImpl class and reads a column definition in from a buffer
`private ColumnImpl.AutoNumberGenerator`	`createAutoNumberGenerator()`
`private void`	`decodeTextSegment(byte[] data, int dataStart, int dataEnd, boolean inCompressedMode, java.lang.StringBuilder textBuf)` Decodes a segnment of a text value into the given buffer according to the given status of the segment (compressed/uncompressed).
`(package private) java.lang.String`	`decodeTextValue(byte[] data)` Decodes a compressed or uncompressed text value.
`static java.lang.String`	`decodeUncompressedText(byte[] textBytes, java.nio.charset.Charset charset)`
`private static java.nio.CharBuffer`	`decodeUncompressedText(byte[] textBytes, int startPos, int length, java.nio.charset.Charset charset)`
`(package private) java.nio.ByteBuffer`	`encodeTextValue(java.lang.Object obj, int minChars, int maxChars, boolean forceUncompressed)` Encodes a text value, possibly compressing.
`static java.nio.ByteBuffer`	`encodeUncompressedText(java.lang.CharSequence text, java.nio.charset.Charset charset)`
`private static void`	`fixNumericByteOrder(byte[] bytes)` Swaps the bytes of the given numeric in place.
`long`	`fromDateDouble(double value)` Returns a java long time value converted from an access date double.
`(package private) static long`	`fromLocalDateDouble(double value)`
`ColumnImpl.AutoNumberGenerator`	`getAutoNumberGenerator()` Returns the AutoNumberGenerator for this column if this is an autonumber column, `null` otherwise.
`protected java.util.Calendar`	`getCalendar()`
`protected java.nio.charset.Charset`	`getCharset()`
`private static byte`	`getColumnBitFlags(ColumnBuilder col)` Constructs a byte containing the flags for this column.
`int`	`getColumnIndex()`
`short`	`getColumnNumber()`
`ColumnValidator`	`getColumnValidator()` Gets currently configured ColumnValidator (always non-`null`).
`ComplexColumnInfo<? extends ComplexValue>`	`getComplexInfo()` Returns extended functionality for "complex" columns.
`DatabaseImpl`	`getDatabase()`
`int`	`getDisplayIndex()`
`int`	`getFixedDataOffset()`
`JetFormat`	`getFormat()`
`private long`	`getFromLocalTimeZoneOffset(long time)` Gets the timezone offset from local time to UTC for the given time (including DST).
`short`	`getLength()`
`short`	`getLengthInUnits()`
`java.lang.String`	`getName()`
`(package private) byte`	`getOriginalDataType()`
`int`	`getOwnedPageCount()` Returns the number of database pages owned by this column.
`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()`
`TableImpl`	`getTable()`
`short`	`getTextCodePage()`
`ColumnImpl.SortOrder`	`getTextSortOrder()`
`private long`	`getToLocalTimeZoneOffset(long time)` Gets the timezone offset from UTC to local time for the given time (including DST).
`DataType`	`getType()`
`int`	`getVarLenTableIndex()`
`ColumnImpl`	`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`	`isCalculated()` Returns whether or not this is a calculated column.
`boolean`	`isCompressedUnicode()`
`(package private) static boolean`	`isGUIDValue(java.lang.Object value)` Returns `true` if the given value is a "guid" value.
`boolean`	`isHyperlink()` Returns whether or not this is a hyperlink column (only possible for columns of type MEMO).
`(package private) static boolean`	`isImmutableValue(java.lang.Object value)` Returns `true` if the value is immutable, `false` otherwise.
`static boolean`	`isRawData(java.lang.Object value)` Returns `true` if the given value is "raw" column data, `false` otherwise.
`private static boolean`	`isUnicodeCompressible(java.lang.CharSequence text)` Returns `true` if the given text can be compressed using compressed unicode, `false` otherwise.
`boolean`	`isVariableLength()`
`(package private) void`	`postTableLoadInit()` Secondary column initialization after the table is fully loaded.
`static ColumnImpl.RawData`	`rawDataWrapper(byte[] bytes)` Returns a wrapper for raw column data that can be written without understanding the data.
`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
`(package private) static short`	`readCodePage(java.nio.ByteBuffer buffer, int offset, JetFormat format)` Reads the column cade page info from the given buffer, if supported for this db.
`private java.math.BigDecimal`	`readCurrencyValue(java.nio.ByteBuffer buffer)` Decodes "Currency" values.
`private java.util.Date`	`readDateValue(java.nio.ByteBuffer buffer)` Decodes a date value.
`(package private) static byte`	`readExtraFlags(java.nio.ByteBuffer buffer, int offset, JetFormat format)` Read the extra flags field for a column definition.
`java.lang.Object`	`readFromNullMask(boolean isNull)`
`private static java.lang.String`	`readGUIDValue(java.nio.ByteBuffer buffer, java.nio.ByteOrder order)` Decodes a GUID value.
`private java.math.BigDecimal`	`readNumericValue(java.nio.ByteBuffer buffer)` Decodes a NUMERIC field.
`(package private) static ColumnImpl.SortOrder`	`readSortOrder(java.nio.ByteBuffer buffer, int position, JetFormat format)` Reads the sort order info from the given buffer from the given position.
`void`	`setColumnIndex(int newColumnIndex)`
`void`	`setColumnValidator(ColumnValidator newValidator)` Sets a new ColumnValidator.
`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)`
`(package private) void`	`setUsageMaps(UsageMap ownedPages, UsageMap freeSpacePages)` Sets the usage maps for this column.
`void`	`setVersionHistoryColumn(ColumnImpl versionHistoryCol)`
`boolean`	`storeInNullMask()`
`(package private) static java.math.BigDecimal`	`toBigDecimal(byte[] bytes, boolean negate, int scale)`
`(package private) static java.math.BigDecimal`	`toBigDecimal(java.lang.Object value)`
`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)`
`double`	`toDateDouble(java.lang.Object value)` Returns an access date double converted from a java Date/Calendar/Number time value.
`private static long`	`toDateLong(java.lang.Object value)`
`static java.lang.Object`	`toInternalValue(DataType dataType, java.lang.Object value)` Converts the given value to the "internal" representation for the given data type.
`(package private) static double`	`toLocalDateDouble(long time)`
`private static java.lang.Number`	`toNumber(java.lang.Object value)`
`java.lang.String`	`toString()`
`(package private) byte[]`	`toUnscaledByteArray(java.math.BigDecimal decVal, int maxByteLen)`
`java.lang.Object`	`validate(java.lang.Object obj)` Passes the given obj through the currently configured validator for this column and returns the result.
`(package private) java.lang.String`	`withErrorContext(java.lang.String msg)`
`private static java.lang.String`	`withErrorContext(java.lang.String msg, DatabaseImpl db, java.lang.String tableName, java.lang.String colName)`
`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
`private void`	`writeCurrencyValue(java.nio.ByteBuffer buffer, java.lang.Object value)` Writes "Currency" values.
`private void`	`writeDateValue(java.nio.ByteBuffer buffer, java.lang.Object value)` Writes a date value.
`protected static void`	`writeDefinitions(TableCreator creator, java.nio.ByteBuffer buffer)` Writes the column definitions into a table definition buffer.
`protected java.nio.ByteBuffer`	`writeFixedLengthField(java.lang.Object obj, java.nio.ByteBuffer buffer)`
`protected java.nio.ByteBuffer`	`writeFixedLengthField(java.lang.Object obj, java.nio.ByteOrder order)` Serialize an Object into a raw byte value for this column
`private void`	`writeGUIDValue(java.nio.ByteBuffer buffer, java.lang.Object value)` Writes a GUID value.
`private void`	`writeNumericValue(java.nio.ByteBuffer buffer, java.lang.Object value)` Writes a numeric value.
`protected java.nio.ByteBuffer`	`writeRealData(java.lang.Object obj, int remainingRowLength, java.nio.ByteOrder order)`
`private static void`	`writeSortOrder(java.nio.ByteBuffer buffer, ColumnImpl.SortOrder sortOrder, JetFormat format)` Writes the sort order info to the given buffer at the current position.
`boolean`	`writeToNullMask(java.lang.Object value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- LOG
```
protected static final org.apache.commons.logging.Log LOG
```
- RETURN_ROW_ID
```
public static final java.lang.Object RETURN_ROW_ID
```
  Placeholder object for adding rows which indicates that the caller wants the RowId of the new row. Must be added as an extra value at the end of the row values array.
  
  See Also:
  
  TableImpl.asRowWithRowId(java.util.Map<java.lang.String, ?>)
- MILLISECONDS_PER_DAY
```
private static final long MILLISECONDS_PER_DAY
```
  Access stores numeric dates in days. Java stores them in milliseconds.
  
  See Also:
  
  Constant Field Values
- MILLIS_BETWEEN_EPOCH_AND_1900
```
static final long MILLIS_BETWEEN_EPOCH_AND_1900
```
  Access starts counting dates at Dec 30, 1899 (note, this strange date seems to be caused by MS compatibility with Lotus-1-2-3 and incorrect leap years). Java starts counting at Jan 1, 1970. This is the # of millis between them for conversion.
  
  See Also:
  
  Constant Field Values
- 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
- HYPERLINK_FLAG_MASK
```
public static final byte HYPERLINK_FLAG_MASK
```
  mask for the hyperlink bit (on memo types)
  
  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
- COMPRESSED_UNICODE_EXT_FLAG_MASK
```
protected static final byte COMPRESSED_UNICODE_EXT_FLAG_MASK
```
  See Also:
  
  Constant Field Values
- CALCULATED_EXT_FLAG_MASK
```
private static final byte CALCULATED_EXT_FLAG_MASK
```
  See Also:
  
  Constant Field Values
- NUMERIC_NEGATIVE_BYTE
```
static final byte NUMERIC_NEGATIVE_BYTE
```
  See Also:
  
  Constant Field Values
- GENERAL_SORT_ORDER_VALUE
```
private static final short GENERAL_SORT_ORDER_VALUE
```
  the value for the "general" sort order
  
  See Also:
  
  Constant Field Values
- GENERAL_LEGACY_SORT_ORDER
```
public static final ColumnImpl.SortOrder GENERAL_LEGACY_SORT_ORDER
```
  the "general" text sort order, legacy version (access 2000-2007)
- GENERAL_SORT_ORDER
```
public static final ColumnImpl.SortOrder GENERAL_SORT_ORDER
```
  the "general" text sort order, latest version (access 2010+)
- GUID_PATTERN
```
private static final java.util.regex.Pattern GUID_PATTERN
```
  pattern matching textual guid strings (allows for optional surrounding '{' and '}')
- TEXT_COMPRESSION_HEADER
```
private static final byte[] TEXT_COMPRESSION_HEADER
```
  header used to indicate unicode text compression
- MIN_COMPRESS_CHAR
```
private static final char MIN_COMPRESS_CHAR
```
  See Also:
  
  Constant Field Values
- MAX_COMPRESS_CHAR
```
private static final char MAX_COMPRESS_CHAR
```
  See Also:
  
  Constant Field Values
- INVALID_AUTO_NUMBER
```
static final int INVALID_AUTO_NUMBER
```
  auto numbers must be > 0
  
  See Also:
  
  Constant Field Values
- _table
```
private final TableImpl _table
```
  owning table
- _variableLength
```
private final boolean _variableLength
```
  Whether or not the column is of variable length
- _autoNumber
```
private final boolean _autoNumber
```
  Whether or not the column is an autonumber column
- _calculated
```
private final boolean _calculated
```
  Whether or not the column is a calculated column
- _type
```
private final DataType _type
```
  Data type
- _columnLength
```
private final short _columnLength
```
  Maximum column length
- _columnNumber
```
private final short _columnNumber
```
  0-based column number
- _columnIndex
```
private int _columnIndex
```
  index of the data for this column within a list of row data
- _displayIndex
```
private final int _displayIndex
```
  display index of the data for this column
- _name
```
private final java.lang.String _name
```
  Column name
- _fixedDataOffset
```
private final int _fixedDataOffset
```
  the offset of the fixed data in the row
- _varLenTableIndex
```
private final int _varLenTableIndex
```
  the index of the variable length data in the var len offset table
- _autoNumberGenerator
```
private final ColumnImpl.AutoNumberGenerator _autoNumberGenerator
```
  the auto number generator for this column (if autonumber column)
- _props
```
private PropertyMap _props
```
  properties for this column, if any
- _validator
```
private ColumnValidator _validator
```
  Validator for writing new values

Constructor Detail

ColumnImpl

protected ColumnImpl(TableImpl table,
                     java.lang.String name,
                     DataType type,
                     int colNumber,
                     int fixedOffset,
                     int varLenIndex)

ColumnImpl
```
ColumnImpl(ColumnImpl.InitArgs args)
    throws java.io.IOException
```
Read a column definition in from a buffer

Throws:

java.io.IOException

Method Detail

create

public static ColumnImpl create(TableImpl table,
                                java.nio.ByteBuffer buffer,
                                int offset,
                                java.lang.String name,
                                int displayIndex)
                         throws java.io.IOException

Creates the appropriate ColumnImpl class and reads 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

setUsageMaps

void setUsageMaps(UsageMap ownedPages,
                  UsageMap freeSpacePages)

Sets the usage maps for this column.

postTableLoadInit
```
void postTableLoadInit()
                throws java.io.IOException
```
Secondary column initialization after the table is fully loaded.

Throws:

java.io.IOException

getTable
```
public TableImpl getTable()
```
Specified by:

getTable in interface Column

getDatabase
```
public DatabaseImpl getDatabase()
```
Specified by:

getDatabase in interface Column

getFormat
```
public JetFormat getFormat()
```

getPageChannel
```
public PageChannel getPageChannel()
```

getName
```
public java.lang.String getName()
```
Specified by:

getName in interface Column

isVariableLength
```
public boolean isVariableLength()
```
Specified by:

isVariableLength in interface Column

isAutoNumber
```
public boolean isAutoNumber()
```
Specified by:

isAutoNumber in interface Column

getColumnNumber
```
public short getColumnNumber()
```

getColumnIndex
```
public int getColumnIndex()
```
Specified by:

getColumnIndex in interface Column

setColumnIndex

public void setColumnIndex(int newColumnIndex)

getDisplayIndex
```
public int getDisplayIndex()
```

getType
```
public DataType getType()
```
Specified by:

getType in interface Column

getSQLType
```
public int getSQLType()
               throws java.sql.SQLException
```
Specified by:

getSQLType in interface Column

Throws:

java.sql.SQLException

isCompressedUnicode
```
public boolean isCompressedUnicode()
```
Specified by:

isCompressedUnicode in interface Column

getPrecision
```
public byte getPrecision()
```
Specified by:

getPrecision in interface Column

getScale
```
public byte getScale()
```
Specified by:

getScale in interface Column

getTextSortOrder

public ColumnImpl.SortOrder getTextSortOrder()

getTextCodePage
```
public short getTextCodePage()
```

getLength
```
public short getLength()
```
Specified by:

getLength in interface Column

getLengthInUnits
```
public short getLengthInUnits()
```
Specified by:

getLengthInUnits in interface Column

isCalculated
```
public boolean isCalculated()
```
Description copied from interface: Column

Returns whether or not this is a calculated column. Note that jackess won't interpret the calculation expression (but the field can be written directly).

Specified by:

isCalculated in interface Column

getVarLenTableIndex
```
public int getVarLenTableIndex()
```

getFixedDataOffset
```
public int getFixedDataOffset()
```

getCharset

protected java.nio.charset.Charset getCharset()

getCalendar

protected java.util.Calendar getCalendar()

isAppendOnly
```
public boolean isAppendOnly()
```
Description copied from interface: Column

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

Specified by:

isAppendOnly in interface Column

getVersionHistoryColumn
```
public ColumnImpl getVersionHistoryColumn()
```
Description copied from interface: Column

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

Specified by:

getVersionHistoryColumn in interface Column

getOwnedPageCount
```
public int getOwnedPageCount()
```
Returns the number of database pages owned by this column.

setVersionHistoryColumn

public void setVersionHistoryColumn(ColumnImpl versionHistoryCol)

isHyperlink
```
public boolean isHyperlink()
```
Description copied from interface: Column

Returns whether or not this is a hyperlink column (only possible for columns of type MEMO).

Specified by:

isHyperlink in interface Column

getComplexInfo
```
public ComplexColumnInfo<? extends ComplexValue> getComplexInfo()
```
Description copied from interface: Column

Returns extended functionality for "complex" columns.

Specified by:

getComplexInfo in interface Column

getColumnValidator
```
public ColumnValidator getColumnValidator()
```
Description copied from interface: Column

Gets currently configured ColumnValidator (always non-null).

Specified by:

getColumnValidator in interface Column

setColumnValidator
```
public void setColumnValidator(ColumnValidator newValidator)
```
Description copied from interface: Column

Sets a new ColumnValidator. If null, resets to the value returned from the Database's ColumnValidatorFactory (if the factory returns null, then the default is used). Autonumber columns cannot have a validator instance other than the default.

Specified by:

setColumnValidator in interface Column

getOriginalDataType
```
byte getOriginalDataType()
```

createAutoNumberGenerator

private ColumnImpl.AutoNumberGenerator createAutoNumberGenerator()

getAutoNumberGenerator
```
public ColumnImpl.AutoNumberGenerator getAutoNumberGenerator()
```
Returns the AutoNumberGenerator for this column if this is an autonumber column, null otherwise.

getProperties
```
public PropertyMap getProperties()
                          throws java.io.IOException
```
Specified by:

getProperties in interface Column

Returns:

the properties for this column

Throws:

java.io.IOException

setRowValue

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

Specified by:: setRowValue in interface Column

setRowValue

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

Specified by:: setRowValue in interface Column

getRowValue

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

Specified by:: getRowValue in interface Column

getRowValue

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

Specified by:: getRowValue in interface Column

storeInNullMask
```
public boolean storeInNullMask()
```

writeToNullMask

public boolean writeToNullMask(java.lang.Object value)

readFromNullMask

public java.lang.Object readFromNullMask(boolean isNull)

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

readCurrencyValue
```
private java.math.BigDecimal readCurrencyValue(java.nio.ByteBuffer buffer)
                                        throws java.io.IOException
```
Decodes "Currency" values.

Parameters:

buffer - Column value that points to currency data

Returns:

BigDecimal representing the monetary value

Throws:

java.io.IOException - if the value cannot be parsed

writeCurrencyValue

private void writeCurrencyValue(java.nio.ByteBuffer buffer,
                                java.lang.Object value)
                         throws java.io.IOException

Writes "Currency" values.

Throws:: java.io.IOException

readNumericValue

private java.math.BigDecimal readNumericValue(java.nio.ByteBuffer buffer)

Decodes a NUMERIC field.

toBigDecimal

static java.math.BigDecimal toBigDecimal(byte[] bytes,
                                         boolean negate,
                                         int scale)

writeNumericValue

private void writeNumericValue(java.nio.ByteBuffer buffer,
                               java.lang.Object value)
                        throws java.io.IOException

Writes a numeric value.

Throws:: java.io.IOException

toUnscaledByteArray

byte[] toUnscaledByteArray(java.math.BigDecimal decVal,
                           int maxByteLen)
                    throws java.io.IOException

Throws:: java.io.IOException

readDateValue

private java.util.Date readDateValue(java.nio.ByteBuffer buffer)

Decodes a date value.

fromDateDouble
```
public long fromDateDouble(double value)
```
Returns a java long time value converted from an access date double.

fromLocalDateDouble

static long fromLocalDateDouble(double value)

writeDateValue

private void writeDateValue(java.nio.ByteBuffer buffer,
                            java.lang.Object value)

Writes a date value.

toDateDouble
```
public double toDateDouble(java.lang.Object value)
```
Returns an access date double converted from a java Date/Calendar/Number time value.

toLocalDateDouble

static double toLocalDateDouble(long time)

toDateLong
```
private static long toDateLong(java.lang.Object value)
```
Returns:

an appropriate Date long value for the given object

getToLocalTimeZoneOffset
```
private long getToLocalTimeZoneOffset(long time)
```
Gets the timezone offset from UTC to local time for the given time (including DST).

getFromLocalTimeZoneOffset
```
private long getFromLocalTimeZoneOffset(long time)
```
Gets the timezone offset from local time to UTC for the given time (including DST).

readGUIDValue

private static java.lang.String readGUIDValue(java.nio.ByteBuffer buffer,
                                              java.nio.ByteOrder order)

Decodes a GUID value.

writeGUIDValue

private void writeGUIDValue(java.nio.ByteBuffer buffer,
                            java.lang.Object value)
                     throws java.io.IOException

Writes a GUID value.

Throws:: java.io.IOException

isGUIDValue

static boolean isGUIDValue(java.lang.Object value)
                    throws java.io.IOException

Returns true if the given value is a "guid" value.

Throws:: java.io.IOException

validate
```
public java.lang.Object validate(java.lang.Object obj)
                          throws java.io.IOException
```
Passes the given obj through the currently configured validator for this column and returns the result.

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

writeRealData

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

Throws:: java.io.IOException

writeFixedLengthField

protected 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

writeFixedLengthField

protected java.nio.ByteBuffer writeFixedLengthField(java.lang.Object obj,
                                                    java.nio.ByteBuffer buffer)
                                             throws java.io.IOException

Throws:: java.io.IOException

decodeTextValue

java.lang.String decodeTextValue(byte[] data)
                          throws java.io.IOException

Decodes a compressed or uncompressed text value.

Throws:: java.io.IOException

decodeTextSegment

private void decodeTextSegment(byte[] data,
                               int dataStart,
                               int dataEnd,
                               boolean inCompressedMode,
                               java.lang.StringBuilder textBuf)

Decodes a segnment of a text value into the given buffer according to the given status of the segment (compressed/uncompressed).

decodeUncompressedText

private static java.nio.CharBuffer decodeUncompressedText(byte[] textBytes,
                                                          int startPos,
                                                          int length,
                                                          java.nio.charset.Charset charset)

Parameters:: textBytes - bytes of text to decode
Returns:: the decoded string

encodeTextValue

java.nio.ByteBuffer encodeTextValue(java.lang.Object obj,
                                    int minChars,
                                    int maxChars,
                                    boolean forceUncompressed)
                             throws java.io.IOException

Encodes a text value, possibly compressing.

Throws:: java.io.IOException

isUnicodeCompressible
```
private static boolean isUnicodeCompressible(java.lang.CharSequence text)
```
Returns true if the given text can be compressed using compressed unicode, false otherwise.

getColumnBitFlags
```
private static byte getColumnBitFlags(ColumnBuilder col)
```
Constructs a byte containing the flags for this column.

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(ColumnImpl other)
```
Orders Columns by column number.

Specified by:

compareTo in interface java.lang.Comparable<ColumnImpl>

countVariableLength
```
public static short countVariableLength(java.util.List<ColumnBuilder> columns)
```
Parameters:

columns - A list of columns in a table definition

Returns:

The number of variable length columns found in the list

countNonLongVariableLength
```
private static short countNonLongVariableLength(java.util.List<ColumnBuilder> 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

toBigDecimal
```
static java.math.BigDecimal toBigDecimal(java.lang.Object value)
```
Returns:

an appropriate BigDecimal representation of the given object. null is returned as 0 and Numbers are converted using their double representation.

toNumber
```
private static java.lang.Number toNumber(java.lang.Object value)
```
Returns:

an appropriate Number representation of the given object. null is returned as 0 and Strings are parsed as Doubles.

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)

fixNumericByteOrder
```
private static void fixNumericByteOrder(byte[] bytes)
```
Swaps the bytes of the given numeric in place.

booleanToInteger

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

Treat booleans as integers (C-style).

rawDataWrapper
```
public static ColumnImpl.RawData rawDataWrapper(byte[] bytes)
```
Returns a wrapper for raw column data that can be written without understanding the data. Useful for wrapping unparseable data for re-writing.

isRawData
```
public static boolean isRawData(java.lang.Object value)
```
Returns true if the given value is "raw" column data, false otherwise.

writeDefinitions

protected static void writeDefinitions(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
Throws:: java.io.IOException

readSortOrder

static ColumnImpl.SortOrder readSortOrder(java.nio.ByteBuffer buffer,
                                          int position,
                                          JetFormat format)

Reads the sort order info from the given buffer from the given position.

readCodePage

static short readCodePage(java.nio.ByteBuffer buffer,
                          int offset,
                          JetFormat format)

Reads the column cade page info from the given buffer, if supported for this db.

readExtraFlags

static byte readExtraFlags(java.nio.ByteBuffer buffer,
                           int offset,
                           JetFormat format)

Read the extra flags field for a column definition.

writeSortOrder

private static void writeSortOrder(java.nio.ByteBuffer buffer,
                                   ColumnImpl.SortOrder sortOrder,
                                   JetFormat format)

Writes the sort order info to the given buffer at the current position.

isImmutableValue
```
static boolean isImmutableValue(java.lang.Object value)
```
Returns true if the value is immutable, false otherwise. This only handles values that are returned from the read(byte[]) method.

toInternalValue

public static java.lang.Object toInternalValue(DataType dataType,
                                               java.lang.Object value)
                                        throws java.io.IOException

Converts the given value to the "internal" representation for the given data type.

Throws:: java.io.IOException

withErrorContext

java.lang.String withErrorContext(java.lang.String msg)

withErrorContext

private static java.lang.String withErrorContext(java.lang.String msg,
                                                 DatabaseImpl db,
                                                 java.lang.String tableName,
                                                 java.lang.String colName)

Class ColumnImpl

Nested Class Summary

Field Summary

Fields inherited from interface com.healthmarketscience.jackcess.Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

RETURN_ROW_ID

MILLISECONDS_PER_DAY

MILLIS_BETWEEN_EPOCH_AND_1900

FIXED_LEN_FLAG_MASK

AUTO_NUMBER_FLAG_MASK

AUTO_NUMBER_GUID_FLAG_MASK

HYPERLINK_FLAG_MASK

UNKNOWN_FLAG_MASK

COMPRESSED_UNICODE_EXT_FLAG_MASK

CALCULATED_EXT_FLAG_MASK

NUMERIC_NEGATIVE_BYTE

GENERAL_SORT_ORDER_VALUE

GENERAL_LEGACY_SORT_ORDER

GENERAL_SORT_ORDER

GUID_PATTERN

TEXT_COMPRESSION_HEADER

MIN_COMPRESS_CHAR

MAX_COMPRESS_CHAR

INVALID_AUTO_NUMBER

_table

_variableLength

_autoNumber

_calculated

_type

_columnLength

_columnNumber

_columnIndex

_displayIndex

_name

_fixedDataOffset

_varLenTableIndex

_autoNumberGenerator

_props

_validator

Constructor Detail

ColumnImpl

ColumnImpl

Method Detail

create

setUsageMaps

postTableLoadInit

getTable

getDatabase

getFormat

getPageChannel

getName

isVariableLength

isAutoNumber

getColumnNumber

getColumnIndex

setColumnIndex

getDisplayIndex

getType

getSQLType

isCompressedUnicode

getPrecision

getScale

getTextSortOrder

getTextCodePage

getLength

getLengthInUnits

isCalculated

getVarLenTableIndex

getFixedDataOffset

getCharset

getCalendar

isAppendOnly

getVersionHistoryColumn

getOwnedPageCount

setVersionHistoryColumn

isHyperlink