org.jpox.store.rdbms.table
Class ClassTable

java.lang.Object
  org.jpox.store.rdbms.table.AbstractTable
      org.jpox.store.rdbms.table.TableImpl
          org.jpox.store.rdbms.table.AbstractClassTable
              org.jpox.store.rdbms.table.ClassTable

All Implemented Interfaces:

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

public class ClassTable
extends AbstractClassTable
implements org.jpox.store.mapped.DatastoreClass

Table representing a Java class (or classes) as a first class object (FCO). Uses the inheritance strategy to control whether this represents multiple classes or just the one class.

Mappings

This class adds some additional mappings over what the superclass provides. Here we add

• externalFkMappings - any mappings for Collections that have no associated field in this class, providing the foreign key column(s)
• externalOrderMappings - mappings for any ordering column used by Lists for ordering elements of this class
• externalFkDiscriminatorMappings - mappings for any discriminator column used when sharing external foreign keys to distinguish the element owner field

Classes

A table can represent multiple classes. It has a nominal owner which is the class that has an inheritance strategy of "new-table". All classes that utilise this table have their MetaData stored in this object.

Secondary Tables

This class represents a "primary" table. That is, the main table where objects of a class are persisted. It can have several "secondary" tables where some of the classes fields are stored at persistence.

Version:

$Revision: 1.245 $

Field Summary

protected java.lang.String	managingClassCurrent Name of class currently being processed in manageClass (if any).
protected boolean	runCallbacksAfterManageClass Flag to run the callbacks after the current class is managed fully.

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

datastoreIDMapping, discriminatorMapping, discriminatorMetaData, fieldMappingsMap, highestFieldNumber, idMapping, pkMappings, versionMapping, versionMetaData

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

ClassTable(org.jpox.store.mapped.DatastoreIdentifier tableName, RDBMSManager storeMgr, org.jpox.metadata.ClassMetaData cmd)
Constructor.

Method Summary

