Module org.eclipse.persistence.core

Package org.eclipse.persistence.eis.mappings

Class EISOneToManyMapping

java.lang.Object

org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,AbstractSession,ContainerPolicy,ClassDescriptor,DatabaseField>

org.eclipse.persistence.mappings.DatabaseMapping

org.eclipse.persistence.mappings.ForeignReferenceMapping

org.eclipse.persistence.mappings.CollectionMapping

org.eclipse.persistence.eis.mappings.EISOneToManyMapping

All Implemented Interfaces:

Serializable, Cloneable, EISMapping, ContainerMapping

public class EISOneToManyMapping
extends CollectionMapping
implements EISMapping

An EIS one-to-many mapping is a reference mapping that represents the relationship between a single source object and a collection of mapped persistent Java objects. The source object usually contains a foreign key (pointer) to the target objects (key on source); alternatively, the target objects may contain a foreign key to the source object (key on target). Because both the source and target objects use interactions, they must all be configured as root object types.

Record formats

Record Type	Description
Indexed	Ordered collection of record elements. The indexed record EIS format enables Java class attribute values to be retreived by position or index.
Mapped	Key-value map based representation of record elements. The mapped record EIS format enables Java class attribute values to be retreived by an object key.
XML	Record/Map representation of an XML DOM element.

Since:

Oracle TopLink 10g Release 2 (10.1.3)

See Also:

• EISDescriptor.useIndexedRecordFormat()
• EISDescriptor.useMappedRecordFormat()
• EISDescriptor.useXMLRecordFormat()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping

DatabaseMapping.WriteType

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseField	foreignKeyGroupingElement	The grouping-element field.
protected boolean	isForeignKeyRelationship	Keeps track if any of the fields are foreign keys.
protected List<DatabaseField>	sourceForeignKeyFields	The (typically primary) source key fields that are referenced by the targetForeignKeyFields.
protected Map<DatabaseField,DatabaseField>	sourceForeignKeysToTargetKeys	This maps the source foreign key fields to the corresponding (primary) target key fields.
protected List<DatabaseField>	targetForeignKeyFields	The target foreign key fields that reference the sourceKeyFields.

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

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

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

batchFetchType, cascadeDetach, cascadeMerge, cascadePersist, cascadeRefresh, cascadeRemove, forceInitializationOfSelectionCriteria, hasCustomSelectionQuery, indirectionPolicy, INNER_JOIN, isCascadeOnDeleteSetOnDatabase, isPrivateOwned, joinFetch, mappedBy, NONE, OUTER_JOIN, partitioningPolicy, partitioningPolicyName, QUERY_BATCH_PARAMETER, referenceClass, referenceClassName, referenceDescriptor, relationshipPartner, relationshipPartnerAttributeName, requiresTransientWeavedFields, selectionQuery, tempInitSession

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

attributeAccessor, attributeName, derivedIdMapping, derivesId, descriptor, fields, isCacheable, isInSopObject, isJPAId, isLazy, isMapKeyMapping, isOptional, isPrimaryKeyMapping, isReadOnly, isRemotelyInitialized, mapsIdValue, NO_FIELDS, NO_WEIGHT, properties, unconvertedProperties, weight, WEIGHT_AGGREGATE, WEIGHT_DIRECT, WEIGHT_TO_ONE, WEIGHT_TRANSFORM

Constructor Summary

Constructors

Constructor	Description
EISOneToManyMapping()

Method Summary

