net.java.ao.schema.helper
Interface DatabaseMetaDataReader

All Known Implementing Classes:

DatabaseMetaDataReaderImpl

public interface DatabaseMetaDataReader

Method Summary

java.lang.Iterable<? extends Field>	getFields(java.sql.DatabaseMetaData databaseMetaData, java.lang.String tableName)
java.lang.Iterable<? extends ForeignKey>	getForeignKeys(java.sql.DatabaseMetaData databaseMetaData, java.lang.String tableName) Gets the list of foreign keys for a given table
java.lang.Iterable<? extends Index>	getIndexes(java.sql.DatabaseMetaData databaseMetaData, java.lang.String tableName) Gets the list of indexes for a given table
java.lang.Iterable<java.lang.String>	getTableNames(java.sql.DatabaseMetaData databaseMetaData) Gets the names of the existing tables in the DB

Method Detail

getTableNames

java.lang.Iterable<java.lang.String> getTableNames(java.sql.DatabaseMetaData databaseMetaData)

Gets the names of the existing tables in the DB

Parameters:

databaseMetaData - the meta data from which to extract the table names

Returns:

an Iterable of table names as strings

getFields

java.lang.Iterable<? extends Field> getFields(java.sql.DatabaseMetaData databaseMetaData,
                                              java.lang.String tableName)

Parameters:

databaseMetaData -

tableName -

Returns:

getForeignKeys

java.lang.Iterable<? extends ForeignKey> getForeignKeys(java.sql.DatabaseMetaData databaseMetaData,
                                                        java.lang.String tableName)

Gets the list of foreign keys for a given table

Parameters:

databaseMetaData - the database metadata to read the information from

tableName - the name of the table from which to read the foreign keys

Returns:

an Iterable of foreign keys

getIndexes

java.lang.Iterable<? extends Index> getIndexes(java.sql.DatabaseMetaData databaseMetaData,
                                               java.lang.String tableName)

Gets the list of indexes for a given table

Parameters:

databaseMetaData - the database metadata to read the information from

tableName - the name of the table from which to read the indexes

Returns:

an Iterable of indexes