com.healthmarketscience.jackcess

Class ColumnBuilder

java.lang.Object

com.healthmarketscience.jackcess.ColumnBuilder

public class ColumnBuilder
extends java.lang.Object

Builder style class for constructing a Column. See TableBuilder for example usage.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_autoNumber whether or not the column is auto-number
private boolean	_calculated whether or not the column is calculated
private short	_columnNumber 0-based column number
private boolean	_compressedUnicode whether or not the column allows compressed unicode
private boolean	_hyperlink whether or not the column is a hyperlink (memo only)
private java.lang.Short	_length optional length for the new column
private java.lang.String	_name name of the new column
private java.lang.Byte	_precision optional precision for the new column
private java.util.Map<java.lang.String,PropertyMap.Property>	_props table properties (if any)
private java.lang.Byte	_scale optional scale for the new column
private ColumnImpl.SortOrder	_sortOrder the collating sort order for a text field
private DataType	_type the type of the new column

Constructor Summary

Constructors

Constructor and Description
ColumnBuilder(java.lang.String name)
ColumnBuilder(java.lang.String name, DataType type)

Method Summary

Modifier and Type	Method and Description
ColumnBuilder	escapeName() Escapes the new column's name using TableBuilder.escapeIdentifier(java.lang.String).
short	getColumnNumber()
short	getLength()
java.lang.String	getName()
byte	getPrecision()
java.util.Map<java.lang.String,PropertyMap.Property>	getProperties()
private PropertyMap.Property	getProperty(java.lang.String name)
byte	getScale()
ColumnImpl.SortOrder	getTextSortOrder()
DataType	getType()
boolean	isAutoNumber()
boolean	isCalculated()
boolean	isCompressedUnicode()
boolean	isHyperlink()
boolean	isVariableLength()
ColumnBuilder	putProperty(java.lang.String name, DataType type, java.lang.Object value) Sets the column property with the given name and type to the given value.
ColumnBuilder	putProperty(java.lang.String name, java.lang.Object value) Sets the column property with the given name to the given value.
ColumnBuilder	setAutoNumber(boolean autoNumber) Sets whether of not the new column is an auto-number column.
ColumnBuilder	setCalculated(boolean calculated) Sets whether of not the new column is a calculated column.
ColumnBuilder	setCalculatedInfo(java.lang.String expression) Convenience method to set the various info for a calculated type (flag, result type property and expression)
void	setColumnNumber(short newColumnNumber)
ColumnBuilder	setCompressedUnicode(boolean compressedUnicode) Sets whether of not the new column allows unicode compression.
ColumnBuilder	setFromColumn(Column template) Sets all attributes except name from the given Column template (including all column properties except GUID).
ColumnBuilder	setFromColumn(ColumnBuilder template) Sets all attributes except name from the given Column template.
ColumnBuilder	setHyperlink(boolean hyperlink) Sets whether of not the new column allows unicode compression.
ColumnBuilder	setLength(int length) Sets the length (in bytes) for the new column.
ColumnBuilder	setLengthInUnits(int unitLength) Sets the length (in type specific units) for the new column.
ColumnBuilder	setMaxLength() Sets the length for the new column to the max length for the type.
ColumnBuilder	setMaxPrecision() Sets the precision for the new column to the max length for the type.
ColumnBuilder	setMaxScale() Sets the scale for the new column to the max length for the type.
ColumnBuilder	setPrecision(int newPrecision) Sets the precision for the new column.
private void	setProperty(java.lang.String name, PropertyMap.Property prop)
ColumnBuilder	setScale(int newScale) Sets the scale for the new column.
ColumnBuilder	setSQLType(int type) Sets the type for the new column based on the given SQL type.
ColumnBuilder	setSQLType(int type, int lengthInUnits) Sets the type for the new column based on the given SQL type and target data length (in type specific units).
void	setTextSortOrder(ColumnImpl.SortOrder newTextSortOrder)
ColumnBuilder	setType(DataType type) Sets the type for the new column.
ColumnBuilder	toColumn() Creates a new Column with the currently configured attributes.
void	validate(JetFormat format) Checks that this column definition is valid.
private java.lang.String	withErrorContext(java.lang.String msg)

Methods inherited from class java.lang.Object

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

Field Detail

_name

private java.lang.String _name

name of the new column

_type

private DataType _type

the type of the new column

_length

private java.lang.Short _length

optional length for the new column

_precision

private java.lang.Byte _precision

optional precision for the new column

_scale

private java.lang.Byte _scale

optional scale for the new column

_autoNumber

private boolean _autoNumber

whether or not the column is auto-number

_compressedUnicode

