org.datanucleus.store.rdbms.table

Class AbstractClassTable

java.lang.Object

org.datanucleus.store.rdbms.table.AbstractTable

org.datanucleus.store.rdbms.table.TableImpl

org.datanucleus.store.rdbms.table.AbstractClassTable

All Implemented Interfaces:

org.datanucleus.store.schema.table.Table

Direct Known Subclasses:

ClassTable, SecondaryTable

public abstract class AbstractClassTable
extends TableImpl

Abstract representation of a table for a class. Abstracts out the common parts of a primary ClassTable and a SecondaryClassTable.

Mappings

A Table is built from a series of field mappings. Each Java class has a series of fields and each of these has an associated JavaTypeMapping. Each JavaTypeMapping has related DatastoreMapping(s). These are used in mapping the Java class to the table, and are used when populating the table, and when retrieving data from the table back to the object. There are several categories of mappings in this class

• memberMappingsMap - the set of mappings relating to the fields in the class. The mappings are keyed by the FieldMetaData of the field. Any embedded field will have a single mapping here of type EmbeddedPCMapping, with a set of datastore mappings attached.
• datastoreIDMapping - the Identity mapping when using "datastore identity"
• pkMappings - the mappings for the primary key column(s).
• discriminatorMapping - mapping for any discriminator column. This is only used where classes share this table and some of them use "superclass-table" strategy
• versionMapping - mapping for any versioning column

Field Summary

Fields

Modifier and Type	Field and Description
protected JavaTypeMapping	datastoreIDMapping Mapping for datastore identity (optional).
protected JavaTypeMapping	discriminatorMapping Mapping for any discriminator column.
protected org.datanucleus.metadata.DiscriminatorMetaData	discriminatorMetaData MetaData for discriminator for objects stored in this table.
protected int	highestMemberNumber Highest absolute field/property number managed by this table
protected JavaTypeMapping	idMapping Mapping for the id of the table.
protected Map<org.datanucleus.metadata.AbstractMemberMetaData,JavaTypeMapping>	memberMappingsMap Mappings for members mapped to this table, keyed by the metadata for the member.
protected JavaTypeMapping[]	pkMappings Mappings for application identity (optional).
protected JavaTypeMapping	tenantMapping Mapping for multi-tenancy.
protected JavaTypeMapping	versionMapping Mapping for any version/timestamp column.
protected org.datanucleus.metadata.VersionMetaData	versionMetaData MetaData for versioning of objects stored in this table.

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

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

Constructor Summary

Constructors

Constructor and Description
AbstractClassTable(DatastoreIdentifier tableName, RDBMSStoreManager storeMgr) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addMemberMapping(JavaTypeMapping fieldMapping) Utility to add the mapping for a field/property to the managed list.
protected void	addMultitenancyMapping(org.datanucleus.metadata.ColumnMetaData colmd) Method to add a multi-tenancy discriminator column.
org.datanucleus.store.schema.table.Column	getDatastoreIdColumn()
JavaTypeMapping	getDatastoreIdMapping() Accessor for a mapping for the datastore ID for this table.
org.datanucleus.store.schema.table.Column	getDiscriminatorColumn()
JavaTypeMapping	getDiscriminatorMapping(boolean allowSuperclasses) Accessor for the discriminator mapping specified.
abstract org.datanucleus.metadata.IdentityType	getIdentityType() Accessor for the identity-type.
protected JavaTypeMapping	getMappingForMemberName(String memberName) Accessor for the JavaTypeMapping that is handling the member of the specified name.
org.datanucleus.store.schema.table.Column	getMultitenancyColumn()
JavaTypeMapping	getMultitenancyMapping() Accessor for the multi-tenancy mapping (if any).
Table	getPrimaryTable() Convenience method to return the primary table.
org.datanucleus.store.schema.table.Column	getVersionColumn()
JavaTypeMapping	getVersionMapping(boolean allowSuperclasses) Accessor for the version mapping specified .
protected abstract void	initializePK(org.datanucleus.ClassLoaderResolver clr) Method to initialise the table primary key field(s).
abstract boolean	isObjectIdDatastoreAttributed() Accessor for whether the table has its identity attributed by the datastore (e.g using autoincrement)
boolean	managesMapping(JavaTypeMapping mapping) Convenience method to return if this table manages the columns for the supplied mapping.
boolean	managesMember(String memberName) Convenience method for whether the (fully-specified) member is managed by this table
void	provideDatastoreIdMappings(MappingConsumer consumer) Accessor for a mapping for the datastore ID (OID) for this table.
void	provideDiscriminatorMappings(MappingConsumer consumer) Provide the discriminator mappings
void	provideMappingsForMembers(MappingConsumer consumer, org.datanucleus.metadata.AbstractMemberMetaData[] mmds, boolean includeSecondaryTables) Provide the mappings to the consumer for all specified members.
void	provideMultitenancyMapping(MappingConsumer consumer) Provide the multitenancy mapping.
void	provideNonPrimaryKeyMappings(MappingConsumer consumer) Provide the mappings to the consumer for all non primary-key fields mapped to this table.
abstract void	providePrimaryKeyMappings(MappingConsumer consumer) Provide the mappings to the consumer for all primary-key fields mapped to this table (for application identity).
void	provideVersionMappings(MappingConsumer consumer) Provide the version mappings.

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

