net.java.ao.schema.helper
Interface DatabaseMetaDataReader

All Known Implementing Classes:

DatabaseMetaDataReaderImpl

public interface DatabaseMetaDataReader

Method Summary

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

Method Detail

getTableNames

Iterable<String> getTableNames(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

Iterable<? extends Field> getFields(DatabaseMetaData databaseMetaData,
                                    String tableName)

Parameters:

databaseMetaData -

tableName -

Returns:

getForeignKeys

Iterable<? extends ForeignKey> getForeignKeys(DatabaseMetaData databaseMetaData,
                                              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

Iterable<? extends Index> getIndexes(DatabaseMetaData databaseMetaData,
                                     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