private boolean _compressedUnicode

whether or not the column allows compressed unicode

_calculated

private boolean _calculated

whether or not the column is calculated

_hyperlink

private boolean _hyperlink

whether or not the column is a hyperlink (memo only)

_columnNumber

private short _columnNumber

0-based column number

_sortOrder

private ColumnImpl.SortOrder _sortOrder

the collating sort order for a text field

_props

private java.util.Map<java.lang.String,PropertyMap.Property> _props

table properties (if any)

Constructor Detail

ColumnBuilder

public ColumnBuilder(java.lang.String name)

ColumnBuilder

public ColumnBuilder(java.lang.String name,
                     DataType type)

Method Detail

getName

public java.lang.String getName()

setType

public ColumnBuilder setType(DataType type)

Sets the type for the new column.

getType

public DataType getType()

setSQLType

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

Sets the type for the new column based on the given SQL type.

Throws:

java.sql.SQLException

setSQLType

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

Sets the type for the new column based on the given SQL type and target data length (in type specific units).

Throws:

java.sql.SQLException

setPrecision

public ColumnBuilder setPrecision(int newPrecision)

Sets the precision for the new column.

getPrecision

public byte getPrecision()

setMaxPrecision

public ColumnBuilder setMaxPrecision()

Sets the precision for the new column to the max length for the type. Does nothing for types which do not have a precision.

setScale

public ColumnBuilder setScale(int newScale)

Sets the scale for the new column.

getScale

public byte getScale()

setMaxScale

public ColumnBuilder setMaxScale()

Sets the scale for the new column to the max length for the type. Does nothing for types which do not have a scale.

setLength

public ColumnBuilder setLength(int length)

Sets the length (in bytes) for the new column.

getLength

public short getLength()

setLengthInUnits

public ColumnBuilder setLengthInUnits(int unitLength)

Sets the length (in type specific units) for the new column.

setMaxLength

public ColumnBuilder setMaxLength()

Sets the length for the new column to the max length for the type. Does nothing for types which are not variable length.

setAutoNumber

public ColumnBuilder setAutoNumber(boolean autoNumber)

Sets whether of not the new column is an auto-number column.

isAutoNumber

public boolean isAutoNumber()

setCompressedUnicode

public ColumnBuilder setCompressedUnicode(boolean compressedUnicode)

Sets whether of not the new column allows unicode compression.

isCompressedUnicode

public boolean isCompressedUnicode()

setCalculated

public ColumnBuilder setCalculated(boolean calculated)

Sets whether of not the new column is a calculated column.

isCalculated

public boolean isCalculated()

setCalculatedInfo

public ColumnBuilder setCalculatedInfo(java.lang.String expression)

Convenience method to set the various info for a calculated type (flag, result type property and expression)

isVariableLength

public boolean isVariableLength()

setHyperlink

public ColumnBuilder setHyperlink(boolean hyperlink)

Sets whether of not the new column allows unicode compression.

isHyperlink

public boolean isHyperlink()

putProperty

public ColumnBuilder putProperty(java.lang.String name,
                                 java.lang.Object value)

Sets the column property with the given name to the given value. Attempts to determine the type of the property (see PropertyMap.put(String,Object) for details on determining the property type).

putProperty

public ColumnBuilder putProperty(java.lang.String name,
                                 DataType type,
                                 java.lang.Object value)

Sets the column property with the given name and type to the given value.

getProperties

public java.util.Map<java.lang.String,PropertyMap.Property> getProperties()

setProperty

private void setProperty(java.lang.String name,
                         PropertyMap.Property prop)

getProperty

private PropertyMap.Property getProperty(java.lang.String name)

setFromColumn

public ColumnBuilder setFromColumn(Column template)
                            throws java.io.IOException

Sets all attributes except name from the given Column template (including all column properties except GUID).

Throws:

java.io.IOException

setFromColumn

public ColumnBuilder setFromColumn(ColumnBuilder template)

Sets all attributes except name from the given Column template.

escapeName

public ColumnBuilder escapeName()

Escapes the new column's name using TableBuilder.escapeIdentifier(java.lang.String).

getColumnNumber

public short getColumnNumber()

setColumnNumber

public void setColumnNumber(short newColumnNumber)

getTextSortOrder

public ColumnImpl.SortOrder getTextSortOrder()

setTextSortOrder

public void setTextSortOrder(ColumnImpl.SortOrder newTextSortOrder)

validate

public void validate(JetFormat format)

Checks that this column definition is valid.

Throws:

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

toColumn

public ColumnBuilder toColumn()

Creates a new Column with the currently configured attributes.

withErrorContext

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