createConstraints, dropConstraints, getExpectedCandidateKeys, getExpectedForeignKeys, getExpectedIndices, getPrimaryKey, getSQLAddCandidateKeyStatements, getSQLAddFKStatements, getSQLCreateIndexStatements, getSQLCreateStatements, getSQLDropStatements, initializeColumnInfoForPrimaryKeyColumns, initializeColumnInfoFromDatastore, logMapping, postInitialize, preInitialize, 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.Table

getIdMapping, getMemberMapping, initialize

Field Detail

memberMappingsMap

protected Map<org.datanucleus.metadata.AbstractMemberMetaData,JavaTypeMapping> memberMappingsMap

Mappings for members mapped to this table, keyed by the metadata for the member.

datastoreIDMapping

protected JavaTypeMapping datastoreIDMapping

Mapping for datastore identity (optional).

pkMappings

protected JavaTypeMapping[] pkMappings

Mappings for application identity (optional).

idMapping

protected JavaTypeMapping idMapping

Mapping for the id of the table.

versionMapping

protected JavaTypeMapping versionMapping

Mapping for any version/timestamp column.

versionMetaData

protected org.datanucleus.metadata.VersionMetaData versionMetaData

MetaData for versioning of objects stored in this table.

discriminatorMetaData

protected org.datanucleus.metadata.DiscriminatorMetaData discriminatorMetaData

MetaData for discriminator for objects stored in this table.

discriminatorMapping

protected JavaTypeMapping discriminatorMapping

Mapping for any discriminator column.

highestMemberNumber

protected int highestMemberNumber

Highest absolute field/property number managed by this table

tenantMapping

protected JavaTypeMapping tenantMapping

Mapping for multi-tenancy.

Constructor Detail

AbstractClassTable

public AbstractClassTable(DatastoreIdentifier tableName,
                          RDBMSStoreManager storeMgr)

Constructor.

Parameters:

tableName - Name of the table

storeMgr - Store Manager that is managing this instance

Method Detail

getPrimaryTable

public Table getPrimaryTable()

Convenience method to return the primary table.

Returns:

The primary table for this table

initializePK

protected abstract void initializePK(org.datanucleus.ClassLoaderResolver clr)

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

Parameters:

clr - The ClassLoaderResolver

managesMember

public boolean managesMember(String memberName)

Convenience method for whether the (fully-specified) member is managed by this table

Parameters:

memberName - Fully qualified name of the field/property

Returns:

Whether it is managed

getMappingForMemberName

protected JavaTypeMapping getMappingForMemberName(String memberName)

Accessor for the JavaTypeMapping that is handling the member of the specified name. Returns the first one that matches.

Parameters:

memberName - Name of the field/property

Returns:

The java type mapping

managesMapping

public boolean managesMapping(JavaTypeMapping mapping)

Convenience method to return if this table manages the columns for the supplied mapping.

Parameters:

mapping - The mapping

Returns:

Whether the mapping is managed in this table

addMultitenancyMapping

