org.eclipse.persistence.mappings
Class ManyToManyMapping

java.lang.Object
  org.eclipse.persistence.mappings.DatabaseMapping
      org.eclipse.persistence.mappings.ForeignReferenceMapping
          org.eclipse.persistence.mappings.CollectionMapping
              org.eclipse.persistence.mappings.ManyToManyMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ContainerMapping, MapComponentMapping, RelationalMapping

public class ManyToManyMapping
extends CollectionMapping
implements RelationalMapping, MapComponentMapping

Purpose: Many to many mappings are used to represent the relationships between a collection of source objects and a collection of target objects. The mapping require the creation of an intermediate table for managing the associations between the source and target records.

See Also:

Serialized Form

Author:

Sati

Since:

TOPLink/Java 1.0

Field Summary

protected HistoryPolicy	historyPolicy
protected RelationTableMechanism	mechanism Mechanism holds relationTable and all fields and queries associated with it.
protected static java.lang.String	ObjectAdded
protected static java.lang.String	ObjectRemoved
protected static java.lang.String	PostInsert Used for data modification events.

Fields inherited from class org.eclipse.persistence.mappings.CollectionMapping

changeOrderTargetQuery, containerPolicy, deleteAllQuery, hasCustomDeleteAllQuery, hasOrderBy, isListOrderFieldSupported, listOrderField, orderCorrectionType

Fields inherited from class org.eclipse.persistence.mappings.ForeignReferenceMapping

cascadeMerge, cascadePersist, cascadeRefresh, cascadeRemove, forceInitializationOfSelectionCriteria, hasCustomSelectionQuery, indirectionPolicy, INNER_JOIN, isPrivateOwned, joinFetch, NONE, OUTER_JOIN, referenceClass, referenceClassName, referenceDescriptor, relationshipPartner, relationshipPartnerAttributeName, requiresTransientWeavedFields, selectionQuery, tempInitSession, usesBatchReading

Fields inherited from class org.eclipse.persistence.mappings.DatabaseMapping

attributeAccessor, attributeName, descriptor, fields, isDerivedIdMapping, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mappedByIdValue, NO_FIELDS, NO_WEIGHT, properties, weight, WEIGHT_1

Constructor Summary

ManyToManyMapping()
PUBLIC: Default constructor.

Method Summary

