com.healthmarketscience.jackcess
Interface Column

All Known Implementing Classes:

ColumnImpl

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

Author:

James Ahlborn

Usage:

General: This class is general use.

Field Summary

static Object	AUTO_NUMBER Meaningless placeholder object for inserting values in an autonumber column.
static Object	KEEP_VALUE Meaningless placeholder object for updating rows which indicates that a given column should keep its existing value.

Method Summary

int	getColumnIndex()
ComplexColumnInfo<? extends ComplexValue>	getComplexInfo() Returns extended functionality for "complex" columns.
Database	getDatabase()
short	getLength()
short	getLengthInUnits()
String	getName()
byte	getPrecision()
PropertyMap	getProperties()
Object	getRowValue(Map<String,?> rowMap)
Object	getRowValue(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	isCompressedUnicode()
boolean	isHyperlink() Returns whether or not this is a hyperlink column (only possible for columns of type MEMO).
boolean	isVariableLength()
Object	setRowValue(Map<String,Object> rowMap, Object value)
Object	setRowValue(Object[] rowArray, Object value)

Field Detail

AUTO_NUMBER

static final 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.

Usage:

General: This field is general use.

KEEP_VALUE

static final Object KEEP_VALUE

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

Usage:

General: This field is general use.

Method Detail

getTable

Table getTable()

Usage:

General: This method is general use.

getDatabase

Database getDatabase()

Usage:

General: This method is general use.

getName

String getName()

Usage:

General: This method is general use.

isVariableLength

boolean isVariableLength()

Usage:

Advanced: This method is for advanced/internal use.

isAutoNumber

boolean isAutoNumber()

Usage:

General: This method is general use.

getColumnIndex

int getColumnIndex()

Usage:

Advanced: This method is for advanced/internal use.

getType

DataType getType()

Usage:

General: This method is general use.

getSQLType

int getSQLType()
               throws SQLException

Throws:

SQLException

Usage:

General: This method is general use.

isCompressedUnicode

boolean isCompressedUnicode()

Usage:

General: This method is general use.

getPrecision

byte getPrecision()

Usage:

General: This method is general use.

getScale

byte getScale()

Usage:

General: This method is general use.

getLength

short getLength()

Usage:

General: This method is general use.

getLengthInUnits

short getLengthInUnits()

Usage:

General: This method is general use.

isAppendOnly

boolean isAppendOnly()

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

Usage:

General: This method is general use.

isHyperlink

boolean isHyperlink()

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

Usage:

General: This method is general use.

getComplexInfo

ComplexColumnInfo<? extends ComplexValue> getComplexInfo()

Returns extended functionality for "complex" columns.

Usage:

General: This method is general use.

getProperties

PropertyMap getProperties()
                          throws IOException

Returns:

the properties for this column

Throws:

IOException

Usage:

General: This method is general use.

getVersionHistoryColumn

Column getVersionHistoryColumn()

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

Usage:

Intermediate: This method requires moderate API knowledge.

setRowValue

Object setRowValue(Object[] rowArray,
                   Object value)

setRowValue

Object setRowValue(Map<String,Object> rowMap,
                   Object value)

getRowValue

Object getRowValue(Object[] rowArray)

getRowValue

Object getRowValue(Map<String,?> rowMap)