com.agimatec.sql.meta

Class TableDescription

java.lang.Object

com.agimatec.sql.meta.TableDescription

All Implemented Interfaces:

Serializable, Cloneable

public class TableDescription
extends Object
implements Serializable, Cloneable

Description:
Copyright: Copyright (c) 2007

Author:

Roman Stumm

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableDescription()

Method Summary

Modifier and Type	Method and Description
void	addColumn(ColumnDescription aColumn)
void	addConstraint(IndexDescription aIndex)
void	addForeignKey(ForeignKeyDescription aFK)
void	addIndex(IndexDescription aIndex)
TableDescription	deepCopy() deep copy
IndexDescription	findConstraintForColumns(List<String> columns)
ForeignKeyDescription	findForeignKeyLike(ForeignKeyDescription other) find a foreignKey in this table that has the same constraintName or columns/refColumns/refTable than 'other'
IndexDescription	findIndexForColumns(List<String> columns)
List<IndexDescription>	findIndicesForColumns(List<String> columns)
String	getCatalogName()
ColumnDescription	getColumn(int i)
ColumnDescription	getColumn(String columnName)
String[]	getColumnNames() column names of this table in alphabetic order
List<ColumnDescription>	getColumns() list of ColumnDescription
int	getColumnSize()
String	getComment()
IndexDescription	getConstraint(int i)
IndexDescription	getConstraint(String indexName)
List<IndexDescription>	getConstraints()
int	getConstraintSize()
ForeignKeyDescription	getForeignKey(int i)
ForeignKeyDescription	getForeignKey(String constraintName)
List<ForeignKeyDescription>	getForeignKeys()
int	getForeignKeySize()
IndexDescription	getIndex(int i)
IndexDescription	getIndex(String indexName)
int	getIndexSize()
List<IndexDescription>	getIndices()
IndexDescription	getPrimaryKey()
String	getQualifiedTableName()
String	getSchemaName()
String	getTableName()
boolean	isForeignKeyColumn(String columnName)
boolean	isPrimaryKeyColumn(String columnName)
boolean	isUnique(List<String> columns)
boolean	isUnique(String column)
void	removeColumn(String columnName)
void	removeConstraint(String indexName)
void	removeIndex(String indexName)
void	setCatalogName(String catalogName)
void	setComment(String aComment)
void	setPrimaryKey(IndexDescription aPrimaryKey)
void	setSchemaName(String schemaName)
void	setTableName(String aTableName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TableDescription

public TableDescription()

Method Detail

deepCopy

public TableDescription deepCopy()

deep copy

Returns:

getQualifiedTableName

public String getQualifiedTableName()

getTableName

public String getTableName()

setTableName

public void setTableName(String aTableName)

getComment

public String getComment()

setComment

public void setComment(String aComment)

isForeignKeyColumn

public boolean isForeignKeyColumn(String columnName)

isPrimaryKeyColumn

public boolean isPrimaryKeyColumn(String columnName)

isUnique

public boolean isUnique(List<String> columns)

isUnique

public boolean isUnique(String column)

getPrimaryKey

public IndexDescription getPrimaryKey()

setPrimaryKey

public void setPrimaryKey(IndexDescription aPrimaryKey)

getIndex

public IndexDescription getIndex(String indexName)

removeIndex

public void removeIndex(String indexName)

getConstraint

public IndexDescription getConstraint(String indexName)

removeConstraint

public void removeConstraint(String indexName)

getForeignKeys

public List<ForeignKeyDescription> getForeignKeys()

getConstraints

public List<IndexDescription> getConstraints()

getIndices

public List<IndexDescription> getIndices()

getIndex

public IndexDescription getIndex(int i)

getIndexSize

public int getIndexSize()

getConstraintSize

public int getConstraintSize()

addIndex

public void addIndex(IndexDescription aIndex)

addConstraint

public void addConstraint(IndexDescription aIndex)

getConstraint

public IndexDescription getConstraint(int i)

getForeignKey

public ForeignKeyDescription getForeignKey(String constraintName)

findForeignKeyLike

public ForeignKeyDescription findForeignKeyLike(ForeignKeyDescription other)

find a foreignKey in this table that has the same constraintName or columns/refColumns/refTable than 'other'

Parameters:

other -

Returns:

the fk in this table or null if no similar fk found

getForeignKey

public ForeignKeyDescription getForeignKey(int i)

getForeignKeySize

public int getForeignKeySize()

addForeignKey

public void addForeignKey(ForeignKeyDescription aFK)

getColumnNames

public String[] getColumnNames()

column names of this table in alphabetic order

getColumns

public List<ColumnDescription> getColumns()

list of ColumnDescription

Returns:

getColumn

public ColumnDescription getColumn(int i)

getColumn

public ColumnDescription getColumn(String columnName)

Parameters:

columnName - - name to search for (ignore case)

Returns:

null or the columndescription

removeColumn

public void removeColumn(String columnName)

getColumnSize

public int getColumnSize()

addColumn

public void addColumn(ColumnDescription aColumn)

toString

public String toString()

Overrides:

toString in class Object

findIndexForColumns

public IndexDescription findIndexForColumns(List<String> columns)

findConstraintForColumns

public IndexDescription findConstraintForColumns(List<String> columns)

findIndicesForColumns

public List<IndexDescription> findIndicesForColumns(List<String> columns)

getSchemaName

public String getSchemaName()

getCatalogName

public String getCatalogName()

setCatalogName

public void setCatalogName(String catalogName)

setSchemaName

public void setSchemaName(String schemaName)