org.jpox.store.mapped.DatastoreClass	getBaseDatastoreClassWithField(org.jpox.metadata.AbstractMemberMetaData fmd) Convenience accessor for the base table for this table which has the specified field.
org.jpox.store.mapped.mapping.JavaTypeMapping	getDiscriminatorMapping(boolean allowSuperclasses) Accessor for the discriminator mapping specified .
org.jpox.metadata.DiscriminatorMetaData	getDiscriminatorMetaData() Accessor for Discriminator MetaData
protected java.util.List	getExpectedCandidateKeys() Accessor for the expected candidate keys for this table.
protected java.util.List	getExpectedForeignKeys(org.jpox.ClassLoaderResolver clr) Accessor for the expected foreign keys for this table.
protected java.util.Set	getExpectedIndices(org.jpox.ClassLoaderResolver clr) Accessor for the indices for this table.
org.jpox.store.mapped.mapping.JavaTypeMapping	getExternalMapping(org.jpox.metadata.AbstractMemberMetaData fmd, int mappingType) Accessor for an external mapping for the specified field of the required type.
org.jpox.store.mapped.mapping.JavaTypeMapping	getFieldMapping(org.jpox.metadata.AbstractMemberMetaData fmd) Accessor for the field mapping for the specified field.
org.jpox.store.mapped.mapping.JavaTypeMapping	getFieldMapping(java.lang.String fieldName) Accessor for the field mapping for the named field.
org.jpox.store.mapped.mapping.JavaTypeMapping	getFieldMappingInDatastoreClass(org.jpox.metadata.AbstractMemberMetaData mmd) Accessor for the mapping for the specified field only in this datastore class.
org.jpox.metadata.IdentityType	getIdentityType() Accessor for the identity-type.
org.jpox.store.mapped.mapping.JavaTypeMapping	getIDMapping() Accessor for a mapping for the ID (PersistenceCapable) for this table.
java.lang.String[]	getManagedClasses() Accessor for the names of all classes managed by this table.
org.jpox.metadata.AbstractMemberMetaData	getMetaDataForExternalMapping(org.jpox.store.mapped.mapping.JavaTypeMapping mapping, int mappingType) Accessor for the MetaData for the (owner) field that an external mapping corresponds to.
PrimaryKey	getPrimaryKey() Accessor for the primary key for this table.
java.util.Collection	getSecondaryDatastoreClasses() Accessor for any secondary tables for this table.
protected java.util.List	getSQLCreateStatements(java.util.Properties props) Accessor for the CREATE statements for this table.
protected java.util.List	getSQLDropStatements() Accessor for the DROP statements for this table.
org.jpox.store.mapped.DatastoreClass	getSuperDatastoreClass() Accessor for the supertable for this table.
ClassTable	getTableWithDiscriminator() Convenience method to return the root table with a discriminator in this inheritance tree.
java.lang.String	getType() Accessor for the main class represented.
org.jpox.store.mapped.mapping.JavaTypeMapping	getVersionMapping(boolean allowSuperclasses) Accessor for the version mapping specified .
org.jpox.metadata.VersionMetaData	getVersionMetaData() Accessor for versionMetaData
void	initialize(org.jpox.ClassLoaderResolver clr) Method to initialise the table.
protected void	initializePK(org.jpox.ClassLoaderResolver clr) Method to initialise the table primary key field(s).
boolean	isBaseDatastoreClass() Whether this table is the base table in the inheritance hierarchy.
boolean	isObjectIDDatastoreAttributed() Whether this table or super table has id (primary key) attributed by the datastore
void	manageClass(org.jpox.metadata.AbstractClassMetaData theCmd, org.jpox.ClassLoaderResolver clr) Method that adds the specified class to be managed by this table.
boolean	managesClass(java.lang.String className) Accessor for whether this table manages the specified class
void	postInitialize(org.jpox.ClassLoaderResolver clr) Post initilize.
void	preInitialize(org.jpox.ClassLoaderResolver clr) Pre-initialize.
void	provideExternalMappings(org.jpox.store.mapped.mapping.MappingConsumer consumer, int mappingType) Provide the mappings to the consumer for all external fields mapped to this table of the specified type
void	provideMappingsForFields(org.jpox.store.mapped.mapping.MappingConsumer consumer, org.jpox.metadata.AbstractMemberMetaData[] fieldMetaData, boolean includeSecondaryTables) Provide the mappings to the consumer for all absolute field Numbers in this table that are container in the fieldNumbers parameter.
void	providePrimaryKeyMappings(org.jpox.store.mapped.mapping.MappingConsumer consumer) Provide the mappings to the consumer for all primary-key fields mapped to this table.
void	provideUnmappedDatastoreFields(org.jpox.store.mapped.mapping.MappingConsumer consumer) Method to provide all unmapped datastore fields (columns) to the consumer.
boolean	validateConstraints(java.sql.Connection conn, boolean autoCreate, java.util.Collection autoCreateErrors, org.jpox.ClassLoaderResolver clr) Method to validate the constraints of this table.

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

addFieldMapping, getDataStoreObjectIdMapping, getMappingForFieldName, getPrimaryDatastoreContainerObject, managesField, provideDatastoreIdMappings, provideDiscriminatorMappings, provideNonPrimaryKeyMappings, provideVersionMappings

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

createConstraints, dropConstraints, getSQLAddCandidateKeyStatements, getSQLAddFKStatements, getSQLCreateIndexStatements, initializeColumnInfoForPrimaryKeyColumns, initializeColumnInfoFromDatastore, validate, validateColumns, 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, getIdentifier, getSchemaName, getStoreManager, 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, toString, wait, wait, wait

Methods inherited from interface org.jpox.store.mapped.DatastoreClass

getDataStoreObjectIdMapping, provideDatastoreIdMappings, provideDiscriminatorMappings, provideNonPrimaryKeyMappings, provideVersionMappings, toString

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

addDatastoreField, getDatastoreFieldsMetaData, hasDatastoreField

Methods inherited from interface org.jpox.store.mapped.DatastoreObject

getIdentifier, getStoreManager

Field Detail

managingClassCurrent

protected transient java.lang.String managingClassCurrent

Name of class currently being processed in manageClass (if any).

runCallbacksAfterManageClass

protected boolean runCallbacksAfterManageClass

Flag to run the callbacks after the current class is managed fully.

Constructor Detail

ClassTable

public ClassTable(org.jpox.store.mapped.DatastoreIdentifier tableName,
                  RDBMSManager storeMgr,
                  org.jpox.metadata.ClassMetaData cmd)