void	addSourceRelationKeyField(org.eclipse.persistence.internal.helper.DatabaseField sourceRelationKeyField, org.eclipse.persistence.internal.helper.DatabaseField sourcePrimaryKeyField) PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the source table.
void	addSourceRelationKeyFieldName(java.lang.String sourceRelationKeyFieldName, java.lang.String sourcePrimaryKeyFieldName) PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the source table.
void	addTargetRelationKeyField(org.eclipse.persistence.internal.helper.DatabaseField targetRelationKeyField, org.eclipse.persistence.internal.helper.DatabaseField targetPrimaryKeyField) PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the target table.
void	addTargetRelationKeyFieldName(java.lang.String targetRelationKeyFieldName, java.lang.String targetPrimaryKeyFieldName) PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the target table.
protected void	buildListOrderField() INTERNAL: Verifies listOrderField's table: it must be relation table.
java.lang.Object	clone() INTERNAL: The mapping clones itself to create deep copy.
java.lang.Object	createMapComponentFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow, ObjectBuildingQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL Called when a DatabaseMapping is used to map the key in a collection.
void	earlyPreDelete(DeleteObjectQuery query) INTERNAL: This method is called to update collection tables prior to commit.
void	extendPessimisticLockScopeInSourceQuery(ObjectLevelReadQuery sourceQuery) INTERNAL: Called only if both shouldExtendPessimisticLockScope and shouldExtendPessimisticLockScopeInSourceQuery are true.
protected void	extendPessimisticLockScopeInTargetQuery(ObjectLevelReadQuery targetQuery, ObjectBuildingQuery sourceQuery) INTERNAL: Adds locking clause to the target query to extend pessimistic lock scope.
protected java.util.Vector	extractKeyFromTargetRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Extract the source primary key value from the relation row.
protected java.util.Vector	extractPrimaryKeyFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Extract the primary key value from the source row.
protected DataModifyQuery	getDeleteQuery()
protected ReadQuery	getExtendPessimisticLockScopeDedicatedQuery(org.eclipse.persistence.internal.sessions.AbstractSession session, short lockMode) INTERNAL: Should be overridden by subclass that allows setting extendPessimisticLockScope to DEDICATED_QUERY.
HistoryPolicy	getHistoryPolicy() PUBLIC:
protected DataModifyQuery	getInsertQuery()
Expression	getJoinCriteria(org.eclipse.persistence.internal.expressions.QueryKeyExpression exp) INTERNAL: Returns the join criteria stored in the mapping selection query.
org.eclipse.persistence.internal.helper.DatabaseTable	getRelationTable() INTERNAL: Return the relation table associated with the mapping.
RelationTableMechanism	getRelationTableMechanism() PUBLIC: Returns RelationTableMechanism that may be owned by the mapping.
java.lang.String	getRelationTableName() PUBLIC: Return the relation table name associated with the mapping.
java.lang.String	getRelationTableQualifiedName() PUBLIC: Return the relation table qualified name associated with the mapping.
Expression	getSelectionCriteria() INTERNAL: Returns the selection criteria stored in the mapping selection query.
ReadQuery	getSelectionQuery() INTERNAL: Returns the read query assoicated with the mapping.
java.util.Vector	getSourceKeyFieldNames() PUBLIC: Return the source key field names associated with the mapping.
java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>	getSourceKeyFields() INTERNAL: Return all the source key fields associated with the mapping.
java.util.Vector	getSourceRelationKeyFieldNames() PUBLIC: Return the source relation key field names associated with the mapping.
java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>	getSourceRelationKeyFields() INTERNAL: Return all the source relation key fields associated with the mapping.
java.util.Vector	getTargetKeyFieldNames() PUBLIC: Return the target key field names associated with the mapping.
java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>	getTargetKeyFields() INTERNAL: Return all the target keys associated with the mapping.
java.util.Vector	getTargetRelationKeyFieldNames() PUBLIC: Return the target relation key field names associated with the mapping.
java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>	getTargetRelationKeyFields() INTERNAL: Return all the target relation key fields associated with the mapping.
protected boolean	hasCustomDeleteQuery()
protected boolean	hasCustomInsertQuery()
boolean	hasDependency() INTERNAL: The join table is a dependency if not read-only.
void	initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initialize mappings
protected void	initializeChangeOrderTargetQuery(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initialize changeOrderTargetQuery.
protected void	initializeDeleteAllQuery(org.eclipse.persistence.internal.sessions.AbstractSession session) Initialize delete all query.
protected void	initializeListOrderFieldTable(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initializes listOrderField's table.
protected void	initializeSelectionCriteriaAndAddFieldsToQuery(Expression startCriteria) INTERNAL: Selection criteria is created to read target records from the table.
protected void	insertAddedObjectEntry(ObjectLevelModifyQuery query, java.lang.Object objectAdded, java.util.Map extraData) INTERNAL: An object was added to the collection during an update, insert it.
void	insertIntoRelationTable(WriteObjectQuery query) INTERNAL: Insert into relation table.
void	insertTargetObjects(WriteObjectQuery query) INTERNAL: Write the target objects if the cascade policy requires them to be written first.
boolean	isJoiningSupported() INTERNAL: Return if this mapping support joining.
boolean	isManyToManyMapping() INTERNAL:
boolean	isRelationalMapping() INTERNAL:
protected boolean	mustDeleteReferenceObjectsOneByOne() For Many To Many mappings referenced objects are deleted one by one.
protected void	objectAddedDuringUpdate(ObjectLevelModifyQuery query, java.lang.Object objectAdded, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, java.util.Map extraData) INTERNAL: An object was added to the collection during an update, insert it if private.
protected void	objectOrderChangedDuringUpdate(WriteObjectQuery query, java.lang.Object orderChangedObject, int orderIndex)
protected void	objectRemovedDuringUpdate(ObjectLevelModifyQuery query, java.lang.Object objectDeleted, java.util.Map extraData) INTERNAL: An object was removed to the collection during an update, delete it if private.
void	performDataModificationEvent(java.lang.Object[] event, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Perform the commit event.
void	postInsert(WriteObjectQuery query) INTERNAL: Insert into relation table.
protected void	postPrepareNestedBatchQuery(ReadQuery batchQuery, ReadAllQuery query) INTERNAL: Add additional fields and check for history.
void	postUpdate(WriteObjectQuery query) INTERNAL: Update the relation table with the entries related to this mapping.
void	preDelete(DeleteObjectQuery query) INTERNAL: Delete entries related to this mapping from the relation table.
protected ReadQuery	prepareHistoricalQuery(ReadQuery targetQuery, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.AbstractSession executionSession) INTERNAL: Append the temporal selection to the query selection criteria.
protected void	prepareTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow, java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: The translation row may require additional fields than the primary key if the mapping in not on the primary key.
void	setCustomDeleteQuery(DataModifyQuery query) PUBLIC: The default delete query for mapping can be overridden by specifying the new query.
void	setCustomInsertQuery(DataModifyQuery query) PUBLIC: The default insert query for mapping can be overridden by specifying the new query.
void	setDeleteCall(Call call) PUBLIC: Set the receiver's delete Call.
protected void	setDeleteQuery(DataModifyQuery deleteQuery)
void	setDeleteSQLString(java.lang.String sqlString) PUBLIC: Set the receiver's delete SQL string.
void	setHistoryPolicy(HistoryPolicy policy) PUBLIC:
void	setInsertCall(Call call) PUBLIC: Set the receiver's insert Call.
protected void	setInsertQuery(DataModifyQuery insertQuery)
void	setInsertSQLString(java.lang.String sqlString) PUBLIC: Set the receiver's insert SQL string.
void	setRelationTable(org.eclipse.persistence.internal.helper.DatabaseTable relationTable) PUBLIC: Set the relational table.
void	setRelationTableName(java.lang.String tableName) PUBLIC: Set the name of the relational table.
void	setSessionName(java.lang.String name) PUBLIC: Set the name of the session to execute the mapping's queries under.
void	setSourceKeyFieldNames(java.util.Vector fieldNames) PUBLIC: Set the source key field names associated with the mapping.
void	setSourceKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> sourceKeyFields) INTERNAL: Set the source fields.
void	setSourceRelationKeyFieldName(java.lang.String sourceRelationKeyFieldName) PUBLIC: Set the source key field in the relation table.
void	setSourceRelationKeyFieldNames(java.util.Vector fieldNames) PUBLIC: Set the source relation key field names associated with the mapping.
void	setSourceRelationKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> sourceRelationKeyFields) INTERNAL: Set the source fields.
void	setTargetKeyFieldNames(java.util.Vector fieldNames) INTERNAL: Set the target key field names associated with the mapping.
void	setTargetKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> targetKeyFields) INTERNAL: Set the target fields.
void	setTargetRelationKeyFieldName(java.lang.String targetRelationKeyFieldName) PUBLIC: Set the target key field in the relation table.
void	setTargetRelationKeyFieldNames(java.util.Vector fieldNames) INTERNAL: Set the target relation key field names associated with the mapping.
void	setTargetRelationKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> targetRelationKeyFields) INTERNAL: Set the target fields.
boolean	shouldUseListOrderFieldTableExpression() INTERNAL: Indicates whether getListOrderFieldExpression method should create field expression on table expression.

