DirectMapMapping (EclipseLink 2.6.7, API Reference)

java.lang.Object
- org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,org.eclipse.persistence.internal.sessions.AbstractSession,org.eclipse.persistence.internal.queries.ContainerPolicy,ClassDescriptor,org.eclipse.persistence.internal.helper.DatabaseField>
- - org.eclipse.persistence.mappings.DatabaseMapping
  - - org.eclipse.persistence.mappings.ForeignReferenceMapping
    - - org.eclipse.persistence.mappings.CollectionMapping
      - org.eclipse.persistence.mappings.DirectCollectionMapping
        
        org.eclipse.persistence.mappings.DirectMapMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ContainerMapping, MapComponentMapping, RelationalMapping
```
public class DirectMapMapping
extends DirectCollectionMapping
implements MapComponentMapping
```
Mapping for a collection of key-value pairs. The key and value must be simple types (String, Number, Date, etc.) and stored in a single table along with a foreign key to the source object. A converter can be used on the key and value if the desired object types do not match the data types.

See Also:
Converter, ObjectTypeConverter, TypeConversionConverter, SerializedObjectConverter, Serialized Form
Since:

TopLink 3.5

Nested Class Summary
- Nested classes/interfaces inherited from class org.eclipse.persistence.mappings.DatabaseMapping
  DatabaseMapping.WriteType

Field Summary
- Fields inherited from class org.eclipse.persistence.mappings.DirectCollectionMapping
  attributeClassification, attributeClassificationName, changeSetDeleteNullQuery, changeSetDeleteQuery, Delete, DeleteAll, DeleteAtIndex, deleteAtIndexQuery, directField, hasCustomDeleteAtIndexQuery, hasCustomDeleteQuery, hasCustomInsertQuery, hasCustomUpdateAtIndexQuery, historyPolicy, Insert, insertQuery, orderByExpressions, referenceKeyFields, referenceTable, sourceKeyFields, UpdateAtIndex, updateAtIndexQuery, valueConverter, valueConverterClassName
- 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 and Description

DirectMapMapping()
DirectMapCollectionMapping constructor

