org.datanucleus.store.rdbms.table

Class SecondaryTable

java.lang.Object

org.datanucleus.store.rdbms.table.AbstractTable

org.datanucleus.store.rdbms.table.TableImpl

org.datanucleus.store.rdbms.table.AbstractClassTable

org.datanucleus.store.rdbms.table.SecondaryTable

All Implemented Interfaces:

DatastoreClass, SecondaryDatastoreClass, org.datanucleus.store.schema.table.Table

public class SecondaryTable
extends AbstractClassTable
implements SecondaryDatastoreClass

Representation of a secondary table for a class. Has a primary table that manages the main fields for that class and some fields are defined (using <field table="...">) to be stored in the secondary table. Many of the methods in this class defer to the equivalent method in the primary table.

Field Summary

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

datastoreIDMapping, discriminatorMapping, discriminatorMetaData, highestMemberNumber, idMapping, memberMappingsMap, pkMappings, tenantMapping, versionMapping, versionMetaData

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

columns, columnsByIdentifier, dba, existsInDatastore, identifier, state, storeMgr, TABLE_STATE_INITIALIZED, TABLE_STATE_INITIALIZED_MODIFIED, TABLE_STATE_NEW, TABLE_STATE_PK_INITIALIZED, TABLE_STATE_VALIDATED

Method Summary

Modifier and Type	Method and Description
DatastoreClass	getBaseDatastoreClass() Accessor for the base datastore class.
DatastoreClass	getBaseDatastoreClassWithMember(org.datanucleus.metadata.AbstractMemberMetaData mmd) Convenience accessor for the base table for this table which has the specified field.
protected List	getExpectedForeignKeys() Accessor for the expected foreign keys for this table.
JavaTypeMapping	getExternalMapping(org.datanucleus.metadata.AbstractMemberMetaData fmd, int mappingType) Accessor for the external mapping for the specified field of the specified type.
org.datanucleus.metadata.IdentityType	getIdentityType() Accessor for the identity-type.
JavaTypeMapping	getIdMapping() Accessor for the ID mapping for this table.
org.datanucleus.metadata.JoinMetaData	getJoinMetaData() Accessor for the JoinMetaData which is used to join to the primary DatastoreClass.
String[]	getManagedClasses() Accessor for the names of all classes managed by this table.
JavaTypeMapping	getMemberMapping(org.datanucleus.metadata.AbstractMemberMetaData mmd) Accessor for the field/property Mapping.
JavaTypeMapping	getMemberMapping(String fieldName) Accessor for the field mapping for the specified field.
JavaTypeMapping	getMemberMappingInDatastoreClass(org.datanucleus.metadata.AbstractMemberMetaData mmd) Accessor for the mapping for the specified field only in this datastore class.
org.datanucleus.metadata.AbstractMemberMetaData	getMetaDataForExternalMapping(JavaTypeMapping mapping, int mappingType) Accessor for the owner field metadata for the specified external mapping of the specified type
DatastoreClass	getPrimaryDatastoreClass() Accessor for the primary datastore class that this is dependent on.
PrimaryKey	getPrimaryKey() Accessor for the primary key for this table.
Collection	getSecondaryDatastoreClasses() Accessor for any secondary tables for this table.
DatastoreClass	getSuperDatastoreClass() Accessor for the supertable for this table.
String	getType() Accessor for the main type represented here.
void	initialize(org.datanucleus.ClassLoaderResolver clr) Method to initialise the table.
protected void	initializePK(org.datanucleus.ClassLoaderResolver clr) Method to initialise the primary key of this table.
boolean	isBaseDatastoreClass() Whether this table is the base in the inheritance hierarchy.
boolean	isObjectIdDatastoreAttributed() Whether this table or super table has id (primary key) attributed by the datastore
boolean	isSuperDatastoreClass(DatastoreClass table) Accessor whether the supplied DatastoreClass is a supertable of this table.
boolean	managesClass(String className) Accessor for whether this table manages the specified class
void	postInitialize(org.datanucleus.ClassLoaderResolver clr) Post initilize.
void	preInitialize(org.datanucleus.ClassLoaderResolver clr) Pre initilize.
void	provideExternalMappings(MappingConsumer consumer, int mappingType) Instruction to provide all external mappings to the passed consumer.
void	providePrimaryKeyMappings(MappingConsumer consumer) Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity).
void	provideUnmappedColumns(MappingConsumer consumer) Method to provide all unmapped datastore fields (columns) to the consumer.

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

addMemberMapping, addMultitenancyMapping, getDatastoreIdColumn, getDatastoreIdMapping, getDiscriminatorColumn, getDiscriminatorMapping, getMappingForMemberName, getMultitenancyColumn, getMultitenancyMapping, getPrimaryTable, getVersionColumn, getVersionMapping, managesMapping, managesMember, provideDatastoreIdMappings, provideDiscriminatorMappings, provideMappingsForMembers, provideMultitenancyMapping, provideNonPrimaryKeyMappings, provideVersionMappings

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

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

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