Methods inherited from class org.eclipse.persistence.mappings.CollectionMapping

addAggregateOrderBy, addAscendingOrdering, addDescendingOrdering, addOrderBy, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildCopy, buildElementClone, buildReferencesPKList, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadeMerge, cascadePerformRemoveIfRequired, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cascadeRegisterNewIfRequired, compareCollectionsForChange, compareForChange, compareLists, compareListsAndWrite, compareObjects, compareObjectsAndWrite, compareObjectsWithoutPrivateOwned, compareObjectsWithPrivateOwned, convertClassNamesToClasses, extractResultFromBatchQuery, fixRealObjectReferences, getContainerPolicy, getDeleteAllQuery, getListOrderField, getListOrderFieldExpression, getObjectCorrespondingTo, getOrderByQueryKeyExpressions, getOrderCorrectionType, getRealCollectionAttributeValueFromObject, getSelectionQueryContainerPolicy, getTargetPrimaryKeyFields, hasCustomDeleteAllQuery, hasOrderBy, initializeListOrderField, isAttributeValueInstantiatedOrChanged, isChangeTrackingSupported, isCollectionMapping, isListOrderFieldSupported, iterateOnElement, iterateOnRealAttributeValue, mergeChangesForCollectionMembers, mergeChangesIntoObject, mergeIntoObject, objectUnchangedDuringUpdate, objectUnchangedDuringUpdate, postCalculateChanges, postDelete, postInitialize, preInsert, prepareNestedBatchQuery, preUpdate, readPrivateOwnedForObject, recordPrivateOwnedRemovals, replaceValueHoldersIn, setChangeListener, setContainerPolicy, setCustomDeleteAllQuery, setDeleteAllCall, setDeleteAllQuery, setDeleteAllSQLString, setHasCustomDeleteAllQuery, setListOrderField, setListOrderFieldName, setOrderCorrectionType, setSelectionQueryContainerPolicy, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, updateChangeRecord, updateCollectionChangeRecord, useCollectionClass, useCollectionClassName, useListClassName, useMapClass, useMapClass, useMapClassName, useSortedSetClass, useSortedSetClassName, useSortedSetClassName, useTransparentCollection, useTransparentList, useTransparentMap, useTransparentSet, validateBeforeInitialization, valueFromPKList, valueFromRowInternalWithJoin, verifyDelete

