org.datanucleus.store.rdbms.table
Interface Table

All Superinterfaces:

org.datanucleus.store.mapped.DatastoreContainerObject

All Known Implementing Classes:

AbstractClassTable, AbstractTable, ArrayTable, ClassTable, ClassView, CollectionTable, ElementContainerTable, JoinTable, MapTable, PersistableJoinTable, ProbeTable, SchemaTable, SecondaryTable, SequenceTable, TableImpl, ViewImpl

public interface Table
extends org.datanucleus.store.mapped.DatastoreContainerObject

Representation of a table in a datastore.

There are 2 aspects to a table. The first is the internal representation, provided here. This has a state. The second aspect to the table is its external (datastore) representation. This reflects whether it exists, or whether it has been deleted, etc.

This interface provides some methods for mapping from the internal representation to the external representation. These are the methods

• create() - to create the table in the datastore
• drop() - to drop the table from the datastore
• validate() - to compare the internal and external representations.
• exists() - whether the external representation exists

Method Summary

boolean	create(Connection conn) Method to create the table in the datastore representation.
void	drop(Connection conn) Method to drop the table from the datastore representation.
boolean	exists(Connection conn, boolean create) Accessor for whether the table exists in the datastore.
String	getCatalogName() Accessor for the Catalog name for this table.
String	getSchemaName() Accessor for the Schema name for this table.
void	initialize(org.datanucleus.ClassLoaderResolver clr) Method to initialise the table.
boolean	isInitialized() Accessor for whether the table has been initialised.
boolean	isInitializedModified() Accessor for whether the table has been modified after being initialised.
boolean	isValidated() Accessor for whether the table is validated.
void	postInitialize(org.datanucleus.ClassLoaderResolver clr) Post-initialize; for things that must be set after all classes have been initialized.
void	preInitialize(org.datanucleus.ClassLoaderResolver clr) Pre-initialize method; for things that must be initialized right after construction.
boolean	validate(Connection conn, boolean validateColumnStructure, boolean autoCreate, Collection autoCreateErrors) Method to validate the table against what is in the datastore.

Methods inherited from interface org.datanucleus.store.mapped.DatastoreContainerObject

addDatastoreField, getDatastoreField, getDatastoreFields, getDiscriminatorMapping, getDiscriminatorMetaData, getIdentifier, getIdMapping, getMemberMapping, getMultitenancyMapping, getStoreManager, getVersionMapping, getVersionMetaData, hasDatastoreField

Method Detail

getCatalogName

String getCatalogName()

Accessor for the Catalog name for this table.

Returns:

The Catalog name.

getSchemaName

String getSchemaName()

Accessor for the Schema name for this table.

Returns:

The Schema name.

initialize

void initialize(org.datanucleus.ClassLoaderResolver clr)

Method to initialise the table.

Parameters:

clr - The ClassLoaderResolver

preInitialize

void preInitialize(org.datanucleus.ClassLoaderResolver clr)

Pre-initialize method; for things that must be initialized right after construction.

Parameters:

clr - the ClassLoaderResolver

postInitialize

void postInitialize(org.datanucleus.ClassLoaderResolver clr)

Post-initialize; for things that must be set after all classes have been initialized.

Parameters:

clr - the ClassLoaderResolver

isInitialized

boolean isInitialized()

Accessor for whether the table has been initialised.

Returns:

Whether it is initialised.

isInitializedModified

boolean isInitializedModified()

Accessor for whether the table has been modified after being initialised.

Returns:

Whether it has been modified after being initialised.

validate

boolean validate(Connection conn,
                 boolean validateColumnStructure,
                 boolean autoCreate,
                 Collection autoCreateErrors)
                 throws SQLException

Method to validate the table against what is in the datastore.

Parameters:

conn - The connection

validateColumnStructure - Whether to validate down to the column structure, or just the existence

autoCreate - Whether to update the table to fix any errors.

autoCreateErrors - Errors found during the auto-create process

Returns:

Whether it validates successfully

Throws:

SQLException - Thrown if an error occurrs in the validation

isValidated

boolean isValidated()

Accessor for whether the table is validated.

Returns:

Whether it is validated.

exists

boolean exists(Connection conn,
               boolean create)
               throws SQLException

Accessor for whether the table exists in the datastore. Will throw a MissingTableException if the table doesn't exist.

Parameters:

conn - The connecton to use to verify it

create - Whether to create it if it doesn't exist

Returns:

Whether the table was added.

Throws:

SQLException - Thrown if an error occurs in the check

create

boolean create(Connection conn)
               throws SQLException

Method to create the table in the datastore representation.

Parameters:

conn - The connection to use

Returns:

true if the table was created

Throws:

SQLException - Thrown if an error occurs creating the table.

drop

void drop(Connection conn)
          throws SQLException

Method to drop the table from the datastore representation.

Parameters:

conn - The connection to use

Throws:

SQLException - Thrown if an error occurs