org.apache.ws.jaxme.sqls

Interface Column

public interface Column

Author: Jochen Wiedmann

Nested Class Summary
static interfaceColumn.Name
static interfaceColumn.Type
Method Summary
ObjectgetCustomData()

Allows the user to retrieve application specific data, which has previously been attached to the column.

Column.NamegetName()

Returns the columns name.

StringgetQName()

Returns the columns fully qualified name, which is getTable().getQName() + "." + getName().

TablegetTable()

Returns the columns table.

Column.TypegetType()

Returns the columns type.

booleanisBinaryColumn()

Returns whether this Column may be casted to a BinaryColumn.

booleanisNullable()

Returns whether the column is nullable.

booleanisPrimaryKeyPart()

Returns whether this column is part of the primary key.

booleanisStringColumn()

Returns whether this Column may be casted to a StringColumn.

booleanisVirtual()

Returns whether this column is a true column or a virtual column.

voidsetCustomData(Object pData)

Allows the user to attach application specific data to the column.

voidsetNullable(boolean pNullable)

Sets whether the column is nullable.

Method Detail

getCustomData

public Object getCustomData()

Allows the user to retrieve application specific data, which has previously been attached to the column.

getName

public Column.Name getName()

Returns the columns name.

getQName

public String getQName()

Returns the columns fully qualified name, which is getTable().getQName() + "." + getName().

getTable

public Table getTable()

Returns the columns table.

getType

public Column.Type getType()

Returns the columns type.

isBinaryColumn

public boolean isBinaryColumn()

Returns whether this Column may be casted to a BinaryColumn.

isNullable

public boolean isNullable()

Returns whether the column is nullable. By default columns are not nullable.

isPrimaryKeyPart

public boolean isPrimaryKeyPart()

Returns whether this column is part of the primary key.

isStringColumn

public boolean isStringColumn()

Returns whether this Column may be casted to a StringColumn.

isVirtual

public boolean isVirtual()

Returns whether this column is a true column or a virtual column.

setCustomData

public void setCustomData(Object pData)

Allows the user to attach application specific data to the column.

setNullable

public void setNullable(boolean pNullable)

Sets whether the column is nullable. By default columns are not nullable.