Methods inherited from class org.eclipse.persistence.mappings.ForeignReferenceMapping

batchedValueFromRow, buildBackupClone, buildClone, buildCloneFromRow, createUnitOfWorkValueHolder, dontDoMerge, dontUseBatchReading, dontUseIndirection, fixObjectReferences, getAttributeValueFromObject, getAttributeValueWithClonedValueHolders, getBatchReadObjects, getIndirectionPolicy, getJoinFetch, getRealAttributeValueFromAttribute, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationshipPartner, getRelationshipPartnerAttributeName, getTempSession, getValueFromRemoteValueHolder, hasCustomSelectionQuery, initializeReferenceDescriptor, initializeSelectionQuery, instantiateAttribute, isAttributeValueInstantiated, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, isExtendingPessimisticLockScope, isForeignReferenceMapping, isInnerJoinFetched, isJoinFetched, isLazy, isLockableMapping, isOuterJoinFetched, isPrivateOwned, iterate, mergeRemoteValueHolder, preInitialize, prepareNestedJoinQueryClone, prepareNestedJoins, privateOwnedRelationship, remoteInitialization, requiresTransientWeavedFields, setBatchReadObjects, setCascadeAll, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setCustomSelectionQuery, setForceInitializationOfSelectionCriteria, setHasCustomSelectionQuery, setIndirectionPolicy, setIsPrivateOwned, setJoinFetch, setRealAttributeValueInObject, setReferenceClass, setReferenceClassName, setReferenceDescriptor, setRelationshipPartner, setRelationshipPartnerAttributeName, setRequiresTransientWeavedFields, setSelectionCall, setSelectionCriteria, setSelectionQuery, setSelectionSQLString, setShouldExtendPessimisticLockScope, setTempSession, setUsesBatchReading, setUsesIndirection, shouldExtendPessimisticLockScope, shouldExtendPessimisticLockScopeInDedicatedQuery, shouldExtendPessimisticLockScopeInSourceQuery, shouldExtendPessimisticLockScopeInTargetQuery, shouldForceInitializationOfSelectionCriteria, shouldInitializeSelectionCriteria, shouldMergeCascadeParts, shouldMergeCascadeReference, shouldObjectModifyCascadeToParts, shouldUseBatchReading, shouldUseValueFromRowWithJoin, trimRowForJoin, trimRowForJoin, useBasicIndirection, useBatchReading, useContainerIndirection, useInnerJoinFetch, useOuterJoinFetch, usesIndirection, useWeavedIndirection, valueFromRow, valueFromRowInternal

Methods inherited from class org.eclipse.persistence.mappings.DatabaseMapping

buildExpression, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, cloneFields, collectFields, extractNestedExpressions, getAttributeAccessor, getAttributeClassification, getAttributeName, getDescriptor, getField, getFieldClassification, getFields, getGetMethodName, getMappedByIdValue, getProperties, getProperty, getRealAttributeValueFromObject, getSelectFields, getSelectTables, getSetMethodName, getWeight, hasConstraintDependency, hasInverseConstraintDependency, hasMappedByIdValue, hasRootExpressionThatShouldUseOuterJoin, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isCloningRequired, isDatabaseMapping, isDerivedIdMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isMapKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isReferenceMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, postCalculateChangesOnDeleted, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, rehashFieldDependancies, remotelyInitialized, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setDescriptor, setFields, setGetMethodName, setIsDerivedIdMapping, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMappedByIdValue, setProperties, setProperty, setSetMethodName, setWeight, toString, validateAfterInitialization, valueFromObject, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowForWhereClause, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PostInsert

protected static final java.lang.String PostInsert

Used for data modification events.

See Also:

Constant Field Values

ObjectRemoved

protected static final java.lang.String ObjectRemoved

See Also:

Constant Field Values

ObjectAdded

protected static final java.lang.String ObjectAdded

See Also:

Constant Field Values

mechanism

protected transient RelationTableMechanism mechanism

Mechanism holds relationTable and all fields and queries associated with it.

historyPolicy

protected HistoryPolicy historyPolicy

Constructor Detail

ManyToManyMapping

public ManyToManyMapping()

PUBLIC: Default constructor.

Method Detail

isRelationalMapping

public boolean isRelationalMapping()

INTERNAL:

Overrides:

isRelationalMapping in class DatabaseMapping

addSourceRelationKeyField

public void addSourceRelationKeyField(org.eclipse.persistence.internal.helper.DatabaseField sourceRelationKeyField,
                                      org.eclipse.persistence.internal.helper.DatabaseField sourcePrimaryKeyField)

PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the source table. This method is used if the keys are composite.

