net.java.ao.schema.helper

Class DatabaseMetaDataReaderImpl

java.lang.Object

net.java.ao.schema.helper.DatabaseMetaDataReaderImpl

All Implemented Interfaces:

DatabaseMetaDataReader

public class DatabaseMetaDataReaderImpl
extends java.lang.Object
implements DatabaseMetaDataReader

Constructor Summary

Constructors

Constructor and Description
DatabaseMetaDataReaderImpl(DatabaseProvider databaseProvider, NameConverters nameConverters, SchemaConfiguration schemaConfiguration)

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<? extends Field>	getFields(java.sql.DatabaseMetaData databaseMetaData, java.lang.String tableName)
java.lang.Iterable<ForeignKey>	getForeignKeys(java.sql.DatabaseMetaData metaData, 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 simple indexes for a given table.
java.lang.Iterable<java.lang.String>	getTableNames(java.sql.DatabaseMetaData metaData) Gets the names of the existing tables in the DB
boolean	isTablePresent(java.sql.DatabaseMetaData databaseMetaData, java.lang.Class<? extends RawEntity<?>> type) Checks if the table corresponding to given type exists in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseMetaDataReaderImpl

public DatabaseMetaDataReaderImpl(DatabaseProvider databaseProvider,
                                  NameConverters nameConverters,
                                  SchemaConfiguration schemaConfiguration)

Method Detail

isTablePresent

public boolean isTablePresent(java.sql.DatabaseMetaData databaseMetaData,
                              java.lang.Class<? extends RawEntity<?>> type)

Description copied from interface: DatabaseMetaDataReader

Checks if the table corresponding to given type exists in the database.

Specified by:

isTablePresent in interface DatabaseMetaDataReader

Parameters:

databaseMetaData - of the database to be checked

type - to check against

Returns:

true if the table exists, false otherwise

getTableNames

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

Description copied from interface: DatabaseMetaDataReader

Gets the names of the existing tables in the DB

Specified by:

getTableNames in interface DatabaseMetaDataReader

Parameters:

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

Returns:

an Iterable of table names as strings

getFields

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

Specified by:

getFields in interface DatabaseMetaDataReader

Returns:

getIndexes

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

Description copied from interface: DatabaseMetaDataReader

Gets the list of simple indexes for a given table. AO only supports single column indexes, and as such composite indexes will not be returned by this method even if they exist in the table. Prior to AO v1.1.4 this method returned fragments of composite indexes and it was then possible for the migration code to crash because it would try to delete the same index multiple times.

Specified by:

getIndexes in interface DatabaseMetaDataReader

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 simple indexes

getForeignKeys

public java.lang.Iterable<ForeignKey> getForeignKeys(java.sql.DatabaseMetaData metaData,
                                                     java.lang.String tableName)

Description copied from interface: DatabaseMetaDataReader

Gets the list of foreign keys for a given table

Specified by:

getForeignKeys in interface DatabaseMetaDataReader

Parameters:

metaData - 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