addColumn, addColumnInternal, allowDDLOutput, assertIsInitialized, assertIsInitializedModified, assertIsPKInitialized, assertIsPKUninitialized, assertIsUninitialized, assertIsValidated, create, drop, equals, executeDdlStatement, executeDdlStatementList, exists, getCatalogName, getClassMetaData, getColumn, getColumnForName, getColumnForPosition, getColumns, getDatastoreIdentifierFullyQualified, getDiscriminatorMetaData, getIdentifier, getMemberColumnMappingForEmbeddedMember, getMemberColumnMappingForMember, getMemberColumnMappings, getName, getNumberOfColumns, getSchemaName, getStoreManager, getVersionMetaData, hasColumn, hasColumnName, hashCode, isInitialized, isInitializedModified, isPKInitialized, isValidated, tableExistsInDatastore, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datanucleus.store.rdbms.table.DatastoreClass

getDatastoreIdMapping, managesMapping, provideDatastoreIdMappings, provideDiscriminatorMappings, provideMappingsForMembers, provideMultitenancyMapping, provideNonPrimaryKeyMappings, provideVersionMappings, toString

Methods inherited from interface org.datanucleus.store.rdbms.table.Table

addColumn, create, drop, exists, getColumn, getDiscriminatorMapping, getDiscriminatorMetaData, getIdentifier, getMultitenancyMapping, getStoreManager, getVersionMapping, getVersionMetaData, hasColumn, isInitialized, isInitializedModified, isValidated, validate

Methods inherited from interface org.datanucleus.store.schema.table.Table

getCatalogName, getClassMetaData, getColumnForName, getColumnForPosition, getColumns, getDatastoreIdColumn, getDiscriminatorColumn, getMemberColumnMappingForEmbeddedMember, getMemberColumnMappingForMember, getMemberColumnMappings, getMultitenancyColumn, getName, getNumberOfColumns, getSchemaName, getVersionColumn

Method Detail

preInitialize

public void preInitialize(org.datanucleus.ClassLoaderResolver clr)

Pre initilize. For things that must be initialized right after constructor

Overrides:

preInitialize in class TableImpl

Parameters:

clr - the ClassLoaderResolver

initialize

public void initialize(org.datanucleus.ClassLoaderResolver clr)

Method to initialise the table. This will initialise the primary key columns for the table. Any other columns are added via the addFieldMapping() method.

Parameters:

clr - The ClassLoaderResolver

postInitialize

public void postInitialize(org.datanucleus.ClassLoaderResolver clr)

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

Overrides:

postInitialize in class TableImpl

Parameters:

clr - the ClassLoaderResolver

initializePK

protected void initializePK(org.datanucleus.ClassLoaderResolver clr)

Method to initialise the primary key of this table.

Specified by:

initializePK in class AbstractClassTable

Parameters:

clr - The ClassLoaderResolver

See Also:

AbstractClassTable.initializePK(ClassLoaderResolver)

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.

getPrimaryDatastoreClass

public DatastoreClass getPrimaryDatastoreClass()

Accessor for the primary datastore class that this is dependent on.

Specified by:

getPrimaryDatastoreClass in interface SecondaryDatastoreClass

Returns:

The associated primary datastore class.

getJoinMetaData

public org.datanucleus.metadata.JoinMetaData getJoinMetaData()

Accessor for the JoinMetaData which is used to join to the primary DatastoreClass.

Specified by:

getJoinMetaData in interface SecondaryDatastoreClass

Returns:

JoinMetaData

getIdentityType

public org.datanucleus.metadata.IdentityType getIdentityType()

Accessor for the identity-type. Simply returns the same as the primary table

Specified by:

getIdentityType in interface DatastoreClass

Specified by:

getIdentityType in class AbstractClassTable

Returns:

identity-type tag value

getType

public String getType()

Accessor for the main type represented here.

Specified by:

getType in interface DatastoreClass

Returns:

Name of the principal class represented

isObjectIdDatastoreAttributed

public boolean isObjectIdDatastoreAttributed()

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

Specified by:

isObjectIdDatastoreAttributed in interface 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 in the inheritance hierarchy.

Specified by:

isBaseDatastoreClass in interface DatastoreClass

Returns:

true if this table is a root table

getBaseDatastoreClass

public DatastoreClass getBaseDatastoreClass()

Description copied from interface: DatastoreClass

Accessor for the base datastore class. Returns this object if it has no superclass table, otherwise goes up to the superclass etc.

Specified by:

