org.jboss.dna.common.jdbc.model.spi
Class TableColumnBean

java.lang.Object
  org.jboss.dna.common.jdbc.model.spi.CoreMetaDataBean
      org.jboss.dna.common.jdbc.model.spi.DatabaseNamedObjectBean
          org.jboss.dna.common.jdbc.model.spi.ColumnBean
              org.jboss.dna.common.jdbc.model.spi.TableColumnBean

All Implemented Interfaces:

Serializable, Column, CoreMetaData, DatabaseNamedObject, TableColumn

Direct Known Subclasses:

KeyColumnBean

public class TableColumnBean
extends ColumnBean
implements TableColumn

Provides all database table column specific metadata.

Author:

Sergiy Litsenko

See Also:

Serialized Form

Constructor Summary

TableColumnBean()
Default constructor

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 class org.jboss.dna.common.jdbc.model.spi.ColumnBean

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 class org.jboss.dna.common.jdbc.model.spi.DatabaseNamedObjectBean

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

TableColumnBean

public TableColumnBean()

Default constructor

Method Detail

isBestRowIdentifier

public Boolean isBestRowIdentifier()

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

Specified by:

isBestRowIdentifier in interface TableColumn

Returns:

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

setBestRowIdentifier

public void setBestRowIdentifier(Boolean bestRowIdentifier)

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

Specified by:

setBestRowIdentifier in interface TableColumn

Parameters:

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

getPseudoType

public ColumnPseudoType getPseudoType()

Return column's pseudo type

Specified by:

getPseudoType in interface TableColumn

Returns:

column's pseudo type

setPseudoType

public void setPseudoType(ColumnPseudoType pseudoType)

Sets column's pseudo type

Specified by:

setPseudoType in interface TableColumn

Parameters:

pseudoType - the column's pseudo type

getReference

public Reference getReference()

Returns column reference if datatype is REF

Specified by:

getReference in interface TableColumn

Returns:

column reference if datatype is REF

setReference

public void setReference(Reference reference)

Sets column reference if datatype is REF

Specified by:

setReference in interface TableColumn

Parameters:

reference - the column reference if datatype is REF

isVersionColumn

public 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.

Specified by:

isVersionColumn in interface TableColumn

Returns:

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

setVersionColumn

public 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.

Specified by:

setVersionColumn in interface TableColumn

Parameters:

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

isPrimaryKeyColumn

public Boolean isPrimaryKeyColumn()

Retrieves true if column is part of primary key.

Specified by:

isPrimaryKeyColumn in interface TableColumn

Returns:

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

setPrimaryKeyColumn

public void setPrimaryKeyColumn(Boolean primaryKeyColumn)

Sets true if column is part of primary key.

Specified by:

setPrimaryKeyColumn in interface TableColumn

Parameters:

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

isForeignKeyColumn

public Boolean isForeignKeyColumn()

Retrieves true if column is part of foreign key.

Specified by:

isForeignKeyColumn in interface TableColumn

Returns:

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

setForeignKeyColumn

public void setForeignKeyColumn(Boolean foreignKeyColumn)

Sets true if column is part of foreign key.

Specified by:

setForeignKeyColumn in interface TableColumn

Parameters:

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

isIndexColumn

public Boolean isIndexColumn()

Retrieves true if column is part of any index.

Specified by:

isIndexColumn in interface TableColumn

Returns:

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

setIndexColumn

public void setIndexColumn(Boolean indexColumn)

Sets true if column is part of any index.

Specified by:

setIndexColumn in interface TableColumn

Parameters:

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