com.whitestein.lsps.common.ddl

Class TableMetadata

java.lang.Object

com.whitestein.lsps.common.ddl.TableMetadata

public class TableMetadata
extends java.lang.Object

JDBC table metadata

Author:

Christoph Sturm, Max Rydahl Andersen

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_TABLE String representation of type TABLE
static java.lang.String	TYPE_VIEW String representation of type VIEW

Constructor Summary

Constructors

Constructor and Description
TableMetadata(java.sql.ResultSet rs, java.sql.DatabaseMetaData meta)
TableMetadata(java.sql.ResultSet rs, java.sql.DatabaseMetaData meta, boolean loadAllMetadata) Creates new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalog() Returns the catalog name.
ColumnMetadata	getColumnMetadata(java.lang.String columnName) Returns the column metadata for the given column name.
java.util.List<ColumnMetadata>	getColumns() Returns a collection of table columns.
java.util.Collection<ForeignKeyMetadata>	getForeignKeyMetadata() Returns a collection of all foreign key metadata.
ForeignKeyMetadata	getForeignKeyMetadata(java.lang.String keyName) Returns the foreign key metadata for the given key name.
java.util.Collection<IndexMetadata>	getIndexMetadata() Returns metadata of indexes.
IndexMetadata	getIndexMetadata(java.lang.String indexName) Returns the index metadata for the given index name.
java.lang.String	getName() Returns the table name.
PrimaryKeyMetadata	getPrimaryKeyMetadata() Returns the primary key metadata.
java.lang.String	getSchema() Returns the schema name.
static java.lang.String[]	getTypes() Types which should be considered when reading the db schema (TABLE, VIEW)
void	initForeignKeys(java.sql.DatabaseMetaData meta)
void	initIndexes(java.sql.DatabaseMetaData meta) loads all indexes definitions for this table from database
void	initPrimaryKeys(java.sql.DatabaseMetaData meta) loads primary key definition for this table from database
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TABLE

public static final java.lang.String TYPE_TABLE

String representation of type TABLE

See Also:

Constant Field Values

TYPE_VIEW

public static final java.lang.String TYPE_VIEW

String representation of type VIEW

See Also:

Constant Field Values

Constructor Detail

TableMetadata

public TableMetadata(java.sql.ResultSet rs,
                     java.sql.DatabaseMetaData meta)
              throws java.sql.SQLException

Parameters:

rs -

meta -

Throws:

java.sql.SQLException

TableMetadata

public TableMetadata(java.sql.ResultSet rs,
                     java.sql.DatabaseMetaData meta,
                     boolean loadAllMetadata)
              throws java.sql.SQLException

Creates new instance.

Parameters:

rs -

meta -

loadAllMetadata - if true, also primary key, foreign keys and indexes information will be loaded automatically

Throws:

java.sql.SQLException

Method Detail

getTypes

public static java.lang.String[] getTypes()

Types which should be considered when reading the db schema (TABLE, VIEW)

Returns:

the array of types (TABLE, VIEW)

getName

public java.lang.String getName()

Returns the table name.

Returns:

the table name

getCatalog

public java.lang.String getCatalog()

Returns the catalog name.

Returns:

the catalog name

getSchema

public java.lang.String getSchema()

Returns the schema name.

Returns:

the schema name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getColumns

public java.util.List<ColumnMetadata> getColumns()

Returns a collection of table columns.

Returns:

the collection of columns

getColumnMetadata

public ColumnMetadata getColumnMetadata(java.lang.String columnName)

Returns the column metadata for the given column name.

Parameters:

columnName -

Returns:

the column metadata for the given column name

getForeignKeyMetadata

public ForeignKeyMetadata getForeignKeyMetadata(java.lang.String keyName)

Returns the foreign key metadata for the given key name.

Parameters:

keyName -

Returns:

the foreign key metadata for the given key name

getForeignKeyMetadata

public java.util.Collection<ForeignKeyMetadata> getForeignKeyMetadata()

Returns a collection of all foreign key metadata.

Returns:

a collection of all foreign key metadata

getPrimaryKeyMetadata

public PrimaryKeyMetadata getPrimaryKeyMetadata()

Returns the primary key metadata.

Returns:

the primary key metadata

getIndexMetadata

public java.util.Collection<IndexMetadata> getIndexMetadata()

Returns metadata of indexes.

Returns:

metadata of indexes

getIndexMetadata

public IndexMetadata getIndexMetadata(java.lang.String indexName)

Returns the index metadata for the given index name.

Parameters:

indexName -

Returns:

the index metadata for the given index name

initForeignKeys

public void initForeignKeys(java.sql.DatabaseMetaData meta)
                     throws java.sql.SQLException

Parameters:

meta -

Throws:

java.sql.SQLException

initPrimaryKeys

public void initPrimaryKeys(java.sql.DatabaseMetaData meta)
                     throws java.sql.SQLException

loads primary key definition for this table from database

Parameters:

meta -

Throws:

java.sql.SQLException

initIndexes

public void initIndexes(java.sql.DatabaseMetaData meta)
                 throws java.sql.SQLException

loads all indexes definitions for this table from database

Parameters:

meta -

Throws:

java.sql.SQLException