protected void addMultitenancyMapping(org.datanucleus.metadata.ColumnMetaData colmd)

Method to add a multi-tenancy discriminator column.

Parameters:

colmd - Metadata defining the column required

addMemberMapping

protected void addMemberMapping(JavaTypeMapping fieldMapping)

Utility to add the mapping for a field/property to the managed list.

Parameters:

fieldMapping - The mapping for the field/property

getIdentityType

public abstract org.datanucleus.metadata.IdentityType getIdentityType()

Accessor for the identity-type.

Returns:

identity-type tag value

isObjectIdDatastoreAttributed

public abstract boolean isObjectIdDatastoreAttributed()

Accessor for whether the table has its identity attributed by the datastore (e.g using autoincrement)

Returns:

Whether it is datastore attributed

getDatastoreIdMapping

public JavaTypeMapping getDatastoreIdMapping()

Accessor for a mapping for the datastore ID for this table.

Returns:

The datastoreId mapping.

getDatastoreIdColumn

public org.datanucleus.store.schema.table.Column getDatastoreIdColumn()

Specified by:

getDatastoreIdColumn in interface org.datanucleus.store.schema.table.Table

Overrides:

getDatastoreIdColumn in class AbstractTable

getVersionMapping

public JavaTypeMapping getVersionMapping(boolean allowSuperclasses)

Accessor for the version mapping specified .

Overrides:

getVersionMapping in class AbstractTable

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.

getVersionColumn

public org.datanucleus.store.schema.table.Column getVersionColumn()

Specified by:

getVersionColumn in interface org.datanucleus.store.schema.table.Table

Overrides:

getVersionColumn in class AbstractTable

getDiscriminatorMapping

public JavaTypeMapping getDiscriminatorMapping(boolean allowSuperclasses)

Accessor for the discriminator mapping specified.

Overrides:

getDiscriminatorMapping in class AbstractTable

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 mapping for the discriminator column

getDiscriminatorColumn

public org.datanucleus.store.schema.table.Column getDiscriminatorColumn()

Specified by:

getDiscriminatorColumn in interface org.datanucleus.store.schema.table.Table

Overrides:

getDiscriminatorColumn in class AbstractTable

getMultitenancyMapping

public JavaTypeMapping getMultitenancyMapping()

Description copied from interface: Table

Accessor for the multi-tenancy mapping (if any).

Overrides:

getMultitenancyMapping in class AbstractTable

Returns:

The multi-tenancy mapping

getMultitenancyColumn

public org.datanucleus.store.schema.table.Column getMultitenancyColumn()

Specified by:

getMultitenancyColumn in interface org.datanucleus.store.schema.table.Table

Overrides:

getMultitenancyColumn in class AbstractTable

provideDatastoreIdMappings

public final void provideDatastoreIdMappings(MappingConsumer consumer)

Accessor for a mapping for the datastore ID (OID) for this table.

Parameters:

consumer - Consumer for the mappings

providePrimaryKeyMappings

public abstract void providePrimaryKeyMappings(MappingConsumer consumer)

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

Parameters:

consumer - Consumer for the mappings

provideNonPrimaryKeyMappings

public final void provideNonPrimaryKeyMappings(MappingConsumer consumer)

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

Parameters:

consumer - Consumer for the mappings

provideMappingsForMembers

public void provideMappingsForMembers(MappingConsumer consumer,
                                      org.datanucleus.metadata.AbstractMemberMetaData[] mmds,
                                      boolean includeSecondaryTables)

Provide the mappings to the consumer for all specified members.

Parameters:

consumer - Consumer for the mappings

mmds - MetaData for the members to provide mappings for

includeSecondaryTables - Whether to provide members in secondary tables

provideVersionMappings

public final void provideVersionMappings(MappingConsumer consumer)

Provide the version mappings.

Parameters:

consumer - Consumer for the version mappings

provideDiscriminatorMappings

public final void provideDiscriminatorMappings(MappingConsumer consumer)

Provide the discriminator mappings

Parameters:

consumer - Consumer for the mappings

provideMultitenancyMapping

public final void provideMultitenancyMapping(MappingConsumer consumer)

Provide the multitenancy mapping.

Parameters:

consumer - Consumer for the mapping