org.apache.ws.jaxme.sqls
Interface Column

All Known Subinterfaces:

BinaryColumn, DB2Column, HsqlDbColumn, StringColumn

All 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

java.lang.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.
java.lang.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(java.lang.Object pData) Allows the user to attach application specific data to the column.
void	setNullable(boolean pNullable) Sets whether the column is nullable.

Method Detail

getTable

Table getTable()

Returns the columns table.

getName

Column.Name getName()

Returns the columns name.

getQName

java.lang.String getQName()

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

getType

Column.Type getType()

Returns the columns type.

isPrimaryKeyPart

boolean isPrimaryKeyPart()

Returns whether this column is part of the primary key.

setNullable

void setNullable(boolean pNullable)

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

isNullable

boolean isNullable()

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

isStringColumn

boolean isStringColumn()

Returns whether this Column may be casted to a StringColumn.

isBinaryColumn

boolean isBinaryColumn()

Returns whether this Column may be casted to a BinaryColumn.

setCustomData

void setCustomData(java.lang.Object pData)

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

getCustomData

java.lang.Object getCustomData()

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

isVirtual

boolean isVirtual()

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