com.link_intersystems.jdbc

Class ConnectionMetaData

java.lang.Object

com.link_intersystems.jdbc.ConnectionMetaData

All Implemented Interfaces:

TableReferenceMetaData

public class ConnectionMetaData
extends Object
implements TableReferenceMetaData

ConnectionMetaData provides convenient api to access the meta-data of a jdbc connection.

 Connection jdbcConnection = ...;
 ConnectionMetaData metaData = new ConnectionMetaData(jdbcConnection);

 ForeignKeyList foreignKeys = metaData.getImportedKeys("film_actor");

 ColumnMetaDataList filmActorColumns = metaData.getColumnMetaDataList("film_actor");
 ForeignKey foreignKey = foreignKeys.getByFkColumnDescription(filmActorColumns.getByName("actor_id"));
 assertNotNull(foreignKey);
 assertEquals("fk_film_actor_actor", foreignKey.getName());

 ColumnMetaDataList actorColumns = metaData.getColumnMetaDataList("actor");
 foreignKey = foreignKeys.getByPkColumnDescription(actorColumns.getByName("actor_id"));
 assertNotNull(foreignKey);
 assertEquals("fk_film_actor_actor", foreignKey.getName());
 

Author:

René Link <rene.link@link-intersystems.com>

Constructor Summary

Constructors

Constructor and Description
ConnectionMetaData(Connection connection)
ConnectionMetaData(Connection connection, JdbcContext context)
ConnectionMetaData(Connection connection, JdbcContext context, String... tableTypes)
ConnectionMetaData(Connection connection, String... tableTypes)

Method Summary

Modifier and Type	Method and Description
protected PrimaryKey	createPrimaryKey(ColumnMetaDataList columnMetaDataList, List<PrimaryKeyColumn> primaryKeyColumns)
ColumnMetaDataList	getColumnMetaDataList(String tableName)
List<ColumnMetaData>	getColumnMetaDataList(TableMetaData jdbcTableMetaData)
ForeignKeyList	getExportedKeys(String tableName)
ForeignKeyList	getImportedKeys(String tableName)
TableReferenceList	getIncomingReferences(String tableName)
TableReferenceList	getOutgoingReferences(String tableName)
PrimaryKey	getPrimaryKey(String tableName)
protected ScopedDatabaseMetaData	getScopedDatabaseMetaData()
TableMetaData	getTableMetaData(String tableName) Convenience method for getTableMetaDataList().getByName(tableName).
TableMetaDataList	getTableMetaDataList()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionMetaData

public ConnectionMetaData(Connection connection)

ConnectionMetaData

public ConnectionMetaData(Connection connection,
                          String... tableTypes)

ConnectionMetaData

public ConnectionMetaData(Connection connection,
                          JdbcContext context)

ConnectionMetaData

public ConnectionMetaData(Connection connection,
                          JdbcContext context,
                          String... tableTypes)

Method Detail

getTableMetaData

public TableMetaData getTableMetaData(String tableName)
                               throws SQLException

Convenience method for getTableMetaDataList().getByName(tableName).

Parameters:

tableName -

Returns:

Throws:

SQLException

getTableMetaDataList

public TableMetaDataList getTableMetaDataList()
                                       throws SQLException

Throws:

SQLException

getScopedDatabaseMetaData

protected ScopedDatabaseMetaData getScopedDatabaseMetaData()
                                                    throws SQLException

Throws:

SQLException

getPrimaryKey

public PrimaryKey getPrimaryKey(String tableName)
                         throws SQLException

Throws:

SQLException

createPrimaryKey

protected PrimaryKey createPrimaryKey(ColumnMetaDataList columnMetaDataList,
                                      List<PrimaryKeyColumn> primaryKeyColumns)

getColumnMetaDataList

public List<ColumnMetaData> getColumnMetaDataList(TableMetaData jdbcTableMetaData)
                                           throws SQLException

Throws:

SQLException

getColumnMetaDataList

public ColumnMetaDataList getColumnMetaDataList(String tableName)
                                         throws SQLException

Throws:

SQLException

getExportedKeys

public ForeignKeyList getExportedKeys(String tableName)
                               throws SQLException

Throws:

SQLException

getImportedKeys

public ForeignKeyList getImportedKeys(String tableName)
                               throws SQLException

Throws:

SQLException

getOutgoingReferences

public TableReferenceList getOutgoingReferences(String tableName)
                                         throws SQLException

Specified by:

getOutgoingReferences in interface TableReferenceMetaData

Throws:

SQLException

getIncomingReferences

public TableReferenceList getIncomingReferences(String tableName)
                                         throws SQLException

Specified by:

getIncomingReferences in interface TableReferenceMetaData

Throws:

SQLException