addSourceRelationKeyFieldName

public void addSourceRelationKeyFieldName(java.lang.String sourceRelationKeyFieldName,
                                          java.lang.String sourcePrimaryKeyFieldName)

PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the source table. This method is used if the keys are composite.

addTargetRelationKeyField

public void addTargetRelationKeyField(org.eclipse.persistence.internal.helper.DatabaseField targetRelationKeyField,
                                      org.eclipse.persistence.internal.helper.DatabaseField targetPrimaryKeyField)

PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the target table. This method is used if the keys are composite.

addTargetRelationKeyFieldName

public void addTargetRelationKeyFieldName(java.lang.String targetRelationKeyFieldName,
                                          java.lang.String targetPrimaryKeyFieldName)

PUBLIC: Add the fields in the intermediate table that corresponds to the primary key in the target table. This method is used if the keys are composite.

clone

public java.lang.Object clone()

INTERNAL: The mapping clones itself to create deep copy.

Overrides:

clone in class CollectionMapping

earlyPreDelete

public void earlyPreDelete(DeleteObjectQuery query)

INTERNAL: This method is called to update collection tables prior to commit.

Overrides:

earlyPreDelete in class DatabaseMapping

createMapComponentFromRow

public java.lang.Object createMapComponentFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow,
                                                  ObjectBuildingQuery query,
                                                  org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL Called when a DatabaseMapping is used to map the key in a collection. Returns the key.

Specified by:

createMapComponentFromRow in interface MapComponentMapping

extendPessimisticLockScopeInTargetQuery

protected void extendPessimisticLockScopeInTargetQuery(ObjectLevelReadQuery targetQuery,
                                                       ObjectBuildingQuery sourceQuery)

INTERNAL: Adds locking clause to the target query to extend pessimistic lock scope.

Overrides:

extendPessimisticLockScopeInTargetQuery in class ForeignReferenceMapping

extendPessimisticLockScopeInSourceQuery

public void extendPessimisticLockScopeInSourceQuery(ObjectLevelReadQuery sourceQuery)

INTERNAL: Called only if both shouldExtendPessimisticLockScope and shouldExtendPessimisticLockScopeInSourceQuery are true. Adds fields to be locked to the where clause of the source query. Note that the sourceQuery must be ObjectLevelReadQuery so that it has ExpressionBuilder. This method must be implemented in subclasses that allow setting shouldExtendPessimisticLockScopeInSourceQuery to true.

Overrides:

extendPessimisticLockScopeInSourceQuery in class ForeignReferenceMapping

extractKeyFromTargetRow

protected java.util.Vector extractKeyFromTargetRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Extract the source primary key value from the relation row. Used for batch reading, most following same order and fields as in the mapping.

Overrides:

extractKeyFromTargetRow in class CollectionMapping

extractPrimaryKeyFromRow

protected java.util.Vector extractPrimaryKeyFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                                    org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Extract the primary key value from the source row. Used for batch reading, most following same order and fields as in the mapping.

Overrides:

extractPrimaryKeyFromRow in class CollectionMapping

postPrepareNestedBatchQuery

protected void postPrepareNestedBatchQuery(ReadQuery batchQuery,
                                           ReadAllQuery query)

INTERNAL: Add additional fields and check for history.

Overrides:

postPrepareNestedBatchQuery in class ForeignReferenceMapping

getDeleteQuery

protected DataModifyQuery getDeleteQuery()

getExtendPessimisticLockScopeDedicatedQuery

protected ReadQuery getExtendPessimisticLockScopeDedicatedQuery(org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                                short lockMode)

INTERNAL: Should be overridden by subclass that allows setting extendPessimisticLockScope to DEDICATED_QUERY.

Overrides:

getExtendPessimisticLockScopeDedicatedQuery in class ForeignReferenceMapping

getInsertQuery

protected DataModifyQuery getInsertQuery()

getJoinCriteria

public Expression getJoinCriteria(org.eclipse.persistence.internal.expressions.QueryKeyExpression exp)

INTERNAL: Returns the join criteria stored in the mapping selection query. This criteria is used to read reference objects across the tables from the database.

Overrides:

getJoinCriteria in class CollectionMapping

getHistoryPolicy

public HistoryPolicy getHistoryPolicy()

PUBLIC:

getRelationTableMechanism

public RelationTableMechanism getRelationTableMechanism()

PUBLIC: Returns RelationTableMechanism that may be owned by the mapping. Note that all RelationTableMechanism methods are accessible through the mapping directly. The only reason this method is provided is to allow a uniform approach to RelationTableMechanism in both ManyToManyMapping and OneToOneMapping that uses RelationTableMechanism.