Constructor.

Parameters:

tableName - Table name SQL identifier

storeMgr - Store Manager to manage this table

cmd - MetaData for the class.

Method Detail

preInitialize

public void preInitialize(org.jpox.ClassLoaderResolver clr)

Pre-initialize. We require any supertable, and the PK to be ready before we start initialisation.

Specified by:

preInitialize in interface Table

Overrides:

preInitialize in class TableImpl

Parameters:

clr - the ClassLoaderResolver

initialize

public void initialize(org.jpox.ClassLoaderResolver clr)

Method to initialise the table. This adds the columns based on the MetaData representation for the class being represented by this table.

Specified by:

initialize in interface Table

Parameters:

clr - The ClassLoaderResolver

postInitialize

public void postInitialize(org.jpox.ClassLoaderResolver clr)

Post initilize. For things that must be set after all classes have been initialized before

Specified by:

postInitialize in interface Table

Overrides:

postInitialize in class TableImpl

Parameters:

clr - the ClassLoaderResolver

manageClass

public void manageClass(org.jpox.metadata.AbstractClassMetaData theCmd,
                        org.jpox.ClassLoaderResolver clr)

Method that adds the specified class to be managed by this table. Will provide mapping of all persistent fields to their underlying columns, map all necessary identity fields, and manage all "unmapped" columns that have no associated field. where the columns are defined for each mapping.

Parameters:

theCmd - ClassMetaData for the class to be managed

clr - The ClassLoaderResolver

getManagedClasses

public java.lang.String[] getManagedClasses()

Accessor for the names of all classes managed by this table.

Returns:

Names of the classes managed (stored) here

managesClass

public boolean managesClass(java.lang.String className)

Accessor for whether this table manages the specified class

Specified by:

managesClass in interface org.jpox.store.mapped.DatastoreClass

Parameters:

className - Name of the class

Returns:

Whether it is managed by this table

initializePK

protected void initializePK(org.jpox.ClassLoaderResolver clr)

Method to initialise the table primary key field(s).

Specified by:

initializePK in class AbstractClassTable

Parameters:

clr - The ClassLoaderResolver

getType

public java.lang.String getType()

Accessor for the main class represented.

Specified by:

getType in interface org.jpox.store.mapped.DatastoreClass

Returns:

The name of the class

getIdentityType

public org.jpox.metadata.IdentityType getIdentityType()

Accessor for the identity-type.

Specified by:

getIdentityType in interface org.jpox.store.mapped.DatastoreClass

Specified by:

getIdentityType in class AbstractClassTable

Returns:

identity-type tag value

getVersionMetaData

public final org.jpox.metadata.VersionMetaData getVersionMetaData()

Accessor for versionMetaData

Specified by:

getVersionMetaData in interface org.jpox.store.mapped.DatastoreContainerObject

Overrides:

getVersionMetaData in class AbstractTable

Returns:

Returns the versionMetaData.

getDiscriminatorMetaData

public final org.jpox.metadata.DiscriminatorMetaData getDiscriminatorMetaData()

Accessor for Discriminator MetaData

Specified by:

getDiscriminatorMetaData in interface org.jpox.store.mapped.DatastoreContainerObject

Overrides:

getDiscriminatorMetaData in class AbstractTable

Returns:

Returns the Discriminator MetaData.

getTableWithDiscriminator

public final ClassTable getTableWithDiscriminator()

Convenience method to return the root table with a discriminator in this inheritance tree.

Returns:

The root table which has the discriminator in this inheritance tree

isObjectIDDatastoreAttributed

public boolean isObjectIDDatastoreAttributed()

Whether this table or super table has id (primary key) attributed by the datastore

Specified by:

isObjectIDDatastoreAttributed in interface org.jpox.store.mapped.DatastoreClass

Specified by:

isObjectIDDatastoreAttributed in class AbstractClassTable

Returns:

true if the id attributed by the datastore

isBaseDatastoreClass

public boolean isBaseDatastoreClass()

Whether this table is the base table in the inheritance hierarchy.

Specified by:

isBaseDatastoreClass in interface org.jpox.store.mapped.DatastoreClass

Returns:

true if this table is a root table