Constructors
Constructor and Description
`DirectMapMapping()` DirectMapCollectionMapping constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToCollectionChangeRecord(java.lang.Object newKey, java.lang.Object newValue, org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Add a new value and its change set to the collection change record.
`java.lang.Object`	`buildCloneForPartObject(java.lang.Object attributeValue, java.lang.Object original, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, java.lang.Object clone, org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, java.lang.Integer refreshCascade, boolean isExisting, boolean isFromSharedCache)` INTERNAL: Require for cloning, the part must be cloned.
`void`	`calculateDeferredChanges(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Used by AttributeLevelChangeTracking to update a changeRecord with calculated changes as opposed to detected changes.
`void`	`cascadeDiscoverAndPersistUnregisteredNewObjects(java.lang.Object object, java.util.Map newObjects, java.util.Map unregisteredExistingObjects, java.util.Map visitedObjects, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Set cascadeErrors)` INTERNAL: Cascade discover and persist new objects during commit.
`void`	`cascadePerformRemoveIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade perform delete through mappings that require the cascade
`void`	`cascadeRegisterNewIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects)` INTERNAL: Cascade registerNew for Create through mappings that require the cascade
`void`	`compareCollectionsForChange(java.lang.Object oldCollection, java.lang.Object newCollection, org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: This method is used to calculate the differences between two collections.
`org.eclipse.persistence.internal.sessions.ChangeRecord`	`compareForChange(java.lang.Object clone, java.lang.Object backUp, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: This method compares the changes between two direct collections.
`boolean`	`compareObjects(java.lang.Object firstObject, java.lang.Object secondObject, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Compare the attributes belonging to this mapping for the objects.
`void`	`convertClassNamesToClasses(java.lang.ClassLoader classLoader)` INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.
`java.lang.Object`	`createMapComponentFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow, ObjectBuildingQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, org.eclipse.persistence.internal.sessions.AbstractSession session, boolean isTargetProtected)` INTERNAL Called when a DatabaseMapping is used to map the key in a collection.
`protected void`	`executeBatchQuery(DatabaseQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, java.util.Map referenceDataByKey, org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)` INTERNAL: Prepare and execute the batch query and store the results for each source object in a map keyed by the mappings source keys of the source objects.
`org.eclipse.persistence.internal.helper.DatabaseField`	`getDirectKeyField()` INTERNAL:
`java.lang.Class`	`getKeyClass()` PUBLIC: This is a helper method to get the object class from the key converter if it is a TypeConversionConverter.
`Converter`	`getKeyConverter()` PUBLIC: Return the converter on the mapping.
`java.lang.Class`	`getValueClass()` PUBLIC: This is a helper method to get the object class from the value converter if it is a TypeConversionConverter.
`void`	`initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Initialize and validate the mapping properties.
`protected void`	`initializeDeleteQuery(org.eclipse.persistence.internal.sessions.AbstractSession session)`
`protected void`	`initializeInsertQuery(org.eclipse.persistence.internal.sessions.AbstractSession session)` Initialize insert query.
`protected void`	`initializeSelectionStatement(org.eclipse.persistence.internal.sessions.AbstractSession session)`
`protected void`	`initOrRebuildSelectQuery()` INTERNAL: Rebuild select query.
`boolean`	`isDirectMapMapping()` INTERNAL: Related mapping should implement this method to return true.
`void`	`iterateOnElement(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator, java.lang.Object element)` INTERNAL: Iterate on the specified element.
`void`	`iterateOnRealAttributeValue(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator, java.lang.Object realAttributeValue)` INTERNAL: Iterate on the attribute value.
`void`	`mergeChangesIntoObject(java.lang.Object target, org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, java.lang.Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Merge changes from the source to the target object.
`void`	`mergeIntoObject(java.lang.Object target, boolean isTargetUnInitialized, java.lang.Object source, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession)` INTERNAL: Merge changes from the source to the target object.
`void`	`performDataModificationEvent(java.lang.Object[] event, org.eclipse.persistence.internal.sessions.AbstractSession session)` INTERNAL: Perform the commit event.
`void`	`postCalculateChanges(ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Overridden by mappings that require additional processing of the change record after the record has been calculated.
`void`	`postInsert(WriteObjectQuery query)` INTERNAL: Insert the private owned object.
`protected void`	`postUpdateWithChangeSet(WriteObjectQuery writeQuery)` INTERNAL: Update private owned part.
`void`	`preDelete(DeleteObjectQuery query)` INTERNAL: Propagate the preDelete event through the container policy if necessary
`void`	`recordPrivateOwnedRemovals(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Overridden by mappings that require additional processing of the change record after the record has been calculated.
`protected void`	`removeFromCollectionChangeRecord(java.lang.Object newKey, java.lang.Object newValue, org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Remove a value and its change set from the collection change record.
`void`	`setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)` ADVANCED: Configure the mapping to use a container policy.
`void`	`setDirectKeyField(org.eclipse.persistence.internal.helper.DatabaseField keyField)` INTERNAL:
`void`	`setDirectKeyFieldClassification(java.lang.Class fieldType)` ADVANCED: Set the class type of the field value.
`void`	`setDirectKeyFieldClassificationName(java.lang.String fieldTypeName)` ADVANCED: Set the class type name of the field value.
`void`	`setDirectKeyFieldName(java.lang.String fieldName)` PUBLIC: Set the direct key field name in the reference table.
`void`	`setKeyClass(java.lang.Class keyClass)` PUBLIC: This is a helper method to set the key converter to a TypeConversionConverter.
`void`	`setKeyConverter(Converter keyConverter)` PUBLIC: Set the converter on the mapping.
`void`	`setKeyConverterClassName(java.lang.String keyConverterClassName)` INTERNAL: Set the converter class name on the mapping.
`void`	`setValueClass(java.lang.Class valueClass)` PUBLIC: This is a helper method to set the value converter to a TypeConversionConverter.
`void`	`simpleAddToCollectionChangeRecord(java.lang.Object referenceKey, java.lang.Object objectToAdd, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.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(java.lang.Object referenceKey, java.lang.Object objectToRemove, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.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.
`void`	`updateChangeRecord(java.lang.Object clone, java.lang.Object newValue, java.lang.Object oldValue, org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Either create a new change record or update the change record with the new value.
`void`	`updateCollectionChangeRecord(CollectionChangeEvent event, org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)` INTERNAL: Add or removes a new value and its change set to the collection change record based on the event passed in.
`void`	`useMapClass(java.lang.Class concreteClass)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useTransparentMap()` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`protected java.lang.Object`	`valueFromRowInternalWithJoin(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected)` INTERNAL: Return the value of the field from the row or a value holder on the query to obtain the object.

Methods inherited from class org.eclipse.persistence.mappings.DirectCollectionMapping
addAscendingOrdering, addDescendingOrdering, addOrdering, addReferenceKeyField, addReferenceKeyFieldName, buildBatchCriteria, buildCopy, buildElementClone, buildExpression, buildListOrderField, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, clone, collectQueryParameters, compareLists, compareListsForChange, createWhereClauseForDeleteNullQuery, createWhereClauseForDeleteQuery, extractBatchKeyFromRow, extractKeyFromTargetRow, fixRealObjectReferences, getAdditionalFieldsBaseExpression, getAttributeClassification, getAttributeClassificationName, getDeleteAtIndexQuery, getDeleteNullQuery, getDeleteQuery, getDirectField, getDirectFieldName, getFieldsForTranslationInAggregate, getFieldValue, getHistoryPolicy, getInsertQuery, getJoinCriteria, getObjectCorrespondingTo, getOrderByExpressions, getOrderByNormalizedExpressions, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getReferenceKeyFieldNames, getReferenceKeyFields, getReferenceTable, getReferenceTableName, getReferenceTableQualifiedName, getRelationshipPartner, getSelectFields, getSelectionQueryContainerPolicy, getSelectTables, getSourceKeyFieldNames, getSourceKeyFields, getUpdateAtIndexQuery, getValueConverter, hasCustomDeleteAtIndexQuery, hasCustomDeleteQuery, hasCustomInsertQuery, hasCustomUpdateAtIndexQuery, hasNestedIdentityReference, initializeDeleteAllQuery, initializeDeleteAtIndexQuery, initializeDeleteNullQuery, initializeDirectField, initializeListOrderField, initializeReferenceDescriptor, initializeReferenceKeys, initializeReferenceTable, initializeSelectionCriteria, initializeSelectionQuery, initializeSourceKeys, initializeSourceKeysWithDefaults, initializeUpdateAtIndexQuery, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isDirectCollectionMapping, isElementCollectionMapping, isJoiningSupported, isKeyForSourceSpecified, isLockableMapping, isOwned, isRelationalMapping, mergeAddRemoveChanges, postUpdate, postUpdateWithChangeSetListOrder, prepareNestedBatchQuery, prepareNestedJoins, prepareTranslationRow, remoteInitialization, replaceValueHoldersIn, setAttributeClassification, setAttributeClassificationName, setCustomDeleteAtIndexQuery, setCustomDeleteQuery, setCustomInsertQuery, setCustomUpdateAtIndexQuery, setDeleteQuery, setDeleteSQLString, setDirectField, setDirectFieldClassification, setDirectFieldClassificationName, setDirectFieldName, setHasCustomDeleteQuery, setHasCustomInsertQuery, setHistoryPolicy, setInsertQuery, setInsertSQLString, setReferenceClass, setReferenceClassName, setReferenceKeyFieldName, setReferenceKeyFieldNames, setReferenceKeyFields, setReferenceTable, setReferenceTableName, setSelectionCriteria, setSelectionQueryContainerPolicy, setSessionName, setSourceKeyFieldNames, setSourceKeyFields, setValueConverter, setValueConverterClassName, shouldUseListOrderFieldTableExpression, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, useMapClass, valueFromRow, verifyDelete

Methods inherited from class org.eclipse.persistence.mappings.CollectionMapping
addAggregateOrderBy, addAscendingOrdering, addDescendingOrdering, addOrderBy, buildBackupCloneForPartObject, buildChangeRecord, buildContainerClone, buildElementUnitOfWorkClone, buildReferencesPKList, compareLists, compareListsAndWrite, compareObjectsAndWrite, compareObjectsWithoutPrivateOwned, compareObjectsWithPrivateOwned, copyElement, extractResultFromBatchQuery, getContainerPolicy, getDeleteAllQuery, getListOrderField, getOrderByQueryKeyExpressions, getOrderCorrectionType, getRealCollectionAttributeValueFromObject, getTargetPrimaryKeyFields, hasCustomDeleteAllQuery, hasOrderBy, initializeChangeOrderTargetQuery, initializeListOrderFieldTable, isAttributeValueInstantiatedOrChanged, isChangeTrackingSupported, isCollectionMapping, isListOrderFieldSupported, isMapKeyObjectRelationship, load, loadAll, mustDeleteReferenceObjectsOneByOne, objectAddedDuringUpdate, objectOrderChangedDuringUpdate, objectRemovedDuringUpdate, objectUnchangedDuringUpdate, objectUnchangedDuringUpdate, postDelete, postInitialize, postPrepareNestedBatchQuery, preInsert, preUpdate, readPrivateOwnedForObject, setChangeListener, setCustomDeleteAllQuery, setDeleteAllCall, setDeleteAllQuery, setDeleteAllSQLString, setHasCustomDeleteAllQuery, setListOrderField, setListOrderFieldName, setMustDeleteReferenceObjectsOneByOne, setOrderCorrectionType, setUseLazyInstantiationForIndirectCollection, shouldUseLazyInstantiationForIndirectCollection, updateChangeRecordForSelfMerge, useCollectionClass, useCollectionClassName, useListClassName, useMapClassName, useSortedSetClass, useSortedSetClassName, useSortedSetClassName, useTransparentCollection, useTransparentList, useTransparentMap, useTransparentSet, validateBeforeInitialization, valueFromPKList, writeChanges

Methods inherited from class org.eclipse.persistence.mappings.ForeignReferenceMapping
addForeignKeyField, addTargetForeignKeyField, batchedValueFromRow, buildBackupClone, buildClone, buildCloneFromRow, checkCacheForBatchKey, createCloneValueHolder, dontDoMerge, dontUseBatchReading, dontUseIndirection, extendPessimisticLockScopeInSourceQuery, extendPessimisticLockScopeInTargetQuery, fixObjectReferences, getAttributeValueFromObject, getAttributeValueWithClonedValueHolders, getBatchFetchType, getExtendPessimisticLockScopeDedicatedQuery, getIndirectionPolicy, getJoinFetch, getMappedBy, getPartitioningPolicy, getPartitioningPolicyName, getRealAttributeValueFromAttribute, getRelationshipPartnerAttributeName, getSelectionCriteria, getSelectionQuery, getTempSession, getValueFromRemoteValueHolder, hasCustomSelectionQuery, hasDependency, instantiateAttribute, isAttributeValueFromObjectInstantiated, isAttributeValueFullyBuilt, isAttributeValueInstantiated, isCascadeDetach, isCascadeMerge, isCascadeOnDeleteSetOnDatabase, isCascadePersist, isCascadeRefresh, isCascadeRemove, isExtendingPessimisticLockScope, isForeignReferenceMapping, isInnerJoinFetched, isJoinFetched, isLazy, isOuterJoinFetched, isPrivateOwned, iterate, mergeRemoteValueHolder, preInitialize, prepareHistoricalQuery, prepareNestedJoinQueryClone, privateOwnedRelationship, readFromRowIntoObject, requiresTransientWeavedFields, setBatchFetchType, setCascadeAll, setCascadeDetach, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setCustomSelectionQuery, setForceInitializationOfSelectionCriteria, setHasCustomSelectionQuery, setIndirectionPolicy, setIsCacheable, setIsCascadeOnDeleteSetOnDatabase, setIsPrivateOwned, setJoinFetch, setMappedBy, setPartitioningPolicy, setPartitioningPolicyName, setRealAttributeValueInObject, setReferenceDescriptor, setRelationshipPartner, setRelationshipPartnerAttributeName, setRequiresTransientWeavedFields, setSelectionCall, setSelectionQuery, setSelectionSQLString, setShouldExtendPessimisticLockScope, setTempSession, setUsesBatchReading, setUsesIndirection, shouldExtendPessimisticLockScope, shouldExtendPessimisticLockScopeInDedicatedQuery, shouldExtendPessimisticLockScopeInSourceQuery, shouldExtendPessimisticLockScopeInTargetQuery, shouldForceInitializationOfSelectionCriteria, shouldInitializeSelectionCriteria, shouldMergeCascadeParts, shouldMergeCascadeReference, shouldObjectModifyCascadeToParts, 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, collectFields, convertConverterClassNamesToClasses, derivesId, earlyPreDelete, extractNestedExpressions, extractNestedNonAggregateExpressions, getAttributeAccessor, getAttributeName, getDerivedIdMapping, getDescriptor, getField, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getProperties, getProperty, getRealAttributeValueFromObject, getSetMethodName, getUnconvertedProperties, getWeight, hasConstraintDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, hasUnconvertedProperties, isAbstractColumnMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCacheable, isCloningRequired, isDatabaseMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isInAndOutSopObject, isInOnlySopObject, isInSopObject, isJPAId, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOutOnlySopObject, isOutSopObject, isPrimaryKeyMapping, isReadOnly, isReferenceMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, 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, writeFromObjectIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowForUpdateAfterShallowInsert, writeFromObjectIntoRowForUpdateBeforeShallowDelete, writeFromObjectIntoRowForWhereClause, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.persistence.mappings.foundation.MapComponentMapping
clone

Constructor Detail
- DirectMapMapping
```
public DirectMapMapping()
```
  DirectMapCollectionMapping constructor

Method Detail

setContainerPolicy
```
public void setContainerPolicy(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)
```
ADVANCED: Configure the mapping to use a container policy. This must be a MappedKeyMapContainerPolicy policy. Set the valueMapping for the policy.

Specified by:

setContainerPolicy in interface ContainerMapping

Overrides:

setContainerPolicy in class DirectCollectionMapping

getKeyConverter
```
public Converter getKeyConverter()
```
PUBLIC: Return the converter on the mapping. A converter can be used to convert between the key's object value and database value.

setKeyConverter
```
public void setKeyConverter(Converter keyConverter)
```
PUBLIC: Set the converter on the mapping. A converter can be used to convert between the key's object value and database value.

setKeyConverterClassName
```
public void setKeyConverterClassName(java.lang.String keyConverterClassName)
```
INTERNAL: Set the converter class name on the mapping. Initialized in convertClassNamesToClasses. A converter can be used to convert between the key's object value and database value.

addToCollectionChangeRecord

public void addToCollectionChangeRecord(java.lang.Object newKey,
                               java.lang.Object newValue,
                               org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet,
                               org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
                                 throws DescriptorException

INTERNAL: Add a new value and its change set to the collection change record. This is used by attribute change tracking. If a value has changed then issue a remove first with the key then an add.

Throws:: DescriptorException

buildCloneForPartObject

public java.lang.Object buildCloneForPartObject(java.lang.Object attributeValue,
                                       java.lang.Object original,
                                       org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                                       java.lang.Object clone,
                                       org.eclipse.persistence.internal.sessions.AbstractSession cloningSession,
                                       java.lang.Integer refreshCascade,
                                       boolean isExisting,
                                       boolean isFromSharedCache)

INTERNAL: Require for cloning, the part must be cloned. Ignore the objects, use the attribute value.

Overrides:: buildCloneForPartObject in class CollectionMapping

calculateDeferredChanges
```
public void calculateDeferredChanges(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                            org.eclipse.persistence.internal.sessions.AbstractSession session)
```
INTERNAL: Used by AttributeLevelChangeTracking to update a changeRecord with calculated changes as opposed to detected changes. If an attribute can not be change tracked it's changes can be detected through this process.

Overrides:

calculateDeferredChanges in class DirectCollectionMapping

cascadeDiscoverAndPersistUnregisteredNewObjects

public void cascadeDiscoverAndPersistUnregisteredNewObjects(java.lang.Object object,
                                                   java.util.Map newObjects,
                                                   java.util.Map unregisteredExistingObjects,
                                                   java.util.Map visitedObjects,
                                                   org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                                   java.util.Set cascadeErrors)

INTERNAL: Cascade discover and persist new objects during commit.

Overrides:: cascadeDiscoverAndPersistUnregisteredNewObjects in class DirectCollectionMapping

cascadePerformRemoveIfRequired

public void cascadePerformRemoveIfRequired(java.lang.Object object,
                                  org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                  java.util.Map visitedObjects)

INTERNAL: Cascade perform delete through mappings that require the cascade

Overrides:: cascadePerformRemoveIfRequired in class DirectCollectionMapping

cascadeRegisterNewIfRequired

public void cascadeRegisterNewIfRequired(java.lang.Object object,
                                org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow,
                                java.util.Map visitedObjects)

INTERNAL: Cascade registerNew for Create through mappings that require the cascade

Overrides:: cascadeRegisterNewIfRequired in class DirectCollectionMapping

compareCollectionsForChange

public void compareCollectionsForChange(java.lang.Object oldCollection,
                               java.lang.Object newCollection,
                               org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                               org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: This method is used to calculate the differences between two collections.

Overrides:: compareCollectionsForChange in class DirectCollectionMapping

compareForChange

public org.eclipse.persistence.internal.sessions.ChangeRecord compareForChange(java.lang.Object clone,
                                                                      java.lang.Object backUp,
                                                                      org.eclipse.persistence.internal.sessions.ObjectChangeSet owner,
                                                                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: This method compares the changes between two direct collections. Comparisons are made on equality not identity.

Overrides:: compareForChange in class DirectCollectionMapping
Returns:: prototype.changeset.ChangeRecord

compareObjects

public boolean compareObjects(java.lang.Object firstObject,
                     java.lang.Object secondObject,
                     org.eclipse.persistence.internal.sessions.AbstractSession session)

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

Overrides:: compareObjects in class DirectCollectionMapping

convertClassNamesToClasses
```
public void convertClassNamesToClasses(java.lang.ClassLoader classLoader)
```
Description copied from class: DirectCollectionMapping

INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings This method is implemented by subclasses as necessary.

Overrides:

convertClassNamesToClasses in class DirectCollectionMapping

createMapComponentFromRow

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

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

Specified by:: createMapComponentFromRow in interface MapComponentMapping

getDirectKeyField

public org.eclipse.persistence.internal.helper.DatabaseField getDirectKeyField()

INTERNAL:

initialize
```
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
                throws DescriptorException
```
INTERNAL: Initialize and validate the mapping properties.

Overrides:

initialize in class DirectCollectionMapping

Throws:

DescriptorException

initializeDeleteQuery

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

Overrides:: initializeDeleteQuery in class DirectCollectionMapping

initializeInsertQuery
```
protected void initializeInsertQuery(org.eclipse.persistence.internal.sessions.AbstractSession session)
```
Initialize insert query. This query is used to insert the collection of objects into the reference table.

Overrides:

initializeInsertQuery in class DirectCollectionMapping

initializeSelectionStatement

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

Overrides:: initializeSelectionStatement in class DirectCollectionMapping

iterateOnRealAttributeValue
```
public void iterateOnRealAttributeValue(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator,
                               java.lang.Object realAttributeValue)
```
INTERNAL: Iterate on the attribute value. The value holder has already been processed. PERF: Avoid iteration if not required.

Overrides:

iterateOnRealAttributeValue in class DirectCollectionMapping

iterateOnElement

public void iterateOnElement(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator,
                    java.lang.Object element)

INTERNAL: Iterate on the specified element.

Overrides:: iterateOnElement in class DirectCollectionMapping

isDirectMapMapping
```
public boolean isDirectMapMapping()
```
INTERNAL: Related mapping should implement this method to return true.

Overrides:

isDirectMapMapping in class DatabaseMapping

mergeChangesIntoObject

public void mergeChangesIntoObject(java.lang.Object target,
                          org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                          java.lang.Object source,
                          org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                          org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: Merge changes from the source to the target object. Because this is a collection mapping, values are added to or removed from the collection based on the changeset.

Overrides:: mergeChangesIntoObject in class DirectCollectionMapping

mergeIntoObject

public void mergeIntoObject(java.lang.Object target,
                   boolean isTargetUnInitialized,
                   java.lang.Object source,
                   org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                   org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: Merge changes from the source to the target object.

Overrides:: mergeIntoObject in class DirectCollectionMapping

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. This is mostly dealt with in the superclass. Private Owned deletes require extra functionality

Overrides:: performDataModificationEvent in class DirectCollectionMapping
Throws:: DatabaseException; DescriptorException

postCalculateChanges
```
public void postCalculateChanges(ChangeRecord changeRecord,
                        org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
```
INTERNAL: Overridden by mappings that require additional processing of the change record after the record has been calculated.

Overrides:

postCalculateChanges in class DirectCollectionMapping

postInsert
```
public void postInsert(WriteObjectQuery query)
                throws DatabaseException
```
INTERNAL: Insert the private owned object.

Overrides:

postInsert in class DirectCollectionMapping

Throws:

DatabaseException

postUpdateWithChangeSet
```
protected void postUpdateWithChangeSet(WriteObjectQuery writeQuery)
                                throws DatabaseException
```
INTERNAL: Update private owned part.

Overrides:

postUpdateWithChangeSet in class DirectCollectionMapping

Throws:

DatabaseException

preDelete
```
public void preDelete(DeleteObjectQuery query)
               throws DatabaseException
```
INTERNAL: Propagate the preDelete event through the container policy if necessary

Overrides:

preDelete in class DirectCollectionMapping

Throws:

DatabaseException

initOrRebuildSelectQuery
```
protected void initOrRebuildSelectQuery()
```
INTERNAL: Rebuild select query.

Overrides:

initOrRebuildSelectQuery in class DirectCollectionMapping

recordPrivateOwnedRemovals
```
public void recordPrivateOwnedRemovals(java.lang.Object object,
                              org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
```
INTERNAL: Overridden by mappings that require additional processing of the change record after the record has been calculated.

Overrides:

recordPrivateOwnedRemovals in class DirectCollectionMapping

removeFromCollectionChangeRecord

protected void removeFromCollectionChangeRecord(java.lang.Object newKey,
                                    java.lang.Object newValue,
                                    org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet,
                                    org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
                                         throws DescriptorException

INTERNAL: Remove a value and its change set from the collection change record. This is used by attribute change tracking.

Throws:: DescriptorException

setDirectKeyField

public void setDirectKeyField(org.eclipse.persistence.internal.helper.DatabaseField keyField)

INTERNAL:

setDirectKeyFieldClassification
```
public void setDirectKeyFieldClassification(java.lang.Class fieldType)
```
ADVANCED: Set the class type of the field value. This can be used if field value differs from the object value, has specific typing requirements such as usage of java.sql.Blob or NChar. This must be called after the field name has been set.

setDirectKeyFieldClassificationName
```
public void setDirectKeyFieldClassificationName(java.lang.String fieldTypeName)
```
ADVANCED: Set the class type name of the field value. This can be used if field value differs from the object value, has specific typing requirements such as usage of java.sql.Blob or NChar. This must be called after the direct key field has been set.

setDirectKeyFieldName
```
public void setDirectKeyFieldName(java.lang.String fieldName)
```
PUBLIC: Set the direct key field name in the reference table. This is the field that the primitive data value of the Map key is stored in.

updateChangeRecord

public void updateChangeRecord(java.lang.Object clone,
                      java.lang.Object newValue,
                      java.lang.Object oldValue,
                      org.eclipse.persistence.internal.sessions.ObjectChangeSet objectChangeSet,
                      org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)
                        throws DescriptorException

INTERNAL: Either create a new change record or update the change record with the new value. This is used by attribute change tracking.

Overrides:: updateChangeRecord in class DirectCollectionMapping
Throws:: DescriptorException

updateCollectionChangeRecord

public void updateCollectionChangeRecord(CollectionChangeEvent event,
                                org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow)

INTERNAL: Add or removes a new value and its change set to the collection change record based on the event passed in. This is used by attribute change tracking.

Overrides:: updateCollectionChangeRecord in class DirectCollectionMapping

useMapClass
```
public void useMapClass(java.lang.Class concreteClass)
```
PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
The default container class is java.util.Hashtable.
The container class must implements (directly or indirectly) the Map interface.
Note: Do not use both useMapClass(Class concreteClass), useTransparentMap(). The last use of one of the two methods will override the previous one.

Overrides:

useMapClass in class CollectionMapping

useTransparentMap
```
public void useTransparentMap()
```
PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
The container class must implement (directly or indirectly) the Map interface.
Note: Do not use both useMapClass(Class concreteClass), useTransparentMap(). The last use of one of the two methods will override the previous one.

setKeyClass
```
public void setKeyClass(java.lang.Class keyClass)
```
PUBLIC: This is a helper method to set the key converter to a TypeConversionConverter. This ensures that the key value from the database is converted to the correct Java type. The converter can also be set directly. Note that setting the converter to another converter will overwrite this setting.

getKeyClass
```
public java.lang.Class getKeyClass()
```
PUBLIC: This is a helper method to get the object class from the key converter if it is a TypeConversionConverter. This returns null if not using a TypeConversionConverter key converter.

setValueClass
```
public void setValueClass(java.lang.Class valueClass)
```
PUBLIC: This is a helper method to set the value converter to a TypeConversionConverter. This ensures that the value from the database is converted to the correct Java type. The converter can also be set directly. Note that setting the converter to another converter will overwrite this setting.

simpleAddToCollectionChangeRecord

public void simpleAddToCollectionChangeRecord(java.lang.Object referenceKey,
                                     java.lang.Object objectToAdd,
                                     org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                     org.eclipse.persistence.internal.sessions.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 DirectCollectionMapping

simpleRemoveFromCollectionChangeRecord

public void simpleRemoveFromCollectionChangeRecord(java.lang.Object referenceKey,
                                          java.lang.Object objectToRemove,
                                          org.eclipse.persistence.internal.sessions.ObjectChangeSet changeSet,
                                          org.eclipse.persistence.internal.sessions.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 DirectCollectionMapping

getValueClass
```
public java.lang.Class getValueClass()
```
PUBLIC: This is a helper method to get the object class from the value converter if it is a TypeConversionConverter. This returns null if not using a TypeConversionConverter value converter.

executeBatchQuery

protected void executeBatchQuery(DatabaseQuery query,
                     org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                     java.util.Map referenceDataByKey,
                     org.eclipse.persistence.internal.sessions.AbstractSession session,
                     org.eclipse.persistence.internal.sessions.AbstractRecord translationRow)

INTERNAL: Prepare and execute the batch query and store the results for each source object in a map keyed by the mappings source keys of the source objects.

Overrides:: executeBatchQuery in class DirectCollectionMapping

valueFromRowInternalWithJoin

protected java.lang.Object valueFromRowInternalWithJoin(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                            org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                            ObjectBuildingQuery sourceQuery,
                                            org.eclipse.persistence.internal.identitymaps.CacheKey parentCacheKey,
                                            org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                                            boolean isTargetProtected)
                                                 throws DatabaseException

INTERNAL: Return the value of the field from the row or a value holder on the query to obtain the object.

Overrides:: valueFromRowInternalWithJoin in class DirectCollectionMapping
Throws:: DatabaseException

Class DirectMapMapping

Nested Class Summary

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

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.persistence.mappings.foundation.MapComponentMapping

Constructor Detail

DirectMapMapping

Method Detail

setContainerPolicy

getKeyConverter

setKeyConverter

setKeyConverterClassName

addToCollectionChangeRecord

buildCloneForPartObject

calculateDeferredChanges

cascadeDiscoverAndPersistUnregisteredNewObjects

cascadePerformRemoveIfRequired

cascadeRegisterNewIfRequired

compareCollectionsForChange

compareForChange

compareObjects

convertClassNamesToClasses

createMapComponentFromRow

getDirectKeyField

initialize

initializeDeleteQuery

initializeInsertQuery

initializeSelectionStatement

iterateOnRealAttributeValue

iterateOnElement

isDirectMapMapping

mergeChangesIntoObject

mergeIntoObject

performDataModificationEvent

postCalculateChanges

postInsert

postUpdateWithChangeSet

preDelete

initOrRebuildSelectQuery

recordPrivateOwnedRemovals

removeFromCollectionChangeRecord

setDirectKeyField

setDirectKeyFieldClassification

setDirectKeyFieldClassificationName

setDirectKeyFieldName

updateChangeRecord

updateCollectionChangeRecord

useMapClass

useTransparentMap

setKeyClass

getKeyClass

setValueClass

simpleAddToCollectionChangeRecord

simpleRemoveFromCollectionChangeRecord

getValueClass

executeBatchQuery

valueFromRowInternalWithJoin