getRelationTable

public org.eclipse.persistence.internal.helper.DatabaseTable getRelationTable()

INTERNAL: Return the relation table associated with the mapping.

getRelationTableName

public java.lang.String getRelationTableName()

PUBLIC: Return the relation table name associated with the mapping.

getRelationTableQualifiedName

public java.lang.String getRelationTableQualifiedName()

PUBLIC: Return the relation table qualified name associated with the mapping.

getSelectionCriteria

public Expression getSelectionCriteria()

INTERNAL: Returns the selection criteria stored in the mapping selection query. This criteria is used to read reference objects from the database.

Overrides:

getSelectionCriteria in class ForeignReferenceMapping

See Also:

OneToOneMapping.buildSelectionCriteria(), OneToManyMapping.buildSelectionCriteria()

getSelectionQuery

public ReadQuery getSelectionQuery()

INTERNAL: Returns the read query assoicated with the mapping.

Overrides:

getSelectionQuery in class ForeignReferenceMapping

getSourceKeyFieldNames

public java.util.Vector getSourceKeyFieldNames()

PUBLIC: Return the source key field names associated with the mapping. These are in-order with the sourceRelationKeyFieldNames.

getSourceKeyFields

public java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> getSourceKeyFields()

INTERNAL: Return all the source key fields associated with the mapping.

getSourceRelationKeyFieldNames

public java.util.Vector getSourceRelationKeyFieldNames()

PUBLIC: Return the source relation key field names associated with the mapping. These are in-order with the sourceKeyFieldNames.

getSourceRelationKeyFields

public java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> getSourceRelationKeyFields()

INTERNAL: Return all the source relation key fields associated with the mapping.

getTargetKeyFieldNames

public java.util.Vector getTargetKeyFieldNames()

PUBLIC: Return the target key field names associated with the mapping. These are in-order with the targetRelationKeyFieldNames.

getTargetKeyFields

public java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> getTargetKeyFields()

INTERNAL: Return all the target keys associated with the mapping.

getTargetRelationKeyFieldNames

public java.util.Vector getTargetRelationKeyFieldNames()

PUBLIC: Return the target relation key field names associated with the mapping. These are in-order with the targetKeyFieldNames.

getTargetRelationKeyFields

public java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> getTargetRelationKeyFields()

INTERNAL: Return all the target relation key fields associated with the mapping.

hasCustomDeleteQuery

protected boolean hasCustomDeleteQuery()

hasCustomInsertQuery

protected boolean hasCustomInsertQuery()

hasDependency

public boolean hasDependency()

INTERNAL: The join table is a dependency if not read-only.

Overrides:

hasDependency in class DatabaseMapping

initialize

public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException

INTERNAL: Initialize mappings

Overrides:

initialize in class CollectionMapping

Throws:

DescriptorException

buildListOrderField

protected void buildListOrderField()

INTERNAL: Verifies listOrderField's table: it must be relation table. Precondition: listOrderField != null.

Overrides:

buildListOrderField in class CollectionMapping

shouldUseListOrderFieldTableExpression

public boolean shouldUseListOrderFieldTableExpression()

INTERNAL: Indicates whether getListOrderFieldExpression method should create field expression on table expression.

Overrides:

shouldUseListOrderFieldTableExpression in class CollectionMapping

initializeChangeOrderTargetQuery

