org.hibernate.tool.schema.extract.internal

Class InformationExtractorJdbcDatabaseMetaDataImpl

java.lang.Object

org.hibernate.tool.schema.extract.internal.InformationExtractorJdbcDatabaseMetaDataImpl

All Implemented Interfaces:

InformationExtractor

public class InformationExtractorJdbcDatabaseMetaDataImpl
extends Object
implements InformationExtractor

Implementation of the SchemaMetaDataExtractor contract which uses the standard JDBC DatabaseMetaData API for extraction.

Author:

Steve Ebersole

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	InformationExtractorJdbcDatabaseMetaDataImpl.ForeignKeyBuilder
protected static class	InformationExtractorJdbcDatabaseMetaDataImpl.ForeignKeyBuilderImpl

Constructor Summary

Constructors

Constructor and Description
InformationExtractorJdbcDatabaseMetaDataImpl(ExtractionContext extractionContext)

Method Summary

Modifier and Type	Method and Description
boolean	catalogExists(Identifier catalog) Does the given catalog exist yet?
protected JDBCException	convertSQLException(SQLException sqlException, String message)
TableInformation	extractTableInformation(Identifier catalog, Identifier schema, Identifier name, ResultSet resultSet)
ColumnInformation	getColumn(TableInformation tableInformation, Identifier columnIdentifier) Return information about column for the given table.
Iterable<ForeignKeyInformation>	getForeignKeys(TableInformation tableInformation) Extract information about foreign keys defined on the given table (targeting or point-at other tables).
Iterable<IndexInformation>	getIndexes(TableInformation tableInformation) Extract information about indexes defined against the given table.
PrimaryKeyInformation	getPrimaryKey(TableInformationImpl tableInformation) Extract information about the given table's primary key.
TableInformation	getTable(Identifier catalog, Identifier schema, Identifier tableName) Look for a matching table.
protected IdentifierHelper	identifierHelper()
protected boolean	isPhysicalTableType(String tableType)
boolean	schemaExists(Identifier catalog, Identifier schema) The the given schema exist yet?
protected String	toMetaDataObjectName(Identifier identifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

InformationExtractorJdbcDatabaseMetaDataImpl

public InformationExtractorJdbcDatabaseMetaDataImpl(ExtractionContext extractionContext)

Method Detail

identifierHelper

protected IdentifierHelper identifierHelper()

convertSQLException

protected JDBCException convertSQLException(SQLException sqlException,
                                            String message)

toMetaDataObjectName

protected String toMetaDataObjectName(Identifier identifier)

catalogExists

public boolean catalogExists(Identifier catalog)

Description copied from interface: InformationExtractor

Does the given catalog exist yet?

Specified by:

catalogExists in interface InformationExtractor

Parameters:

catalog - The name of the catalog to look for.

Returns:

true if the catalog does exist; false otherwise

schemaExists

public boolean schemaExists(Identifier catalog,
                            Identifier schema)

Description copied from interface: InformationExtractor

The the given schema exist yet?

Specified by:

schemaExists in interface InformationExtractor

Parameters:

catalog - The name of the catalog to look in.

schema - The name of the schema to look for.

Returns:

true if the schema does exist; false otherwise

extractTableInformation

public TableInformation extractTableInformation(Identifier catalog,
                                                Identifier schema,
                                                Identifier name,
                                                ResultSet resultSet)
                                         throws SQLException

Throws:

SQLException

getTable

public TableInformation getTable(Identifier catalog,
                                 Identifier schema,
                                 Identifier tableName)

Description copied from interface: InformationExtractor

Look for a matching table.

Specified by:

getTable in interface InformationExtractor

Parameters:

catalog - Can be null, indicating that any catalog may be considered a match. A non-null value indicates that search should be limited to the passed catalog.

schema - Can be null, indicating that any schema may be considered a match. A non-null value indicates that search should be limited to the passed schema .

tableName - The name of the table to look for.

Returns:

table info for the matching table

isPhysicalTableType

protected boolean isPhysicalTableType(String tableType)

getColumn

public ColumnInformation getColumn(TableInformation tableInformation,
                                   Identifier columnIdentifier)

Description copied from interface: InformationExtractor

Return information about column for the given table. Typically called from the TableInformation itself as part of on-demand initialization of its state.

Specified by:

getColumn in interface InformationExtractor

Parameters:

tableInformation - table info for the matching table

columnIdentifier - The column identifier for which to locate column

Returns:

The extracted column information

getPrimaryKey

public PrimaryKeyInformation getPrimaryKey(TableInformationImpl tableInformation)

Description copied from interface: InformationExtractor

Extract information about the given table's primary key.

Specified by:

getPrimaryKey in interface InformationExtractor

Parameters:

tableInformation - The table for which to locate primary key information,

Returns:

The extracted primary key information

getIndexes

public Iterable<IndexInformation> getIndexes(TableInformation tableInformation)

Description copied from interface: InformationExtractor

Extract information about indexes defined against the given table. Typically called from the TableInformation itself as part of on-demand initialization of its state.

Specified by:

getIndexes in interface InformationExtractor

Parameters:

tableInformation - The table for which to locate indexes

Returns:

The extracted index information

getForeignKeys

public Iterable<ForeignKeyInformation> getForeignKeys(TableInformation tableInformation)

Description copied from interface: InformationExtractor

Extract information about foreign keys defined on the given table (targeting or point-at other tables). Typically called from the TableInformation itself as part of on-demand initialization of its state.

Specified by:

getForeignKeys in interface InformationExtractor

Parameters:

tableInformation - The table for which to locate foreign-keys

Returns:

The extracted foreign-key information