getSuperDatastoreClass

public org.jpox.store.mapped.DatastoreClass getSuperDatastoreClass()

Accessor for the supertable for this table.

Specified by:

getSuperDatastoreClass in interface org.jpox.store.mapped.DatastoreClass

Returns:

The supertable

getSecondaryDatastoreClasses

public java.util.Collection getSecondaryDatastoreClasses()

Accessor for any secondary tables for this table.

Specified by:

getSecondaryDatastoreClasses in interface org.jpox.store.mapped.DatastoreClass

Returns:

Secondary tables (if any)

getVersionMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getVersionMapping(boolean allowSuperclasses)

Accessor for the version mapping specified .

Specified by:

getVersionMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Overrides:

getVersionMapping in class AbstractClassTable

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The version mapping.

getDiscriminatorMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses)

Accessor for the discriminator mapping specified .

Specified by:

getDiscriminatorMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Overrides:

getDiscriminatorMapping in class AbstractClassTable

Parameters:

allowSuperclasses - Whether we should return just the mapping from this table or whether we should return it when this table has none and the supertable has

Returns:

The discriminator mapping.

getBaseDatastoreClassWithField

public org.jpox.store.mapped.DatastoreClass getBaseDatastoreClassWithField(org.jpox.metadata.AbstractMemberMetaData fmd)

Convenience accessor for the base table for this table which has the specified field.

Specified by:

getBaseDatastoreClassWithField in interface org.jpox.store.mapped.DatastoreClass

Parameters:

fmd - Field MetaData for this field

Returns:

The base table which has the field specified

getExpectedIndices

protected java.util.Set getExpectedIndices(org.jpox.ClassLoaderResolver clr)

Accessor for the indices for this table. This includes both the user-defined indices (via MetaData), and the ones required by foreign keys (required by relationships).

Overrides:

getExpectedIndices in class TableImpl

Parameters:

clr - The ClassLoaderResolver

Returns:

The indices

getExpectedForeignKeys

protected java.util.List getExpectedForeignKeys(org.jpox.ClassLoaderResolver clr)

Accessor for the expected foreign keys for this table.

Overrides:

getExpectedForeignKeys in class TableImpl

Parameters:

clr - The ClassLoaderResolver

Returns:

The expected foreign keys.

getExpectedCandidateKeys

protected java.util.List getExpectedCandidateKeys()

Accessor for the expected candidate keys for this table.

Overrides:

getExpectedCandidateKeys in class TableImpl

Returns:

The expected candidate keys.

getPrimaryKey

public PrimaryKey getPrimaryKey()

Accessor for the primary key for this table. Overrides the method in TableImpl to add on any specification of PK name in the metadata.

Overrides:

getPrimaryKey in class TableImpl

Returns:

The primary key.

getSQLCreateStatements

protected java.util.List getSQLCreateStatements(java.util.Properties props)

Accessor for the CREATE statements for this table. Creates this table followed by all secondary tables (if any).

Overrides:

getSQLCreateStatements in class TableImpl

Parameters:

props - Properties for creating the table

Returns:

the SQL statements to be executed for creation

getSQLDropStatements

protected java.util.List getSQLDropStatements()

Accessor for the DROP statements for this table. Drops all secondary tables (if any) followed by the table itself.

Overrides:

getSQLDropStatements in class TableImpl

Returns:

List of statements

getIDMapping

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

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

Specified by:

getIDMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Returns:

The (PersistenceCapable) ID mapping.

getExternalMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getExternalMapping(org.jpox.metadata.AbstractMemberMetaData fmd,
                                                                        int mappingType)

Accessor for an external mapping for the specified field of the required type.

Specified by:

getExternalMapping in interface org.jpox.store.mapped.DatastoreClass

Parameters:

fmd - MetaData for the field

mappingType - Type of mapping

Returns:

The (external) mapping

getMetaDataForExternalMapping

public org.jpox.metadata.AbstractMemberMetaData getMetaDataForExternalMapping(org.jpox.store.mapped.mapping.JavaTypeMapping mapping,
                                                                              int mappingType)

Accessor for the MetaData for the (owner) field that an external mapping corresponds to.

Specified by:

getMetaDataForExternalMapping in interface org.jpox.store.mapped.DatastoreClass

