com.healthmarketscience.jackcess

Interface Column

All Known Implementing Classes:

CalculatedColumnUtil.CalcBooleanColImpl, CalculatedColumnUtil.CalcColImpl, CalculatedColumnUtil.CalcMemoColImpl, CalculatedColumnUtil.CalcNumericColImpl, CalculatedColumnUtil.CalcTextColImpl, ColumnImpl, ComplexColumnImpl, LongValueColumnImpl, MemoColumnImpl, NumericColumnImpl, PropertyMaps.Handler.BooleanPropColumn, PropertyMaps.Handler.PropColumn, TextColumnImpl, UnsupportedColumnImpl

public interface Column

Access database column definition. A Table has a list of Column instances describing the table schema.

A Column instance is not thread-safe (see Database for more thread-safety details).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Object	AUTO_NUMBER Meaningless placeholder object for inserting values in an autonumber column.
static java.lang.Object	KEEP_VALUE Meaningless placeholder object for updating rows which indicates that a given column should keep its existing value.

Method Summary

Modifier and Type	Method and Description
int	getColumnIndex()
ColumnValidator	getColumnValidator() Gets currently configured ColumnValidator (always non-null).
ComplexColumnInfo<? extends ComplexValue>	getComplexInfo() Returns extended functionality for "complex" columns.
Database	getDatabase()
short	getLength()
short	getLengthInUnits()
java.lang.String	getName()
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()
DataType	getType()
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	isCalculated() Returns whether or not this is a calculated column.
boolean	isCompressedUnicode()
boolean	isHyperlink() Returns whether or not this is a hyperlink column (only possible for columns of type MEMO).
boolean	isVariableLength()
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)

Field Detail

AUTO_NUMBER

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

static final java.lang.Object KEEP_VALUE

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

Method Detail

getTable

Table getTable()

getDatabase

Database getDatabase()

getName

java.lang.String getName()

isVariableLength

boolean isVariableLength()

isAutoNumber

boolean isAutoNumber()

getColumnIndex

int getColumnIndex()

getType

DataType getType()

getSQLType

int getSQLType()
        throws java.sql.SQLException

Throws:

java.sql.SQLException

isCompressedUnicode

boolean isCompressedUnicode()

getPrecision

byte getPrecision()

getScale

byte getScale()

getLength

short getLength()

getLengthInUnits

short getLengthInUnits()

isAppendOnly

boolean isAppendOnly()

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

isHyperlink

boolean isHyperlink()

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

isCalculated

boolean isCalculated()

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).

getComplexInfo

ComplexColumnInfo<? extends ComplexValue> getComplexInfo()

Returns extended functionality for "complex" columns.

getProperties

PropertyMap getProperties()
                   throws java.io.IOException

Returns:

the properties for this column

Throws:

java.io.IOException

getVersionHistoryColumn

Column getVersionHistoryColumn()

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

getColumnValidator

ColumnValidator getColumnValidator()

Gets currently configured ColumnValidator (always non-null).

setColumnValidator

void setColumnValidator(ColumnValidator newValidator)

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.

Throws:

java.lang.IllegalArgumentException - if an attempt is made to set a non-null ColumnValidator instance on an autonumber column

setRowValue

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

setRowValue

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

getRowValue

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

getRowValue

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