Modifier and Type	Method	Description
void	addForeignKeyField(DatabaseField sourceForeignKeyField, DatabaseField targetKeyField)	PUBLIC: Define the source foreign key relationship in the one-to-many mapping.
void	addForeignKeyFieldName(String sourceForeignKeyFieldName, String targetKeyFieldName)	PUBLIC: Define the source foreign key relationship in the one-to-many mapping.
Object	buildAddedElementFromChangeSet(Object changeSet, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Build and return a new element based on the change set.
Object	buildChangeSet(Object element, ObjectChangeSet owner, AbstractSession session)	INTERNAL: Build and return a change set for the specified element.
protected Object	buildElementFromChangeSet(Object changeSet, MergeManager mergeManager, AbstractSession targetSession)	Build and return a new element based on the change set.
Object	buildElementFromElement(Object element, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Build and return a new element based on the specified element.
Expression	buildExpression(Object queryObject, QueryByExamplePolicy policy, Expression expressionBuilder, Map processedObjects, AbstractSession session)	INTERNAL: In case Query By Example is used, this method builds and returns an expression that corresponds to a single attribute and it's value.
Object	buildRemovedElementFromChangeSet(Object changeSet, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: Build and return a new element based on the change set.
Object	clone()	INTERNAL: Clone the appropriate attributes.
protected Vector<DatabaseField>	collectFields()	Return all the fields mapped by the mapping.
boolean	compareElements(Object element1, Object element2, AbstractSession session)	INTERNAL: Compare the non-null elements and return true if they are alike.
boolean	compareElementsForChange(Object element1, Object element2, AbstractSession session)	INTERNAL: Compare the non-null elements and return true if they are alike.
ChangeRecord	compareForChange(Object clone, Object backup, ObjectChangeSet owner, AbstractSession session)	INTERNAL: Compare the changes between two collections.
boolean	compareObjects(Object object1, Object object2, AbstractSession session)	INTERNAL: Compare the attributes belonging to this mapping for the objects.
protected void	deleteAll(DeleteObjectQuery query)	Delete all the reference objects.
protected void	deleteAll(DeleteObjectQuery query, Object referenceObjects)	Delete all the reference objects.
protected void	deleteReferenceObjectsLeftOnDatabase(DeleteObjectQuery query)	This method will make sure that all the records privately owned by this mapping are actually removed.
protected AbstractRecord	extractKeyRowFromReferenceObject(Object object, AbstractSession session, AbstractRecord parentRecord)	Build and return a database row that contains a foreign key for the specified reference object.
ModifyQuery	getDeleteAllQuery()
DatabaseField	getForeignKeyGroupingElement()	Get the grouping element field on the mapping.
Vector	getForeignKeyRows(AbstractRecord row, AbstractSession session)	INTERNAL:
List<DatabaseField>	getSourceForeignKeyFields()	INTERNAL: Return the source foreign key fields.
Map<DatabaseField,DatabaseField>	getSourceForeignKeysToTargetKeys()	INTERNAL: Sets the target foreign key fields.
List<DatabaseField>	getTargetForeignKeyFields()	INTERNAL: Return the source foreign key fields.
boolean	hasCustomDeleteAllQuery()
boolean	hasInverseConstraintDependency()	INTERNAL: Return whether the mapping has any inverse constraint dependencies, such as foreign keys.
void	initialize(AbstractSession session)	INTERNAL: Initialize the mapping.
protected void	initializeDeleteAllQuery()	Initialize the delete all query.
protected void	initializeSelectionCriteria(AbstractSession session)	INTERNAL: Selection criteria is created with source foreign keys and target keys.
protected void	initializeSourceForeignKeysToTargetKeys()
boolean	isEISMapping()	INTERNAL:
boolean	isForeignKeyRelationship()	INTERNAL: Return if the 1-M mapping has a foreign key dependency to its target.
boolean	mapKeyHasChanged(Object element, AbstractSession session)	INTERNAL: Return whether the element's user-defined Map key has changed since it was cloned from the original version.
void	mergeChangesIntoObject(Object target, ChangeRecord chgRecord, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: If the mapping has a foreign key, it is order, so must use a different merge.
void	mergeIntoObject(Object target, boolean isTargetUnInitialized, Object source, MergeManager mergeManager, AbstractSession targetSession)	INTERNAL: If the mapping has a foreign key, it is order, so must use a different merge.
void	postDelete(DeleteObjectQuery query)	INTERNAL: Delete the reference objects.
void	postInsert(WriteObjectQuery query)	INTERNAL: Insert the reference objects.
void	postUpdate(WriteObjectQuery query)	INTERNAL: Update the reference objects.
void	preDelete(DeleteObjectQuery query)	INTERNAL: Delete the reference objects.
void	preInitialize(AbstractSession session)	Fix field names for XML data descriptors.
void	preInsert(WriteObjectQuery query)	INTERNAL: Insert privately owned parts
void	preUpdate(WriteObjectQuery query)	INTERNAL: Update the privately owned parts.
void	setDeleteAllCall(Call call)	PUBLIC: The default delete all call for this mapping can be overridden by specifying the new call.
void	setDeleteAllSQLString(String sqlString)	INTERNAL: This method is not supported in an EIS environment.
void	setForeignKeyGroupingElement(String name)	Set the grouping element field on the mapping.
void	setForeignKeyGroupingElement(DatabaseField field)	Set if the grouping element field on the mapping.
void	setIsForeignKeyRelationship(boolean isForeignKeyRelationship)	INTERNAL: Set if the 1-M mapping has a foreign key dependency to its target.
void	setSelectionSQLString(String sqlString)	INTERNAL: This method is not supported in an EIS environment.
void	setSourceForeignKeyFields(List<DatabaseField> fields)	INTERNAL: Sets the source foreign key fields.
void	setSourceForeignKeysToTargetKeys(Map<DatabaseField,DatabaseField> sourceToTargetKeyFields)	INTERNAL: Set the source keys to target keys fields association.
void	setTargetForeignKeyFields(List<DatabaseField> fields)	INTERNAL: Sets the target foreign key fields.
protected boolean	shouldObjectModifyCascadeToParts(ObjectLevelModifyQuery query)	Return whether any process leading to object modification should also affect its parts.
void	simpleAddToCollectionChangeRecord(Object referenceKey, Object changeSetToAdd, ObjectChangeSet changeSet, AbstractSession session)	ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
void	simpleRemoveFromCollectionChangeRecord(Object referenceKey, Object changeSetToRemove, ObjectChangeSet changeSet, AbstractSession session)	ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.
Object	valueFromRow(AbstractRecord row, JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, CacheKey cacheKey, AbstractSession executionSession, boolean isTargetProtected, Boolean[] wasCacheUsed)	INTERNAL: Return the value of the reference attribute or a value holder.
boolean	verifyDelete(Object object, AbstractSession session)	INTERNAL: Used to verify whether the specified object is deleted or not.
void	writeFromObjectIntoRow(Object object, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL: Get the appropriate attribute value from the object and put it in the appropriate field of the database row.
void	writeFromObjectIntoRowForShallowInsert(Object object, AbstractRecord row, AbstractSession session)	INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts.
void	writeFromObjectIntoRowForShallowInsertWithChangeRecord(ChangeRecord changeRecord, AbstractRecord row, AbstractSession session)	INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts.
void	writeFromObjectIntoRowForUpdate(WriteObjectQuery writeQuery, AbstractRecord row)	INTERNAL: If any of the references objects has changed, write out all the keys.
void	writeFromObjectIntoRowForUpdateAfterShallowInsert(Object object, AbstractRecord row, AbstractSession session, DatabaseTable table)	INTERNAL: This row is built for update after shallow insert which happens in case of bidirectional inserts.
void	writeFromObjectIntoRowWithChangeRecord(ChangeRecord changeRecord, AbstractRecord row, AbstractSession session, DatabaseMapping.WriteType writeType)	INTERNAL: Get the appropriate attribute value from the object and put it in the appropriate field of the database row.
void	writeInsertFieldsIntoRow(AbstractRecord row, AbstractSession session)	INTERNAL: Write fields needed for insert into the template for with null values.

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

addAggregateOrderBy, addAscendingOrdering, addDescendingOrdering, addOrderBy, buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildContainerClone, buildCopy, buildElementClone, buildElementUnitOfWorkClone, buildListOrderField, buildReferencesPKList, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cascadeRegisterNewIfRequired, collectQueryParameters, compareCollectionsForChange, compareLists, compareListsAndWrite, compareObjectsAndWrite, compareObjectsWithoutPrivateOwned, compareObjectsWithPrivateOwned, convertClassNamesToClasses, copyElement, executeBatchQuery, extractKeyFromTargetRow, extractResultFromBatchQuery, fixRealObjectReferences, getAdditionalFieldsBaseExpression, getContainerPolicy, getJoinCriteria, getListOrderField, getObjectCorrespondingTo, getOrderByQueryKeyExpressions, getOrderCorrectionType, getRealCollectionAttributeValueFromObject, getSelectionQueryContainerPolicy, getTargetPrimaryKeyFields, hasOrderBy, initializeChangeOrderTargetQuery, initializeListOrderField, initializeListOrderFieldTable, isAttributeValueInstantiatedOrChanged, isChangeTrackingSupported, isCollectionMapping, isListOrderFieldSupported, isMapKeyObjectRelationship, iterateOnElement, iterateOnRealAttributeValue, load, loadAll, mustDeleteReferenceObjectsOneByOne, objectAddedDuringUpdate, objectOrderChangedDuringUpdate, objectRemovedDuringUpdate, objectUnchangedDuringUpdate, objectUnchangedDuringUpdate, postCalculateChanges, postInitialize, postPrepareNestedBatchQuery, prepareTranslationRow, readPrivateOwnedForObject, recordPrivateOwnedRemovals, replaceValueHoldersIn, setChangeListener, setContainerPolicy, setCustomDeleteAllQuery, setDeleteAllQuery, setHasCustomDeleteAllQuery, setListOrderField, setListOrderFieldName, setMustDeleteReferenceObjectsOneByOne, setOrderCorrectionType, setSelectionQueryContainerPolicy, setSessionName, setUseLazyInstantiationForIndirectCollection, shouldUseLazyInstantiationForIndirectCollection, shouldUseListOrderFieldTableExpression, updateChangeRecord, updateChangeRecordForSelfMerge, updateCollectionChangeRecord, useCollectionClass, useCollectionClassName, useListClassName, useMapClass, useMapClass, useMapClassName, useSortedSetClass, useSortedSetClassName, useSortedSetClassName, useTransparentCollection, useTransparentList, useTransparentMap, useTransparentSet, validateBeforeInitialization, valueFromPKList, valueFromRowInternalWithJoin, writeChanges

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

addTargetForeignKeyField, batchedValueFromRow, buildBackupClone, buildBatchCriteria, buildClone, buildCloneFromRow, checkCacheForBatchKey, createCloneValueHolder, dontDoMerge, dontUseBatchReading, dontUseIndirection, extendPessimisticLockScopeInSourceQuery, extendPessimisticLockScopeInTargetQuery, extractBatchKeyFromRow, fixObjectReferences, getAttributeValueFromObject, getAttributeValueWithClonedValueHolders, getBatchFetchType, getExtendPessimisticLockScopeDedicatedQuery, getFieldsForTranslationInAggregate, getIndirectionPolicy, getJoinFetch, getMappedBy, getOrderByNormalizedExpressions, getPartitioningPolicy, getPartitioningPolicyName, getRealAttributeValueFromAttribute, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationshipPartner, getRelationshipPartnerAttributeName, getSelectionCriteria, getSelectionQuery, getTempSession, getValueFromRemoteValueHolder, hasCustomSelectionQuery, hasDependency, hasNestedIdentityReference, initializeReferenceDescriptor, initializeSelectionQuery, instantiateAttribute, isAttributeValueFromObjectInstantiated, isAttributeValueFullyBuilt, isAttributeValueInstantiated, isCascadeDetach, isCascadeMerge, isCascadeOnDeleteSetOnDatabase, isCascadePersist, isCascadeRefresh, isCascadeRemove, isExtendingPessimisticLockScope, isForeignReferenceMapping, isInnerJoinFetched, isJoinFetched, isJoiningSupported, isLazy, isLockableMapping, isOuterJoinFetched, isPrivateOwned, iterate, mergeRemoteValueHolder, prepareHistoricalQuery, prepareNestedBatchQuery, prepareNestedJoinQueryClone, prepareNestedJoins, privateOwnedRelationship, readFromRowIntoObject, remoteInitialization, requiresTransientWeavedFields, setBatchFetchType, setCascadeAll, setCascadeDetach, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setCustomSelectionQuery, setForceInitializationOfSelectionCriteria, setHasCustomSelectionQuery, setIndirectionPolicy, setIsCacheable, setIsCascadeOnDeleteSetOnDatabase, setIsPrivateOwned, setJoinFetch, setMappedBy, setPartitioningPolicy, setPartitioningPolicyName, setRealAttributeValueInObject, setReferenceClass, setReferenceClassName, setReferenceDescriptor, setRelationshipPartner, setRelationshipPartnerAttributeName, setRequiresTransientWeavedFields, setSelectionCall, setSelectionCriteria, setSelectionQuery, setShouldExtendPessimisticLockScope, setTempSession, setUsesBatchReading, setUsesIndirection, shouldExtendPessimisticLockScope, shouldExtendPessimisticLockScopeInDedicatedQuery, shouldExtendPessimisticLockScopeInSourceQuery, shouldExtendPessimisticLockScopeInTargetQuery, shouldForceInitializationOfSelectionCriteria, shouldInitializeSelectionCriteria, shouldMergeCascadeParts, shouldMergeCascadeReference, shouldRefreshCascadeParts, shouldUseBatchReading, shouldUseValueFromRowWithJoin, trimRowForJoin, trimRowForJoin, useBasicIndirection, useBatchReading, useContainerIndirection, useInnerJoinFetch, useOuterJoinFetch, usesIndirection, useWeavedIndirection, valueFromRowInternal, valueFromRowInternal

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

addUnconvertedProperty, buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, cloneFields, convertConverterClassNamesToClasses, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, getAttributeAccessor, getAttributeClassification, getAttributeName, getDerivedIdMapping, getDescriptor, getField, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getProperties, getProperty, getRealAttributeValueFromObject, getSelectFields, getSelectTables, getSetMethodName, getUnconvertedProperties, getWeight, hasConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isCloningRequired, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isElementCollectionMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJPAId, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isOwned, isPrimaryKeyMapping, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, performDataModificationEvent, postCalculateChangesOnDeleted, postInitializeSourceAndTargetExpressions, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readOnly, readWrite, rehashFieldDependancies, remotelyInitialized, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsInAndOutSopObject, setIsInSopObject, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsOutSopObject, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setSetMethodName, setWeight, toString, validateAfterInitialization, valueFromObject, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Field Details

isForeignKeyRelationship

protected boolean isForeignKeyRelationship

Keeps track if any of the fields are foreign keys.

targetForeignKeyFields

protected transient List<DatabaseField> targetForeignKeyFields

The target foreign key fields that reference the sourceKeyFields.

sourceForeignKeyFields

protected transient List<DatabaseField> sourceForeignKeyFields

The (typically primary) source key fields that are referenced by the targetForeignKeyFields.

sourceForeignKeysToTargetKeys

protected transient Map<DatabaseField,DatabaseField> sourceForeignKeysToTargetKeys

This maps the source foreign key fields to the corresponding (primary) target key fields.

foreignKeyGroupingElement

protected DatabaseField foreignKeyGroupingElement

The grouping-element field.

Constructor Details

EISOneToManyMapping

public EISOneToManyMapping()

Method Details

isEISMapping

public boolean isEISMapping()

INTERNAL:

Overrides:

isEISMapping in class DatabaseMapping

addForeignKeyField

public void addForeignKeyField(DatabaseField sourceForeignKeyField,
 DatabaseField targetKeyField)

PUBLIC: Define the source foreign key relationship in the one-to-many mapping. This method is used for composite source foreign key relationships. That is, the source object's table has multiple foreign key fields that are references to the target object's (typically primary) key fields. Both the source foreign key field name and the corresponding target primary key field name must be specified.

Overrides:

addForeignKeyField in class ForeignReferenceMapping

addForeignKeyFieldName

public void addForeignKeyFieldName(String sourceForeignKeyFieldName,
 String targetKeyFieldName)

PUBLIC: Define the source foreign key relationship in the one-to-many mapping. This method is used for composite source foreign key relationships. That is, the source object's table has multiple foreign key fields that are references to the target object's (typically primary) key fields. Both the source foreign key field name and the corresponding target primary key field name must be specified.

isForeignKeyRelationship

public boolean isForeignKeyRelationship()

INTERNAL: Return if the 1-M mapping has a foreign key dependency to its target. This is true if any of the foreign key fields are true foreign keys, i.e. populated on write from the targets primary key.

setIsForeignKeyRelationship

public void setIsForeignKeyRelationship(boolean isForeignKeyRelationship)

INTERNAL: Set if the 1-M mapping has a foreign key dependency to its target. This is true if any of the foreign key fields are true foreign keys, i.e. populated on write from the targets primary key.

getForeignKeyGroupingElement

public DatabaseField getForeignKeyGroupingElement()

Get the grouping element field on the mapping. This is an optional setting.

setForeignKeyGroupingElement

public void setForeignKeyGroupingElement(String name)

Set the grouping element field on the mapping. This is an optional setting; however it is a required setting when there are more than one foreign keys specified

hasCustomDeleteAllQuery

public boolean hasCustomDeleteAllQuery()

Overrides:

hasCustomDeleteAllQuery in class CollectionMapping

getDeleteAllQuery

public ModifyQuery getDeleteAllQuery()

Overrides:

getDeleteAllQuery in class CollectionMapping

setDeleteAllCall

public void setDeleteAllCall(Call call)

PUBLIC: The default delete all call for this mapping can be overridden by specifying the new call. This call is responsible for doing the deletion required by the mapping, such as optimized delete all of target objects for 1-M.

Overrides:

setDeleteAllCall in class CollectionMapping

setForeignKeyGroupingElement

public void setForeignKeyGroupingElement(DatabaseField field)

Set if the grouping element field on the mapping. This is an optional setting; however it is a required setting when there are more than one foreign keys specified.

getSourceForeignKeyFields

public List<DatabaseField> getSourceForeignKeyFields()

INTERNAL: Return the source foreign key fields.

setSourceForeignKeyFields

public void setSourceForeignKeyFields(List<DatabaseField> fields)

INTERNAL: Sets the source foreign key fields.

getTargetForeignKeyFields

public List<DatabaseField> getTargetForeignKeyFields()

INTERNAL: Return the source foreign key fields.

setTargetForeignKeyFields

public void setTargetForeignKeyFields(List<DatabaseField> fields)

INTERNAL: Sets the target foreign key fields.

getSourceForeignKeysToTargetKeys

public Map<DatabaseField,DatabaseField> getSourceForeignKeysToTargetKeys()

INTERNAL: Sets the target foreign key fields.

setSourceForeignKeysToTargetKeys

public void setSourceForeignKeysToTargetKeys(Map<DatabaseField,DatabaseField> sourceToTargetKeyFields)

INTERNAL: Set the source keys to target keys fields association.

hasInverseConstraintDependency

public boolean hasInverseConstraintDependency()

INTERNAL: Return whether the mapping has any inverse constraint dependencies, such as foreign keys.

Overrides:

hasInverseConstraintDependency in class DatabaseMapping

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

INTERNAL: Initialize the mapping.

Overrides:

initialize in class CollectionMapping

Throws:

DescriptorException

initializeSelectionCriteria

protected void initializeSelectionCriteria(AbstractSession session)

INTERNAL: Selection criteria is created with source foreign keys and target keys. This criteria is then used to read target records from the table. CR#3922 - This method is almost the same as buildSelectionCriteria() the difference is that getSelectionCriteria() is called

initializeSourceForeignKeysToTargetKeys

protected void initializeSourceForeignKeysToTargetKeys()
                                                throws DescriptorException

Throws:

DescriptorException

initializeDeleteAllQuery

protected void initializeDeleteAllQuery()

Initialize the delete all query. This query is used to delete the collection of objects from the database.

preInitialize

public void preInitialize(AbstractSession session)

Fix field names for XML data descriptors. Since fields are fixed to use text() by default in descriptor, ensure the correct non text field is used here.

Overrides:

preInitialize in class ForeignReferenceMapping

shouldObjectModifyCascadeToParts

protected boolean shouldObjectModifyCascadeToParts(ObjectLevelModifyQuery query)

Return whether any process leading to object modification should also affect its parts. Used by write, insert, update, and delete.

Overrides:

shouldObjectModifyCascadeToParts in class ForeignReferenceMapping

verifyDelete

public boolean verifyDelete(Object object,
 AbstractSession session)
                     throws DatabaseException

INTERNAL: Used to verify whether the specified object is deleted or not.

Overrides:

verifyDelete in class CollectionMapping

Throws:

DatabaseException

postInsert

public void postInsert(WriteObjectQuery query)
                throws DatabaseException,
OptimisticLockException

INTERNAL: Insert the reference objects.

Overrides:

postInsert in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

postUpdate

public void postUpdate(WriteObjectQuery query)
                throws DatabaseException,
OptimisticLockException

INTERNAL: Update the reference objects.

Overrides:

postUpdate in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

postDelete

public void postDelete(DeleteObjectQuery query)
                throws DatabaseException,
OptimisticLockException

INTERNAL: Delete the reference objects.

Overrides:

postDelete in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

preDelete

public void preDelete(DeleteObjectQuery query)
               throws DatabaseException,
OptimisticLockException

INTERNAL: Delete the reference objects.

Overrides:

preDelete in class DatabaseMapping

Throws:

DatabaseException

OptimisticLockException

preInsert

public void preInsert(WriteObjectQuery query)
               throws DatabaseException,
OptimisticLockException

INTERNAL: Insert privately owned parts

Overrides:

preInsert in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

preUpdate

public void preUpdate(WriteObjectQuery query)
               throws DatabaseException,
OptimisticLockException

INTERNAL: Update the privately owned parts.

Overrides:

preUpdate in class CollectionMapping

Throws:

DatabaseException

OptimisticLockException

buildAddedElementFromChangeSet

public Object buildAddedElementFromChangeSet(Object changeSet,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: Build and return a new element based on the change set.

buildChangeSet

public Object buildChangeSet(Object element,
 ObjectChangeSet owner,
 AbstractSession session)

INTERNAL: Build and return a change set for the specified element.

buildElementFromChangeSet

protected Object buildElementFromChangeSet(Object changeSet,
 MergeManager mergeManager,
 AbstractSession targetSession)

Build and return a new element based on the change set.

buildElementFromElement

public Object buildElementFromElement(Object element,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: Build and return a new element based on the specified element.

buildExpression

public Expression buildExpression(Object queryObject,
 QueryByExamplePolicy policy,
 Expression expressionBuilder,
 Map processedObjects,
 AbstractSession session)

INTERNAL: In case Query By Example is used, this method builds and returns an expression that corresponds to a single attribute and it's value.

Overrides:

buildExpression in class CollectionMapping

Parameters:

queryObject - TODO

policy - TODO

expressionBuilder - TODO

processedObjects - TODO

session - TODO

Returns:

TODO

buildRemovedElementFromChangeSet

public Object buildRemovedElementFromChangeSet(Object changeSet,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: Build and return a new element based on the change set.

clone

public Object clone()

INTERNAL: Clone the appropriate attributes.

Overrides:

clone in class CollectionMapping

Returns:

new instance of itself

collectFields

protected Vector<DatabaseField> collectFields()

Return all the fields mapped by the mapping.

Overrides:

collectFields in class DatabaseMapping

Returns:

TODO

compareElements

public boolean compareElements(Object element1,
 Object element2,
 AbstractSession session)

INTERNAL: Compare the non-null elements and return true if they are alike.

mapKeyHasChanged

public boolean mapKeyHasChanged(Object element,
 AbstractSession session)

INTERNAL: Return whether the element's user-defined Map key has changed since it was cloned from the original version. Object elements can change their keys without detection. Get the original object and compare keys.

compareElementsForChange

public boolean compareElementsForChange(Object element1,
 Object element2,
 AbstractSession session)

INTERNAL: Compare the non-null elements and return true if they are alike. Here we use object identity.

compareForChange

public ChangeRecord compareForChange(Object clone,
 Object backup,
 ObjectChangeSet owner,
 AbstractSession session)

INTERNAL: Compare the changes between two collections. Element comparisons are made using identity and, when appropriate, the value of the element's key for the Map container.

Overrides:

compareForChange in class CollectionMapping

Parameters:

clone - TODO

backup - TODO

owner - TODO

session - TODO

Returns:

prototype.changeset.ChangeRecord TODO

compareObjects

public boolean compareObjects(Object object1,
 Object object2,
 AbstractSession session)

INTERNAL: Compare the attributes belonging to this mapping for the objects.

Overrides:

compareObjects in class CollectionMapping

Parameters:

object1 - TODO

object2 - TODO

session - TODO

Returns:

TODO

mergeChangesIntoObject

public void mergeChangesIntoObject(Object target,
 ChangeRecord chgRecord,
 Object source,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: If the mapping has a foreign key, it is order, so must use a different merge.

Overrides:

mergeChangesIntoObject in class CollectionMapping

mergeIntoObject

public void mergeIntoObject(Object target,
 boolean isTargetUnInitialized,
 Object source,
 MergeManager mergeManager,
 AbstractSession targetSession)

INTERNAL: If the mapping has a foreign key, it is order, so must use a different merge.

Overrides:

mergeIntoObject in class CollectionMapping

simpleAddToCollectionChangeRecord

public void simpleAddToCollectionChangeRecord(Object referenceKey,
 Object changeSetToAdd,
 ObjectChangeSet changeSet,
 AbstractSession session)

ADVANCED: This method is used to have an object add to a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.

Overrides:

simpleAddToCollectionChangeRecord in class CollectionMapping

simpleRemoveFromCollectionChangeRecord

public void simpleRemoveFromCollectionChangeRecord(Object referenceKey,
 Object changeSetToRemove,
 ObjectChangeSet changeSet,
 AbstractSession session)

ADVANCED: This method is used to have an object removed from a collection once the changeSet is applied The referenceKey parameter should only be used for direct Maps.

Overrides:

simpleRemoveFromCollectionChangeRecord in class CollectionMapping

deleteAll

protected void deleteAll(DeleteObjectQuery query,
 Object referenceObjects)
                  throws DatabaseException

Delete all the reference objects.

Throws:

DatabaseException

deleteAll

protected void deleteAll(DeleteObjectQuery query)
                  throws DatabaseException

Delete all the reference objects.

Throws:

DatabaseException

deleteReferenceObjectsLeftOnDatabase

protected void deleteReferenceObjectsLeftOnDatabase(DeleteObjectQuery query)
                                             throws DatabaseException,
OptimisticLockException

This method will make sure that all the records privately owned by this mapping are actually removed. If such records are found then those are all read and removed one by one along with their privately owned parts.

Throws:

DatabaseException

OptimisticLockException

extractKeyRowFromReferenceObject

protected AbstractRecord extractKeyRowFromReferenceObject(Object object,
 AbstractSession session,
 AbstractRecord parentRecord)

Build and return a database row that contains a foreign key for the specified reference object. This will be stored in the nested row(s).

valueFromRow

public Object valueFromRow(AbstractRecord row,
 JoinedAttributeManager joinManager,
 ObjectBuildingQuery sourceQuery,
 CacheKey cacheKey,
 AbstractSession executionSession,
 boolean isTargetProtected,
 Boolean[] wasCacheUsed)
                    throws DatabaseException

INTERNAL: Return the value of the reference attribute or a value holder. Check whether the mapping's attribute should be optimized through batch and joining.

Overrides:

valueFromRow in class ForeignReferenceMapping

Throws:

DatabaseException

getForeignKeyRows

public Vector getForeignKeyRows(AbstractRecord row,
 AbstractSession session)

INTERNAL:

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
 AbstractRecord row,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)

INTERNAL: Get the appropriate attribute value from the object and put it in the appropriate field of the database row. Loop through the reference objects and extract the primary keys and put them in the vector of "nested" rows.

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

writeFromObjectIntoRowForShallowInsert

public void writeFromObjectIntoRowForShallowInsert(Object object,
 AbstractRecord row,
 AbstractSession session)

INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts. The foreign keys must be set to null to avoid constraints.

Overrides:

writeFromObjectIntoRowForShallowInsert in class DatabaseMapping

writeFromObjectIntoRowForUpdateAfterShallowInsert

public void writeFromObjectIntoRowForUpdateAfterShallowInsert(Object object,
 AbstractRecord row,
 AbstractSession session,
 DatabaseTable table)

INTERNAL: This row is built for update after shallow insert which happens in case of bidirectional inserts. It contains the foreign keys with non null values that were set to null for shallow insert. If mapping overrides writeFromObjectIntoRowForShallowInsert method it must override this one, too.

Overrides:

writeFromObjectIntoRowForUpdateAfterShallowInsert in class DatabaseMapping

writeFromObjectIntoRowForShallowInsertWithChangeRecord

public void writeFromObjectIntoRowForShallowInsertWithChangeRecord(ChangeRecord changeRecord,
 AbstractRecord row,
 AbstractSession session)

INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts. The foreign keys must be set to null to avoid constraints.

Overrides:

writeFromObjectIntoRowForShallowInsertWithChangeRecord in class DatabaseMapping

writeFromObjectIntoRowForUpdate

public void writeFromObjectIntoRowForUpdate(WriteObjectQuery writeQuery,
 AbstractRecord row)
                                     throws DescriptorException

INTERNAL: If any of the references objects has changed, write out all the keys.

Overrides:

writeFromObjectIntoRowForUpdate in class DatabaseMapping

Throws:

DescriptorException

writeFromObjectIntoRowWithChangeRecord

public void writeFromObjectIntoRowWithChangeRecord(ChangeRecord changeRecord,
 AbstractRecord row,
 AbstractSession session,
 DatabaseMapping.WriteType writeType)

INTERNAL: Get the appropriate attribute value from the object and put it in the appropriate field of the database row. Loop through the reference objects and extract the primary keys and put them in the vector of "nested" rows.

Overrides:

writeFromObjectIntoRowWithChangeRecord in class DatabaseMapping

writeInsertFieldsIntoRow

public void writeInsertFieldsIntoRow(AbstractRecord row,
 AbstractSession session)

INTERNAL: Write fields needed for insert into the template for with null values.

Overrides:

writeInsertFieldsIntoRow in class DatabaseMapping

setSelectionSQLString

public void setSelectionSQLString(String sqlString)

INTERNAL: This method is not supported in an EIS environment.

Overrides:

setSelectionSQLString in class ForeignReferenceMapping

setDeleteAllSQLString

public void setDeleteAllSQLString(String sqlString)

INTERNAL: This method is not supported in an EIS environment.

Overrides:

setDeleteAllSQLString in class CollectionMapping