Parameters:

mapping - The mapping

mappingType - The mapping type

Returns:

The fieldMetaData

getFieldMapping

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

Accessor for the field mapping for the specified field. The field can be managed by a supertable of this table.

Specified by:

getFieldMapping in interface org.jpox.store.mapped.DatastoreClass

Specified by:

getFieldMapping in interface org.jpox.store.mapped.DatastoreContainerObject

Parameters:

fmd - Field MetaData for this field

Returns:

the Mapping for the field

getFieldMappingInDatastoreClass

public org.jpox.store.mapped.mapping.JavaTypeMapping getFieldMappingInDatastoreClass(org.jpox.metadata.AbstractMemberMetaData mmd)

Accessor for the mapping for the specified field only in this datastore class.

Specified by:

getFieldMappingInDatastoreClass in interface org.jpox.store.mapped.DatastoreClass

Parameters:

mmd - Metadata of the field/property

Returns:

The Mapping for the field (or null if not present here)

getFieldMapping

public org.jpox.store.mapped.mapping.JavaTypeMapping getFieldMapping(java.lang.String fieldName)

Accessor for the field mapping for the named field. The field may exist in a parent table or a secondary table. Throws a NoSuchPersistentFieldException if the field name is not found. TODO Use of this is discouraged since the fieldName is not fully qualified and if a superclass-table inheritance is used we could have 2 fields of that name here.

Specified by:

getFieldMapping in interface org.jpox.store.mapped.DatastoreClass

Parameters:

fieldName - Name of field

Returns:

The field mapping.

Throws:

org.jpox.store.exceptions.NoSuchPersistentFieldException - Thrown when the field is not found

providePrimaryKeyMappings

public void providePrimaryKeyMappings(org.jpox.store.mapped.mapping.MappingConsumer consumer)

Provide the mappings to the consumer for all primary-key fields mapped to this table.

Specified by:

providePrimaryKeyMappings in interface org.jpox.store.mapped.DatastoreClass

Specified by:

providePrimaryKeyMappings in class AbstractClassTable

Parameters:

consumer - Consumer for the mappings

provideExternalMappings

public final void provideExternalMappings(org.jpox.store.mapped.mapping.MappingConsumer consumer,
                                          int mappingType)

Provide the mappings to the consumer for all external fields mapped to this table of the specified type

Specified by:

provideExternalMappings in interface org.jpox.store.mapped.DatastoreClass

Parameters:

consumer - Consumer for the mappings

mappingType - Type of external mapping

provideMappingsForFields

public void provideMappingsForFields(org.jpox.store.mapped.mapping.MappingConsumer consumer,
                                     org.jpox.metadata.AbstractMemberMetaData[] fieldMetaData,
                                     boolean includeSecondaryTables)

Provide the mappings to the consumer for all absolute field Numbers in this table that are container in the fieldNumbers parameter.

Specified by:

provideMappingsForFields in interface org.jpox.store.mapped.DatastoreClass

Overrides:

provideMappingsForFields in class AbstractClassTable

Parameters:

consumer - Consumer for the mappings

fieldMetaData - MetaData for the fields to provide mappings for

includeSecondaryTables - Whether to provide fields in secondary tables

provideUnmappedDatastoreFields

public void provideUnmappedDatastoreFields(org.jpox.store.mapped.mapping.MappingConsumer consumer)

Method to provide all unmapped datastore fields (columns) to the consumer.

Specified by:

provideUnmappedDatastoreFields in interface org.jpox.store.mapped.DatastoreClass

Parameters:

consumer - Consumer of information

validateConstraints

public boolean validateConstraints(java.sql.Connection conn,
                                   boolean autoCreate,
                                   java.util.Collection autoCreateErrors,
                                   org.jpox.ClassLoaderResolver clr)
                            throws java.sql.SQLException

Method to validate the constraints of this table.

Overrides:

validateConstraints in class TableImpl

Parameters:

conn - Connection to use in validation

autoCreate - Whether to auto create the constraints

autoCreateErrors - Whether to log a warning only on errors during "auto create"

clr - The ClassLoaderResolver

Returns:

Whether the DB was modified

Throws:

java.sql.SQLException - Thrown when an error occurs in validation