org.jboss.dna.common.jdbc.model.api
Interface TableColumn

All Superinterfaces:

Column, CoreMetaData, DatabaseNamedObject, Serializable

All Known Subinterfaces:

ForeignKeyColumn, IndexColumn, KeyColumn, PrimaryKeyColumn

All Known Implementing Classes:

ForeignKeyColumnBean, IndexColumnBean, KeyColumnBean, PrimaryKeyColumnBean, TableColumnBean

public interface TableColumn
extends Column

Provides all database table column specific metadata.

Author:

Sergiy Litsenko

Method Summary

ColumnPseudoType	getPseudoType() Return column's pseudo type
Reference	getReference() Returns column reference if datatype is REF
Boolean	isBestRowIdentifier() Is this column the part of Best Row Identifier in any scope?
Boolean	isForeignKeyColumn() Retrieves true if column is part of foreign key.
Boolean	isIndexColumn() Retrieves true if column is part of any index.
Boolean	isPrimaryKeyColumn() Retrieves true if column is part of primary key.
Boolean	isVersionColumn() Retrieves true if column is automatically updated when any value in a row is updated.
void	setBestRowIdentifier(Boolean bestRowIdentifier) Is this column the part of Best Row Identifier in any scope?
void	setForeignKeyColumn(Boolean foreignKeyColumn) Sets true if column is part of foreign key.
void	setIndexColumn(Boolean indexColumn) Sets true if column is part of any index.
void	setPrimaryKeyColumn(Boolean primaryKeyColumn) Sets true if column is part of primary key.
void	setPseudoType(ColumnPseudoType pseudoType) Sets column's pseudo type
void	setReference(Reference reference) Sets column reference if datatype is REF
void	setVersionColumn(Boolean versionColumn) Sets true if column is automatically updated when any value in a row is updated.

Methods inherited from interface org.jboss.dna.common.jdbc.model.api.Column

addPrivilege, deletePrivilege, findPriviledgeByName, getCharOctetLength, getDefaultValue, getNullabilityType, getOrdinalPosition, getOwner, getPrecision, getPrivileges, getRadix, getSize, getSqlType, getTypeName, setCharOctetLength, setDefaultValue, setNullabilityType, setOrdinalPosition, setOwner, setPrecision, setRadix, setSize, setSqlType, setTypeName

Methods inherited from interface org.jboss.dna.common.jdbc.model.api.DatabaseNamedObject

addExtraProperty, deleteExtraProperty, getExtraProperties, getExtraProperty, getName, getRemarks, setName, setRemarks

Method Detail

isBestRowIdentifier

Boolean isBestRowIdentifier()

Is this column the part of Best Row Identifier in any scope?

Returns:

true if this column is the part of Best Row Identifier in any scope, otherwise return false (even if unknown)

setBestRowIdentifier

void setBestRowIdentifier(Boolean bestRowIdentifier)

Is this column the part of Best Row Identifier in any scope?

Parameters:

bestRowIdentifier - true if this column is the part of Best Row Identifier in any scope, otherwise return false (even if unknown)

getPseudoType

ColumnPseudoType getPseudoType()

Return column's pseudo type

Returns:

column's pseudo type

setPseudoType

void setPseudoType(ColumnPseudoType pseudoType)

Sets column's pseudo type

Parameters:

pseudoType - the column's pseudo type

getReference

Reference getReference()

Returns column reference if datatype is REF

Returns:

column reference if datatype is REF

setReference

void setReference(Reference reference)

Sets column reference if datatype is REF

Parameters:

reference - the column reference if datatype is REF

isVersionColumn

Boolean isVersionColumn()

Retrieves true if column is automatically updated when any value in a row is updated. If it retrieves true then column can be cast to VersionColumn.

Returns:

true if column is automatically updated when any value in a row is updated, return false overwise.

setVersionColumn

void setVersionColumn(Boolean versionColumn)

Sets true if column is automatically updated when any value in a row is updated. If it retrieves true then column can be cast to VersionColumn.

Parameters:

versionColumn - true if column is automatically updated when any value in a row is updated, return false overwise.

isPrimaryKeyColumn

Boolean isPrimaryKeyColumn()

Retrieves true if column is part of primary key.

Returns:

true if column is part of primary key, return false overwise.

setPrimaryKeyColumn

void setPrimaryKeyColumn(Boolean primaryKeyColumn)

Sets true if column is part of primary key.

Parameters:

primaryKeyColumn - true if column is part of primary key, return false overwise.

isForeignKeyColumn

Boolean isForeignKeyColumn()

Retrieves true if column is part of foreign key.

Returns:

true if column is part of foreign key, return false overwise.

setForeignKeyColumn

void setForeignKeyColumn(Boolean foreignKeyColumn)

Sets true if column is part of foreign key.

Parameters:

foreignKeyColumn - true if column is part of foreign key, return false overwise.

isIndexColumn

Boolean isIndexColumn()

Retrieves true if column is part of any index.

Returns:

true if column is part of any index, return false overwise.

setIndexColumn

void setIndexColumn(Boolean indexColumn)

Sets true if column is part of any index.

Parameters:

indexColumn - true if column is part of any index, return false overwise.