getBaseDatastoreClass in interface DatastoreClass

Returns:

The base datastore class

getBaseDatastoreClassWithMember

public DatastoreClass getBaseDatastoreClassWithMember(org.datanucleus.metadata.AbstractMemberMetaData mmd)

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

Specified by:

getBaseDatastoreClassWithMember in interface DatastoreClass

Parameters:

mmd - Field MetaData for this field

Returns:

The base table which has the field specified

getSuperDatastoreClass

public DatastoreClass getSuperDatastoreClass()

Accessor for the supertable for this table.

Specified by:

getSuperDatastoreClass in interface DatastoreClass

Returns:

The supertable

isSuperDatastoreClass

public boolean isSuperDatastoreClass(DatastoreClass table)

Accessor whether the supplied DatastoreClass is a supertable of this table.

Specified by:

isSuperDatastoreClass in interface DatastoreClass

Parameters:

table - The DatastoreClass to check

Returns:

Whether it is a supertable (somewhere up the inheritance tree)

getSecondaryDatastoreClasses

public Collection getSecondaryDatastoreClasses()

Accessor for any secondary tables for this table.

Specified by:

getSecondaryDatastoreClasses in interface DatastoreClass

Returns:

Secondary tables (if any)

managesClass

public boolean managesClass(String className)

Accessor for whether this table manages the specified class

Specified by:

managesClass in interface DatastoreClass

Parameters:

className - Name of the class

Returns:

Whether it is managed by this table

getManagedClasses

public String[] getManagedClasses()

Description copied from interface: DatastoreClass

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

Specified by:

getManagedClasses in interface DatastoreClass

Returns:

Names of the classes managed (stored) here

getExpectedForeignKeys

protected List getExpectedForeignKeys()

Accessor for the expected foreign keys for this table.

Returns:

The expected foreign keys.

getMemberMapping

public JavaTypeMapping getMemberMapping(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Accessor for the field/property Mapping. Returns the mapping if it is present in this table.

Specified by:

getMemberMapping in interface DatastoreClass

Parameters:

mmd - Field MetaData for this field/property

Returns:

the Mapping for the field/property

getMemberMappingInDatastoreClass

public JavaTypeMapping getMemberMappingInDatastoreClass(org.datanucleus.metadata.AbstractMemberMetaData mmd)

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

Specified by:

getMemberMappingInDatastoreClass in interface DatastoreClass

Parameters:

mmd - Metadata of the field/property

Returns:

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

getMemberMapping

public JavaTypeMapping getMemberMapping(String fieldName)

Accessor for the field mapping for the specified field. 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:

getMemberMapping in interface DatastoreClass

Parameters:

fieldName - Name of the field

Returns:

The mapping for the field

getIdMapping

public JavaTypeMapping getIdMapping()

Accessor for the ID mapping for this table.

Returns:

The ID mapping

providePrimaryKeyMappings

public void providePrimaryKeyMappings(MappingConsumer consumer)

Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity).

Specified by:

providePrimaryKeyMappings in interface DatastoreClass

Specified by:

providePrimaryKeyMappings in class AbstractClassTable

Parameters:

consumer - Consumer for the mappings

provideExternalMappings

public void provideExternalMappings(MappingConsumer consumer,
                                    int mappingType)

Description copied from interface: DatastoreClass

Instruction to provide all external mappings to the passed consumer.

Specified by:

provideExternalMappings in interface DatastoreClass

Parameters:

consumer - The consumer for the mappings

mappingType - Type of external mapping to provide

provideUnmappedColumns

public void provideUnmappedColumns(MappingConsumer consumer)

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

Specified by:

provideUnmappedColumns in interface DatastoreClass

Parameters:

consumer - Consumer of information

getExternalMapping

public JavaTypeMapping getExternalMapping(org.datanucleus.metadata.AbstractMemberMetaData fmd,
                                          int mappingType)

Description copied from interface: DatastoreClass

Accessor for the external mapping for the specified field of the specified type. An external mapping is a mapping for which there is no field in the actual class to represent it (part of a relation). The type can be FK, FK discriminator, order, etc

Specified by:

getExternalMapping in interface DatastoreClass

Parameters:

fmd - MetaData for the (external) field/property

mappingType - The type of mapping

Returns:

The external mapping

getMetaDataForExternalMapping

public org.datanucleus.metadata.AbstractMemberMetaData getMetaDataForExternalMapping(JavaTypeMapping mapping,
                                                                                     int mappingType)

Description copied from interface: DatastoreClass

Accessor for the owner field metadata for the specified external mapping of the specified type

Specified by:

getMetaDataForExternalMapping in interface DatastoreClass

Parameters:

mapping - The external mapping

mappingType - The type of mapping

Returns:

Field MetaData in the owner class