protected void initializeChangeOrderTargetQuery(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Initialize changeOrderTargetQuery.

Overrides:

initializeChangeOrderTargetQuery in class CollectionMapping

initializeDeleteAllQuery

protected void initializeDeleteAllQuery(org.eclipse.persistence.internal.sessions.AbstractSession session)

Initialize delete all query. This query is used to all relevant rows from the relation table.

initializeListOrderFieldTable

protected void initializeListOrderFieldTable(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Initializes listOrderField's table. Precondition: listOrderField != null.

Overrides:

initializeListOrderFieldTable in class CollectionMapping

initializeSelectionCriteriaAndAddFieldsToQuery

protected void initializeSelectionCriteriaAndAddFieldsToQuery(Expression startCriteria)

INTERNAL: Selection criteria is created to read target records from the table.

insertAddedObjectEntry

protected void insertAddedObjectEntry(ObjectLevelModifyQuery query,
                                      java.lang.Object objectAdded,
                                      java.util.Map extraData)
                               throws DatabaseException,
                                      OptimisticLockException

INTERNAL: An object was added to the collection during an update, insert it.

Throws:

DatabaseException

OptimisticLockException

insertIntoRelationTable

public void insertIntoRelationTable(WriteObjectQuery query)
                             throws DatabaseException

INTERNAL: Insert into relation table. This follows following steps.

- Extract primary key and its value from the source object.

- Extract target key and its value from the target object.

- Construct a insert statement with above fields and values for relation table.

- execute the statement.

- Repeat above three statements until all the target objects are done.

Throws:

DatabaseException

insertTargetObjects

public void insertTargetObjects(WriteObjectQuery query)
                         throws DatabaseException,
                                OptimisticLockException

INTERNAL: Write the target objects if the cascade policy requires them to be written first. They must be written within a unit of work to ensure that they exist.

Throws:

DatabaseException

OptimisticLockException

isJoiningSupported

public boolean isJoiningSupported()

INTERNAL: Return if this mapping support joining.

Overrides:

isJoiningSupported in class ForeignReferenceMapping

isManyToManyMapping

public boolean isManyToManyMapping()

INTERNAL:

Overrides:

isManyToManyMapping in class DatabaseMapping

mustDeleteReferenceObjectsOneByOne

protected boolean mustDeleteReferenceObjectsOneByOne()

For Many To Many mappings referenced objects are deleted one by one.

Overrides:

mustDeleteReferenceObjectsOneByOne in class CollectionMapping

objectAddedDuringUpdate

protected void objectAddedDuringUpdate(ObjectLevelModifyQuery query,
                                       java.lang.Object objectAdded,
                                       org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                       java.util.Map extraData)
                                throws DatabaseException,
                                       OptimisticLockException

INTERNAL: An object was added to the collection during an update, insert it if private.

Overrides:

objectAddedDuringUpdate in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

objectRemovedDuringUpdate

protected void objectRemovedDuringUpdate(ObjectLevelModifyQuery query,
                                         java.lang.Object objectDeleted,
                                         java.util.Map extraData)
                                  throws DatabaseException,
                                         OptimisticLockException

INTERNAL: An object was removed to the collection during an update, delete it if private.

Overrides:

objectRemovedDuringUpdate in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

objectOrderChangedDuringUpdate

protected void objectOrderChangedDuringUpdate(WriteObjectQuery query,
                                              java.lang.Object orderChangedObject,
                                              int orderIndex)

Overrides:

objectOrderChangedDuringUpdate in class CollectionMapping

performDataModificationEvent

public void performDataModificationEvent(java.lang.Object[] event,
                                         org.eclipse.persistence.internal.sessions.AbstractSession session)
                                  throws DatabaseException,
                                         DescriptorException

INTERNAL: Perform the commit event. This is used in the uow to delay data modifications.

Overrides:

performDataModificationEvent in class DatabaseMapping

Throws:

DatabaseException

DescriptorException

postInsert

public void postInsert(WriteObjectQuery query)
                throws DatabaseException

INTERNAL: Insert into relation table. This follows following steps.

- Extract primary key and its value from the source object.

- Extract target key and its value from the target object.

- Construct a insert statement with above fields and values for relation table.

- execute the statement.

- Repeat above three statements until all the target objects are done.

Overrides:

postInsert in class CollectionMapping

Throws:

DatabaseException

postUpdate

public void postUpdate(WriteObjectQuery query)
                throws DatabaseException

INTERNAL: Update the relation table with the entries related to this mapping. Delete entries removed, insert entries added. If private also insert/delete/update target objects.

Overrides:

postUpdate in class DatabaseMapping

Throws:

DatabaseException

preDelete

public void preDelete(DeleteObjectQuery query)
               throws DatabaseException

INTERNAL: Delete entries related to this mapping from the relation table.

Overrides:

preDelete in class DatabaseMapping

Throws:

DatabaseException

prepareTranslationRow

protected void prepareTranslationRow(org.eclipse.persistence.internal.sessions.AbstractRecord translationRow,
                                     java.lang.Object object,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: The translation row may require additional fields than the primary key if the mapping in not on the primary key.

Overrides:

prepareTranslationRow in class CollectionMapping

setCustomDeleteQuery

public void setCustomDeleteQuery(DataModifyQuery query)

PUBLIC: The default delete query for mapping can be overridden by specifying the new query. This query must delete the row from the M-M join table.

setCustomInsertQuery

public void setCustomInsertQuery(DataModifyQuery query)

PUBLIC: The default insert query for mapping can be overridden by specifying the new query. This query must insert the row into the M-M join table.

setDeleteQuery

protected void setDeleteQuery(DataModifyQuery deleteQuery)

setDeleteSQLString

public void setDeleteSQLString(java.lang.String sqlString)

PUBLIC: Set the receiver's delete SQL string. This allows the user to override the SQL generated by TOPLink, with there own SQL or procedure call. The arguments are translated from the fields of the source row, through replacing the field names marked by '#' with the values for those fields. This is used to delete a single entry from the M-M join table. Example, 'delete from PROJ_EMP where PROJ_ID = #PROJ_ID AND EMP_ID = #EMP_ID'.

setDeleteCall

public void setDeleteCall(Call call)

PUBLIC: Set the receiver's delete Call. This allows the user to override the SQL generated by TOPLink, with there own SQL or procedure call. The arguments are translated from the fields of the source row. This is used to delete a single entry from the M-M join table. Example, 'new SQLCall("delete from PROJ_EMP where PROJ_ID = #PROJ_ID AND EMP_ID = #EMP_ID")'.

setInsertQuery

protected void setInsertQuery(DataModifyQuery insertQuery)

setInsertSQLString

public void setInsertSQLString(java.lang.String sqlString)

PUBLIC: Set the receiver's insert SQL string. This allows the user to override the SQL generated by TOPLink, with there own SQL or procedure call. The arguments are translated from the fields of the source row, through replacing the field names marked by '#' with the values for those fields. This is used to insert an entry into the M-M join table. Example, 'insert into PROJ_EMP (EMP_ID, PROJ_ID) values (#EMP_ID, #PROJ_ID)'.

setInsertCall

public void setInsertCall(Call call)

PUBLIC: Set the receiver's insert Call. This allows the user to override the SQL generated by TOPLink, with there own SQL or procedure call. The arguments are translated from the fields of the source row. This is used to insert an entry into the M-M join table. Example, 'new SQLCall("insert into PROJ_EMP (EMP_ID, PROJ_ID) values (#EMP_ID, #PROJ_ID)")'.

setRelationTable

public void setRelationTable(org.eclipse.persistence.internal.helper.DatabaseTable relationTable)

PUBLIC: Set the relational table. This is the join table that store both the source and target primary keys.

setHistoryPolicy

public void setHistoryPolicy(HistoryPolicy policy)

PUBLIC:

setRelationTableName

public void setRelationTableName(java.lang.String tableName)

PUBLIC: Set the name of the relational table. This is the join table that store both the source and target primary keys.

setSessionName

public void setSessionName(java.lang.String name)

PUBLIC: Set the name of the session to execute the mapping's queries under. This can be used by the session broker to override the default session to be used for the target class.

Overrides:

setSessionName in class CollectionMapping

setSourceKeyFieldNames

public void setSourceKeyFieldNames(java.util.Vector fieldNames)

PUBLIC: Set the source key field names associated with the mapping. These must be in-order with the sourceRelationKeyFieldNames.

setSourceKeyFields

public void setSourceKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> sourceKeyFields)

INTERNAL: Set the source fields.

setSourceRelationKeyFieldName

public void setSourceRelationKeyFieldName(java.lang.String sourceRelationKeyFieldName)

PUBLIC: Set the source key field in the relation table. This is the name of the foreign key in the relation table to the source's primary key field. This method is used if the source primary key is a singleton only.

setSourceRelationKeyFieldNames

public void setSourceRelationKeyFieldNames(java.util.Vector fieldNames)

PUBLIC: Set the source relation key field names associated with the mapping. These must be in-order with the sourceKeyFieldNames.

setSourceRelationKeyFields

public void setSourceRelationKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> sourceRelationKeyFields)

INTERNAL: Set the source fields.

setTargetKeyFieldNames

public void setTargetKeyFieldNames(java.util.Vector fieldNames)

INTERNAL: Set the target key field names associated with the mapping. These must be in-order with the targetRelationKeyFieldNames.

setTargetKeyFields

public void setTargetKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> targetKeyFields)

INTERNAL: Set the target fields.

setTargetRelationKeyFieldName

public void setTargetRelationKeyFieldName(java.lang.String targetRelationKeyFieldName)

PUBLIC: Set the target key field in the relation table. This is the name of the foreign key in the relation table to the target's primary key field. This method is used if the target's primary key is a singleton only.

setTargetRelationKeyFieldNames

public void setTargetRelationKeyFieldNames(java.util.Vector fieldNames)

INTERNAL: Set the target relation key field names associated with the mapping. These must be in-order with the targetKeyFieldNames.

setTargetRelationKeyFields

public void setTargetRelationKeyFields(java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> targetRelationKeyFields)

INTERNAL: Set the target fields.

prepareHistoricalQuery

protected ReadQuery prepareHistoricalQuery(ReadQuery targetQuery,
                                           ObjectBuildingQuery sourceQuery,
                                           org.eclipse.persistence.internal.sessions.AbstractSession executionSession)

INTERNAL: Append the temporal selection to the query selection criteria.

Overrides:

prepareHistoricalQuery in class ForeignReferenceMapping