org.batoo.jpa.core.jdbc.adapter

Class JdbcTable

java.lang.Object

org.batoo.jpa.core.jdbc.adapter.JdbcTable

public class JdbcTable
extends Object

The metadata for an existing table in the database.

Since:

$version

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
JdbcTable(DatabaseMetaData dbMetadata, ResultSet metadata)

Method Summary

Methods

Modifier and Type	Method and Description
JdbcColumn	getColumn(String name) Returns the column metadata for the column with the name.
JdbcForeignKey	getForeignKey(String name) Returns the foreign key with then name.
Collection<JdbcForeignKey>	getForeignKeys() Returns the foreign keys of the table.
JdbcIndex	getIndex(String name) Returns the index with then name.
String	getName() Returns the name of the table.
String	getPkName() Returns the primary key name of the table.
String	getSchema() Returns the schema of the table.
void	logNotNullExtraColumns(Collection<String> columns) Logs the list of columns that do now exist in the persistence unit yet not nullable.
boolean	requiresPkDrop(Set<String> pkColumnNames) Returns if primary key drop is required.

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcTable

public JdbcTable(DatabaseMetaData dbMetadata,
         ResultSet metadata)
          throws SQLException

Parameters:

dbMetadata - the JDBC database metadata

metadata - the table metadata obtained from the JDBC database metadata

Throws:

SQLException - thrown in case of an SQL error.

Since:

$version

Method Detail

getColumn

public JdbcColumn getColumn(String name)

Returns the column metadata for the column with the name.

Parameters:

name - the name of the column

Returns:

the column metadta or null

Since:

$version

getForeignKey

public JdbcForeignKey getForeignKey(String name)

Returns the foreign key with then name.

Parameters:

name - the name of the foreign key

Returns:

the foreign key or null if there is no existing foreign key with the name

Since:

$version

getForeignKeys

public Collection<JdbcForeignKey> getForeignKeys()

Returns the foreign keys of the table.

Returns:

the foreign keys of the table

Since:

$version

getIndex

public JdbcIndex getIndex(String name)

Returns the index with then name.

Parameters:

name - the name of the index

Returns:

the index or null if there is no existing index with the name

Since:

$version

getName

public String getName()

Returns the name of the table.

Returns:

the name of the table

Since:

$version

getPkName

public String getPkName()

Returns the primary key name of the table.

Returns:

the primary key name of the table

Since:

$version

getSchema

public String getSchema()

Returns the schema of the table.

Returns:

the schema of the table

Since:

$version

logNotNullExtraColumns

public void logNotNullExtraColumns(Collection<String> columns)

Logs the list of columns that do now exist in the persistence unit yet not nullable.

Parameters:

columns - the set of columns

Since:

$version

requiresPkDrop

public boolean requiresPkDrop(Set<String> pkColumnNames)

Returns if primary key drop is required.

Parameters:

pkColumnNames - the set of required primary keys

Returns:

true if primary key drop is required, false otherwise

Since:

$version