org.jpox.store.rdbms.table
Class SchemaTable

java.lang.Object
  org.jpox.store.rdbms.table.AbstractTable
      org.jpox.store.rdbms.table.TableImpl
          org.jpox.store.rdbms.table.SchemaTable

All Implemented Interfaces:

org.jpox.store.mapped.DatastoreContainerObject, org.jpox.store.mapped.DatastoreObject, Table

public class SchemaTable
extends TableImpl

Class defining JPOX schema definition tables. Represents a table in the datastore storing the class and table mappings. This table is used when restarting a JPOX system so that it is 'aware' of what classes were supported the previous time this datastore was used. It uses this information to pre-populate the RDBMSManager with the classes stored in this table. The table names are not used as such, other than as a record of what table a class maps to - because it goes off and finds the MetaData for the class which, with the JPOX naming scheme, defines the table name anyway.

Version:

$Revision: 1.4 $

Field Summary

Fields inherited from class org.jpox.store.rdbms.table.AbstractTable

columns, columnsByName, completeDdl, dba, ddlWriter, existsInDatastore, identifier, LOCALISER, state, storeMgr

Fields inherited from interface org.jpox.store.rdbms.table.Table

TABLE_STATE_INITIALIZED, TABLE_STATE_INITIALIZED_MODIFIED, TABLE_STATE_NEW, TABLE_STATE_PK_INITIALIZED, TABLE_STATE_VALIDATED, TABLE_TYPE_MISSING, TABLE_TYPE_TABLE, TABLE_TYPE_UNKNOWN, TABLE_TYPE_VIEW

Constructor Summary

SchemaTable(RDBMSManager storeMgr, java.lang.String tableName)
Constructor.

Method Summary

void	addClass(org.jpox.store.mapped.MappedStoreData data, org.jpox.ManagedConnection conn) Method to insert a row in the SchemaTable.
void	deleteAllClasses(org.jpox.ManagedConnection conn) Method to delete all classes from the SchemaTable.
void	deleteClass(java.lang.String class_name, org.jpox.ManagedConnection conn) Method to delete a class from the SchemaTable.
java.util.HashSet	getAllClasses(org.jpox.ManagedConnection conn) Accessor for the classes already supported by this Schema Table.
org.jpox.store.mapped.mapping.JavaTypeMapping	getFieldMapping(org.jpox.metadata.AbstractMemberMetaData fmd) Accessor the for the mapping for a field store in this table
org.jpox.store.mapped.mapping.JavaTypeMapping	getIDMapping() Accessor for a mapping for the ID (PersistenceCapable) for this table.
void	initialize(org.jpox.ClassLoaderResolver clr) Method to initialise the table.

Methods inherited from class org.jpox.store.rdbms.table.TableImpl

createConstraints, dropConstraints, getExpectedCandidateKeys, getExpectedForeignKeys, getExpectedIndices, getPrimaryKey, getSQLAddCandidateKeyStatements, getSQLAddFKStatements, getSQLCreateIndexStatements, getSQLCreateStatements, getSQLDropStatements, initializeColumnInfoForPrimaryKeyColumns, initializeColumnInfoFromDatastore, postInitialize, preInitialize, validate, validateColumns, validateConstraints, validatePrimaryKey

Methods inherited from class org.jpox.store.rdbms.table.AbstractTable

addColumnInternal, addDatastoreField, allowDDLOutput, assertIsInitialized, assertIsInitializedModified, assertIsPKInitialized, assertIsPKUninitialized, assertIsUninitialized, assertIsValidated, create, drop, equals, executeDdlStatement, executeDdlStatementList, exists, getCatalogName, getDatastoreFieldsMetaData, getDatastoreIdentifierFullyQualified, getDiscriminatorMapping, getDiscriminatorMetaData, getIdentifier, getSchemaName, getStoreManager, getVersionMapping, getVersionMetaData, hasColumnName, hasDatastoreField, hashCode, isCompleteDdl, isInitialized, isInitializedModified, isOutputtingDDL, isPKInitialized, isValidated, setCompleteDdl, setDdlWriter, tableExistsInDatastore, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SchemaTable

public SchemaTable(RDBMSManager storeMgr,
                   java.lang.String tableName)

Constructor.

Parameters:

storeMgr - The RDBMSManager for this datastore

tableName - Name of the starter table (optional, uses JPOX_TABLES when this is null)

Method Detail

initialize

public void initialize(org.jpox.ClassLoaderResolver clr)

Method to initialise the table.

Parameters:

clr - The ClassLoaderResolver

getIDMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getIDMapping()

Accessor for a mapping for the ID (PersistenceCapable) for this table.

Returns:

The (PersistenceCapable) ID mapping.

getAllClasses

public java.util.HashSet getAllClasses(org.jpox.ManagedConnection conn)
                                throws java.sql.SQLException

Accessor for the classes already supported by this Schema Table.

Parameters:

conn - Connection for this datastore.

Returns:

The HashSet of class names (StoreData)

Throws:

java.sql.SQLException - Thrown when an error occurs in the process.

addClass

public void addClass(org.jpox.store.mapped.MappedStoreData data,
                     org.jpox.ManagedConnection conn)
              throws java.sql.SQLException

Method to insert a row in the SchemaTable. This is called when JPOX is now supporting a new class (and hence DB table).

Parameters:

data - Data for the class

conn - Connection to the datastore

Throws:

java.sql.SQLException - Thrown when an error occurs inserting the schema.

deleteClass

public void deleteClass(java.lang.String class_name,
                        org.jpox.ManagedConnection conn)
                 throws java.sql.SQLException

Method to delete a class from the SchemaTable. This is called when JPOX is required to clean out support for a particular class.

Parameters:

class_name - Name of class to delete

conn - Connection to the datastore

Throws:

java.sql.SQLException - Thrown when an error occurs deleting the schema.

deleteAllClasses

public void deleteAllClasses(org.jpox.ManagedConnection conn)
                      throws java.sql.SQLException

Method to delete all classes from the SchemaTable. This is called when JPOX is required to clean out its supported classes (and hence DB table).

Parameters:

conn - Connection to the datastore

Throws:

java.sql.SQLException - Thrown when an error occurs deleting the schema.

getFieldMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getFieldMapping(org.jpox.metadata.AbstractMemberMetaData fmd)

Accessor the for the mapping for a field store in this table

Parameters:

fmd - MetaData for the field whose mapping we want

Returns:

The mapping