org.apache.ws.jaxme.sqls

Interface Column

Known Subinterfaces:
BinaryColumn, DB2Column, HsqlDbColumn, StringColumn
Known Implementing Classes:
AbstractColumn, ColumnImpl, DB2ColumnImpl, HsqlDbColumnImpl, VirtualColumn

public interface Column

Author:
Jochen Wiedmann

Nested Class Summary

static interface
Column.Name
static interface
Column.Type

Method Summary

Object
getCustomData()
Allows the user to retrieve application specific data, which has previously been attached to the column.
Column.Name
getName()
Returns the columns name.
String
getQName()
Returns the columns fully qualified name, which is getTable().getQName() + "." + getName().
Table
getTable()
Returns the columns table.
Column.Type
getType()
Returns the columns type.
boolean
isBinaryColumn()
Returns whether this Column may be casted to a BinaryColumn.
boolean
isNullable()
Returns whether the column is nullable.
boolean
isPrimaryKeyPart()
Returns whether this column is part of the primary key.
boolean
isStringColumn()
Returns whether this Column may be casted to a StringColumn.
boolean
isVirtual()
Returns whether this column is a true column or a virtual column.
void
setCustomData(Object pData)
Allows the user to attach application specific data to the column.
void
setNullable(boolean pNullable)
Sets whether the column is nullable.

Method Details

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

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

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.