org.eclipse.persistence.mappings.foundation
Class AbstractAttributeDirectMapping

java.lang.Object
  org.eclipse.persistence.mappings.DatabaseMapping
      org.eclipse.persistence.mappings.foundation.AbstractDirectMapping
          org.eclipse.persistence.mappings.foundation.AbstractAttributeDirectMapping

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, MapComponentMapping, MapKeyMapping

Direct Known Subclasses:

DirectToFieldMapping, EISDirectMapping, XMLDirectMapping

public abstract class AbstractAttributeDirectMapping
extends AbstractDirectMapping
implements MapKeyMapping

Purpose: Maps an attribute to the corresponding database field type. The list of field types that are supported by EclipseLink's direct to field mapping is dependent on the relational database being used. A converter can be used to convert between the object and data type if they do not match. NOTE: Much of the content of this class was extracted from AbstractDirectMapping. With the new MultitenantPrimaryKeyMapping (property mapping) where an attribute does not exist, attribute mapping code has been extracted here with AbstractDirectMapping containing the common code used for both attribute and property mappings to a direct field.

See Also:

Converter, ObjectTypeConverter, TypeConversionConverter, SerializedObjectConverter, ClassInstanceConverter, Serialized Form

Author:

Guy Pelletier

Since:

EclipseLink 2.4

Nested Class Summary

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

DatabaseMapping.WriteType

Field Summary

protected java.lang.Class	attributeClassification To specify the conversion type
protected java.lang.String	attributeClassificationName
protected java.lang.Class	attributeObjectClassification PERF: Also store object class of attribute in case of primitive.
protected Converter	converter Allows user defined conversion between the object attribute value and the database value.
protected java.lang.String	converterClassName
protected java.lang.String	fieldClassificationClassName
protected boolean	isInsertable Flag to support insertable JPA setting
protected java.lang.Boolean	isMutable PERF: Indicates if this mapping's attribute is a simple atomic value and cannot be modified, only replaced.
protected boolean	isUpdatable Flag to support updatable JPA setting
protected org.eclipse.persistence.internal.helper.DatabaseTable	keyTableForMapKey
protected java.lang.Object	nullValue Support specification of the value to use for null.

Fields inherited from class org.eclipse.persistence.mappings.foundation.AbstractDirectMapping

field

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

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

Constructor Summary

AbstractAttributeDirectMapping()

Method Summary

void	addAdditionalFieldsToQuery(ReadQuery selectionQuery, Expression baseExpression) INTERNAL: Used when initializing queries for mappings that use a Map.
void	addFieldsForMapKey(org.eclipse.persistence.internal.sessions.AbstractRecord joinRow) INTERNAL: Used when initializing queries for mappings that use a Map Called when the insert query is being initialized to ensure the fields for the map key are in the insert query.
void	addKeyToDeletedObjectsList(java.lang.Object object, java.util.Map deletedObjects) INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy.
void	buildBackupClone(java.lang.Object clone, java.lang.Object backup, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork) INTERNAL: Clone the attribute from the clone and assign it to the backup.
org.eclipse.persistence.internal.sessions.ChangeRecord	buildChangeRecord(java.lang.Object clone, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Directly build a change record without comparison
void	buildClone(java.lang.Object original, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, java.lang.Object clone, org.eclipse.persistence.internal.sessions.AbstractSession cloningSession) INTERNAL: Clone the attribute from the original and assign it to the clone.
protected java.lang.Object	buildCloneValue(java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Clone the actual value represented by this mapping.
void	buildCloneValue(java.lang.Object original, java.lang.Object clone, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Clone the attribute from the original and assign it to the clone.
void	buildCopy(java.lang.Object copy, java.lang.Object original, CopyGroup group) INTERNAL: Copy of the attribute of the object.
java.lang.Object	buildElementClone(java.lang.Object attributeValue, java.lang.Object parent, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, org.eclipse.persistence.internal.sessions.AbstractSession cloningSession, boolean isExisting) Build a clone of the given element in a unitOfWork.
ReadQuery	buildSelectionQueryForDirectCollectionKeyMapping(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy) INTERNAL: Certain key mappings favor different types of selection query.
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, boolean getAttributeValueFromObject, java.util.Set cascadeErrors) INTERNAL: Cascade discover and persist new objects during commit to the map key.
void	cascadePerformRemoveIfRequired(java.lang.Object object, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl uow, java.util.Map visitedObjects, boolean getAttributeValueFromObject) 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, boolean getAttributeValueFromObject) INTERNAL: Cascade registerNew for Create through mappings that require the cascade.
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: Compare the clone and backup clone values and return a change record if the value changed.
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.
protected boolean	compareObjectValues(java.lang.Object firstValue, java.lang.Object secondValue, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Compare the attribute values.
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	createMapComponentFromJoinedRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManger, 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 and a join query is executed.
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.
java.util.List<java.lang.Object>	createMapComponentsFromSerializableKeyInfo(java.lang.Object[] keyInfo, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Create an instance of the Key object from the key information extracted from the map.
QueryKey	createQueryKeyForMapKey() INTERNAL: Create a query key that links to the map key.
java.lang.Object	createSerializableMapKeyInfo(java.lang.Object key, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Creates the Array of simple types used to recreate this map.
java.lang.Object	createStubbedMapComponentFromSerializableKeyInfo(java.lang.Object keyInfo, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Create an instance of the Key object from the key information extracted from the map.
void	deleteMapKey(java.lang.Object objectDeleted, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy, Delete the passed object if necessary.
java.util.Map	extractIdentityFieldsForQuery(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Extract the fields for the Map key from the object to use in a query.
Expression	getAdditionalSelectionCriteriaForMapKey() INTERNAL: Return the selection criteria necessary to select the target object when this mapping is a map key.
java.util.List<org.eclipse.persistence.internal.helper.DatabaseTable>	getAdditionalTablesForJoinQuery() INTERNAL: Return any tables that will be required when this mapping is used as part of a join query.
java.util.List<org.eclipse.persistence.internal.helper.DatabaseField>	getAllFieldsForMapKey() INTERNAL: Get all the fields for the map key.
java.lang.Class	getAttributeClassification() PUBLIC: Some databases do not properly support all of the base data types.
java.lang.String	getAttributeClassificationName() INTERNAL: Return the class name of the attribute type.
java.lang.Object	getAttributeValue(java.lang.Object fieldValue, Session session) INTERNAL: Allows for subclasses to convert the attribute value.
Converter	getConverter() PUBLIC: Return the converter on the mapping.
java.lang.Class	getFieldClassification(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify) INTERNAL: Return the classification for the field contained in the mapping.
java.lang.Object	getFieldValue(java.lang.Object attributeValue, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Convert the attribute value to a field value.
java.util.Map<org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.helper.DatabaseField>	getForeignKeyFieldsForMapKey() INTERNAL: Return a Map of any foreign keys defined within the the MapKey.
java.util.List<org.eclipse.persistence.internal.helper.DatabaseField>	getIdentityFieldsForMapKey() INTERNAL: Return the fields that make up the identity of the mapped object.
java.lang.Class	getMapKeyTargetType() INTERNAL: Return the class this key mapping maps or the descriptor for it
ObjectLevelReadQuery	getNestedJoinQuery(org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectLevelReadQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Return the query that is used when this mapping is part of a joined relationship This method is used when this mapping is used to map the key in a Map.
java.lang.Object	getNullValue() PUBLIC: Allow for the value used for null to be specified.
java.lang.Object	getObjectValue(java.lang.Object fieldValue, Session session) INTERNAL: Allows for subclasses to convert the attribute value.
java.lang.Object	getTargetVersionOfSourceObject(java.lang.Object object, java.lang.Object parent, org.eclipse.persistence.internal.sessions.MergeManager mergeManager, org.eclipse.persistence.internal.sessions.AbstractSession targetSession) INTERNAL: If required, get the targetVersion of the source object from the merge manager.
boolean	hasConverter() Indicates if the mapping has a converter set on it.
void	initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: The mapping is initialized with the given session.
org.eclipse.persistence.internal.sessions.ChangeRecord	internalBuildChangeRecord(java.lang.Object newValue, java.lang.Object oldValue, org.eclipse.persistence.internal.sessions.ObjectChangeSet owner) INTERNAL: Build a change record.
boolean	isAbstractAttributeDirectMapping() INTERNAL:
boolean	isChangeTrackingSupported(Project project) INTERNAL: Return if this mapping supports change tracking.
boolean	isDirectToFieldMapping() INTERNAL:
boolean	isInsertable() PUBLIC: By default mappings are insertable.
boolean	isMutable() PUBLIC: Return true if the attribute for this mapping is a simple atomic value that cannot be modified, only replaced.
boolean	isUpdatable() PUBLIC: By default mappings are updatable.
void	iterateOnMapKey(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator, java.lang.Object element) INTERNAL: Called when iterating through descriptors to handle iteration on this mapping when it is used as a MapKey.
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	postInitializeMapKey(org.eclipse.persistence.internal.queries.MappedKeyMapContainerPolicy policy) INTERNAL: Making any mapping changes necessary to use a the mapping as a map key after initializing the mapping.
void	preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initialize the attribute classification.
void	preinitializeMapKey(org.eclipse.persistence.internal.helper.DatabaseTable table) INTERNAL: Making any mapping changes necessary to use a the mapping as a map key prior to initializing the mapping.
void	remoteInitialization(DistributedSession session) INTERNAL: Once descriptors are serialized to the remote session.
boolean	requiresDataModificationEventsForMapKey() INTERNAL: Return whether this mapping requires extra queries to update the rows if it is used as a key in a map.
void	setAttributeClassification(java.lang.Class attributeClassification) PUBLIC: Some databases do not properly support all of the base data types.
void	setAttributeClassificationName(java.lang.String attributeClassificationName) INTERNAL: Set the name of the class for MW usage.
void	setConverter(Converter converter) PUBLIC: Set the converter on the mapping.
void	setConverterClassName(java.lang.String converterClassName) PUBLIC: Set the converter class name on the mapping.
void	setFieldClassificationClassName(java.lang.String className) INTERNAL: Set the name of the class that will be used for setFieldClassification and deploy time Used internally by JPA deployment.
void	setIsMutable(boolean isMutable) PUBLIC: Return true if the attribute for this mapping is a simple atomic value that cannot be modified, only replaced.
void	setNullValue(java.lang.Object nullValue) PUBLIC: Allow for the value used for null to be specified.
java.lang.Object	unwrapKey(java.lang.Object key, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Allow the key mapping to unwrap the object.
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 with the new value.
java.lang.Object	valueFromObject(java.lang.Object object, org.eclipse.persistence.internal.helper.DatabaseField field, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Get the value from the object for this mapping.
java.lang.Object	valueFromResultSet(java.sql.ResultSet resultSet, ObjectBuildingQuery query, org.eclipse.persistence.internal.sessions.AbstractSession session, org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor, java.sql.ResultSetMetaData metaData, int columnNumber, org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform) INTERNAL: Returns the value for the mapping directly from the result-set.
java.lang.Object	valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery query, org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey, org.eclipse.persistence.internal.sessions.AbstractSession executionSession, boolean isTargetProtected, java.lang.Boolean[] wasCacheUsed) INTERNAL: Return the mapping's attribute value from the row.
java.lang.Object	wrapKey(java.lang.Object key, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Allow the key mapping to wrap the object.

Methods inherited from class org.eclipse.persistence.mappings.foundation.AbstractDirectMapping

buildCloneFromRow, buildExpression, buildShallowOriginalFromRow, cascadePerformRemoveIfRequired, cascadeRegisterNewIfRequired, clone, collectFields, fixObjectReferences, getField, getFieldClassification, getFieldName, getReferenceDescriptor, getWeight, isAbstractDirectMapping, isCloningRequired, iterate, setField, setFieldClassification, setFieldType, toString, validateBeforeInitialization, writeFromObjectIntoRow, writeFromObjectIntoRowForUpdate, writeFromObjectIntoRowWithChangeRecord, writeInsertFieldsIntoRow, writeUpdateFieldsIntoRow, writeValueIntoRow

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

buildBackupCloneForPartObject, buildCloneForPartObject, buildContainerClone, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cloneFields, collectQueryParameters, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDerivedIdMapping, getDescriptor, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getValueFromRemoteValueHolder, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, instantiateAttribute, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToXMLTypeMapping, isEISMapping, isElementCollectionMapping, isForeignReferenceMapping, isJoiningSupported, isJPAId, isLazy, isLockableMapping, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isMultitenantPrimaryKeyMapping, isNestedTableMapping, isObjectReferenceMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOwned, isPrimaryKeyMapping, isPrivateOwned, isReadOnly, isReferenceMapping, isRelationalMapping, isRemotelyInitialized, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isVariableOneToOneMapping, isWriteOnly, isXMLMapping, iterateOnRealAttributeValue, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInsert, postUpdate, preDelete, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remotelyInitialized, replaceValueHoldersIn, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setFields, setGetMethodName, setIsCacheable, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setRealAttributeValueInObject, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForWhereClause

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.MapKeyMapping

getReferenceDescriptor

Field Detail

attributeClassification

protected transient java.lang.Class attributeClassification

To specify the conversion type

attributeClassificationName

protected transient java.lang.String attributeClassificationName

attributeObjectClassification

protected transient java.lang.Class attributeObjectClassification

PERF: Also store object class of attribute in case of primitive.

converter

protected Converter converter

Allows user defined conversion between the object attribute value and the database value.

converterClassName

protected java.lang.String converterClassName

keyTableForMapKey

protected org.eclipse.persistence.internal.helper.DatabaseTable keyTableForMapKey

isInsertable

protected boolean isInsertable

Flag to support insertable JPA setting

isUpdatable

protected boolean isUpdatable

Flag to support updatable JPA setting

isMutable

protected java.lang.Boolean isMutable

PERF: Indicates if this mapping's attribute is a simple atomic value and cannot be modified, only replaced. This is a tri-state to allow user to set to true or false, as default is false but some data-types such as Calendar or byte[] or converter types may be desired to be used as mutable.

nullValue

protected transient java.lang.Object nullValue

Support specification of the value to use for null.

fieldClassificationClassName

protected java.lang.String fieldClassificationClassName

Constructor Detail

AbstractAttributeDirectMapping

public AbstractAttributeDirectMapping()

Method Detail

addFieldsForMapKey

public void addFieldsForMapKey(org.eclipse.persistence.internal.sessions.AbstractRecord joinRow)

INTERNAL: Used when initializing queries for mappings that use a Map Called when the insert query is being initialized to ensure the fields for the map key are in the insert query.

Specified by:

addFieldsForMapKey in interface MapKeyMapping

addAdditionalFieldsToQuery

public void addAdditionalFieldsToQuery(ReadQuery selectionQuery,
                                       Expression baseExpression)

INTERNAL: Used when initializing queries for mappings that use a Map. Called when the selection query is being initialized to add the fields for the map key to the query.

Specified by:

addAdditionalFieldsToQuery in interface MapKeyMapping

addKeyToDeletedObjectsList

public void addKeyToDeletedObjectsList(java.lang.Object object,
                                       java.util.Map deletedObjects)

INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy. Add the target of this mapping to the deleted objects list if necessary This method is used for removal of private owned relationships DirectMappings are dealt with in their parent delete, so this is a no-op.

Specified by:

addKeyToDeletedObjectsList in interface MapKeyMapping

buildBackupClone

public void buildBackupClone(java.lang.Object clone,
                             java.lang.Object backup,
                             org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork)

INTERNAL: Clone the attribute from the clone and assign it to the backup.

Specified by:

buildBackupClone in class DatabaseMapping

buildClone

public void buildClone(java.lang.Object original,
                       org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                       java.lang.Object clone,
                       org.eclipse.persistence.internal.sessions.AbstractSession cloningSession)

INTERNAL: Clone the attribute from the original and assign it to the clone.

Specified by:

buildClone in class DatabaseMapping

buildCloneValue

protected java.lang.Object buildCloneValue(java.lang.Object attributeValue,
                                           org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Clone the actual value represented by this mapping. Do set the cloned value into the object.

buildCloneValue

public void buildCloneValue(java.lang.Object original,
                            java.lang.Object clone,
                            org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Clone the attribute from the original and assign it to the clone. If mutability is configured to be true, clone the attribute if it is an instance of byte[], java.util.Calendar or java.util.Date (or their subclasses).

buildChangeRecord

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

INTERNAL: Directly build a change record without comparison

Overrides:

buildChangeRecord in class DatabaseMapping

buildCopy

public void buildCopy(java.lang.Object copy,
                      java.lang.Object original,
                      CopyGroup group)

INTERNAL: Copy of the attribute of the object. This is NOT used for unit of work but for templatizing an object.

Overrides:

buildCopy in class DatabaseMapping

buildElementClone

public java.lang.Object buildElementClone(java.lang.Object attributeValue,
                                          java.lang.Object parent,
                                          org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                                          org.eclipse.persistence.internal.sessions.AbstractSession cloningSession,
                                          boolean isExisting)

Build a clone of the given element in a unitOfWork.

Specified by:

buildElementClone in interface MapKeyMapping

Returns:

buildSelectionQueryForDirectCollectionKeyMapping

public ReadQuery buildSelectionQueryForDirectCollectionKeyMapping(org.eclipse.persistence.internal.queries.ContainerPolicy containerPolicy)

INTERNAL: Certain key mappings favor different types of selection query. Return the appropriate type of selectionQuery.

Specified by:

buildSelectionQueryForDirectCollectionKeyMapping in interface MapKeyMapping

Returns:

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,
                                                            boolean getAttributeValueFromObject,
                                                            java.util.Set cascadeErrors)

INTERNAL: Cascade discover and persist new objects during commit to the map key.

Specified by:

cascadeDiscoverAndPersistUnregisteredNewObjects in interface MapKeyMapping

cascadePerformRemoveIfRequired

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

INTERNAL: Cascade perform delete through mappings that require the cascade.

Specified by:

cascadePerformRemoveIfRequired in interface MapKeyMapping

cascadeRegisterNewIfRequired

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

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

Specified by:

cascadeRegisterNewIfRequired in interface MapKeyMapping

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: Compare the clone and backup clone values and return a change record if the value changed.

Specified by:

compareForChange in class DatabaseMapping

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.

Specified by:

compareObjects in class DatabaseMapping

compareObjectValues

protected boolean compareObjectValues(java.lang.Object firstValue,
                                      java.lang.Object secondValue,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Compare the attribute values.

convertClassNamesToClasses

public 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.

Overrides:

convertClassNamesToClasses in class DatabaseMapping

createMapComponentFromJoinedRow

public java.lang.Object createMapComponentFromJoinedRow(org.eclipse.persistence.internal.sessions.AbstractRecord dbRow,
                                                        org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManger,
                                                        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 and a join query is executed. Returns the key.

Specified by:

createMapComponentFromJoinedRow in interface MapKeyMapping

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

createMapComponentsFromSerializableKeyInfo

public java.util.List<java.lang.Object> createMapComponentsFromSerializableKeyInfo(java.lang.Object[] keyInfo,
                                                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Create an instance of the Key object from the key information extracted from the map. This may return the value directly in case of a simple key or will be used as the FK to load a related entity.

Specified by:

createMapComponentsFromSerializableKeyInfo in interface MapKeyMapping

createQueryKeyForMapKey

public QueryKey createQueryKeyForMapKey()

INTERNAL: Create a query key that links to the map key.

Specified by:

createQueryKeyForMapKey in interface MapKeyMapping

Returns:

createSerializableMapKeyInfo

public java.lang.Object createSerializableMapKeyInfo(java.lang.Object key,
                                                     org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Creates the Array of simple types used to recreate this map.

Specified by:

createSerializableMapKeyInfo in interface MapKeyMapping

createStubbedMapComponentFromSerializableKeyInfo

public java.lang.Object createStubbedMapComponentFromSerializableKeyInfo(java.lang.Object keyInfo,
                                                                         org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Create an instance of the Key object from the key information extracted from the map. This key object may be a shallow stub of the actual object if the key is an Entity type.

Specified by:

createStubbedMapComponentFromSerializableKeyInfo in interface MapKeyMapping

deleteMapKey

public void deleteMapKey(java.lang.Object objectDeleted,
                         org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: For mappings used as MapKeys in MappedKeyContainerPolicy, Delete the passed object if necessary. This method is used for removal of private owned relationships DirectMappings are dealt with in their parent delete, so this is a no-op.

Specified by:

deleteMapKey in interface MapKeyMapping

extractIdentityFieldsForQuery

public java.util.Map extractIdentityFieldsForQuery(java.lang.Object object,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Extract the fields for the Map key from the object to use in a query.

Specified by:

extractIdentityFieldsForQuery in interface MapKeyMapping

Returns:

getAdditionalSelectionCriteriaForMapKey

public Expression getAdditionalSelectionCriteriaForMapKey()

INTERNAL: Return the selection criteria necessary to select the target object when this mapping is a map key. DirectMappings do not need any additional selection criteria when they are map keys.

Specified by:

getAdditionalSelectionCriteriaForMapKey in interface MapKeyMapping

Returns:

getAdditionalTablesForJoinQuery

public java.util.List<org.eclipse.persistence.internal.helper.DatabaseTable> getAdditionalTablesForJoinQuery()

INTERNAL: Return any tables that will be required when this mapping is used as part of a join query.

Specified by:

getAdditionalTablesForJoinQuery in interface MapKeyMapping

Returns:

getAllFieldsForMapKey

public java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> getAllFieldsForMapKey()

INTERNAL: Get all the fields for the map key.

Specified by:

getAllFieldsForMapKey in interface MapKeyMapping

getAttributeClassification

public java.lang.Class getAttributeClassification()

PUBLIC: Some databases do not properly support all of the base data types. For these databases, the base data type must be explicitly specified in the mapping to tell EclipseLink to force the instance variable value to that data type.

Overrides:

getAttributeClassification in class DatabaseMapping

getAttributeClassificationName

public java.lang.String getAttributeClassificationName()

INTERNAL: Return the class name of the attribute type. This is only used by the MW.

Overrides:

getAttributeClassificationName in class AbstractDirectMapping

See Also:

org.eclipse.persistence.mappings.foundation.AbstractAttributeDirectMapping.getAttributeClassificationName()

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.Object fieldValue,
                                          Session session)

INTERNAL: Allows for subclasses to convert the attribute value.

Overrides:

getAttributeValue in class AbstractDirectMapping

See Also:

AbstractDirectMapping.getObjectValue(Object, Session), which implements getAttributeValue()

getConverter

public Converter getConverter()

PUBLIC: Return the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

Overrides:

getConverter in class AbstractDirectMapping

getFieldClassification

public java.lang.Class getFieldClassification(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify)

INTERNAL: Return the classification for the field contained in the mapping. This is used to convert the row value to a consistent Java value.

Overrides:

getFieldClassification in class DatabaseMapping

getFieldValue

public java.lang.Object getFieldValue(java.lang.Object attributeValue,
                                      org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Convert the attribute value to a field value. Process any converter if defined, and check for null values.

Specified by:

getFieldValue in class AbstractDirectMapping

getForeignKeyFieldsForMapKey

public java.util.Map<org.eclipse.persistence.internal.helper.DatabaseField,org.eclipse.persistence.internal.helper.DatabaseField> getForeignKeyFieldsForMapKey()

INTERNAL: Return a Map of any foreign keys defined within the the MapKey.

Specified by:

getForeignKeyFieldsForMapKey in interface MapKeyMapping

Returns:

getIdentityFieldsForMapKey

public java.util.List<org.eclipse.persistence.internal.helper.DatabaseField> getIdentityFieldsForMapKey()

INTERNAL: Return the fields that make up the identity of the mapped object. For mappings with a primary key, it will be the set of fields in the primary key. For mappings without a primary key it will likely be all the fields.

Specified by:

getIdentityFieldsForMapKey in interface MapKeyMapping

Returns:

getMapKeyTargetType

public java.lang.Class getMapKeyTargetType()

INTERNAL: Return the class this key mapping maps or the descriptor for it

Specified by:

getMapKeyTargetType in interface MapKeyMapping

Returns:

getNestedJoinQuery

public ObjectLevelReadQuery getNestedJoinQuery(org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                               ObjectLevelReadQuery query,
                                               org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Return the query that is used when this mapping is part of a joined relationship This method is used when this mapping is used to map the key in a Map.

Specified by:

getNestedJoinQuery in interface MapKeyMapping

Returns:

getNullValue

public java.lang.Object getNullValue()

PUBLIC: Allow for the value used for null to be specified. This can be used to convert database null values to application specific values, when null values are not allowed by the application (such as in primitives). Note: the default value for NULL is used on reads, writes, and query SQL generation

Overrides:

getNullValue in class AbstractDirectMapping

getObjectValue

public java.lang.Object getObjectValue(java.lang.Object fieldValue,
                                       Session session)

INTERNAL: Allows for subclasses to convert the attribute value.

Specified by:

getObjectValue in class AbstractDirectMapping

getTargetVersionOfSourceObject

public java.lang.Object getTargetVersionOfSourceObject(java.lang.Object object,
                                                       java.lang.Object parent,
                                                       org.eclipse.persistence.internal.sessions.MergeManager mergeManager,
                                                       org.eclipse.persistence.internal.sessions.AbstractSession targetSession)

INTERNAL: If required, get the targetVersion of the source object from the merge manager. Used with MapKeyContainerPolicy to abstract getting the target version of a source key.

Specified by:

getTargetVersionOfSourceObject in interface MapKeyMapping

Returns:

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.

Specified by:

mergeChangesIntoObject in class DatabaseMapping

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. This merge is only called when a changeSet for the target does not exist or the target is uninitialized

Specified by:

mergeIntoObject in class DatabaseMapping

postInitializeMapKey

public void postInitializeMapKey(org.eclipse.persistence.internal.queries.MappedKeyMapContainerPolicy policy)

INTERNAL: Making any mapping changes necessary to use a the mapping as a map key after initializing the mapping.

Specified by:

postInitializeMapKey in interface MapKeyMapping

preInitialize

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

INTERNAL: Initialize the attribute classification.

Overrides:

preInitialize in class DatabaseMapping

Throws:

DescriptorException

preinitializeMapKey

public void preinitializeMapKey(org.eclipse.persistence.internal.helper.DatabaseTable table)
                         throws DescriptorException

INTERNAL: Making any mapping changes necessary to use a the mapping as a map key prior to initializing the mapping.

Specified by:

preinitializeMapKey in interface MapKeyMapping

Throws:

DescriptorException

hasConverter

public boolean hasConverter()

Indicates if the mapping has a converter set on it.

Overrides:

hasConverter in class AbstractDirectMapping

Returns:

true if there is a converter set on the mapping, false otherwise.

initialize

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

INTERNAL: The mapping is initialized with the given session. This mapping is fully initialized after this.

Overrides:

initialize in class DatabaseMapping

Throws:

DescriptorException

internalBuildChangeRecord

public org.eclipse.persistence.internal.sessions.ChangeRecord internalBuildChangeRecord(java.lang.Object newValue,
                                                                                        java.lang.Object oldValue,
                                                                                        org.eclipse.persistence.internal.sessions.ObjectChangeSet owner)

INTERNAL: Build a change record.

isAbstractAttributeDirectMapping

public boolean isAbstractAttributeDirectMapping()

INTERNAL:

Overrides:

isAbstractAttributeDirectMapping in class DatabaseMapping

isChangeTrackingSupported

public boolean isChangeTrackingSupported(Project project)

INTERNAL: Return if this mapping supports change tracking.

Overrides:

isChangeTrackingSupported in class DatabaseMapping

isDirectToFieldMapping

public boolean isDirectToFieldMapping()

INTERNAL:

Overrides:

isDirectToFieldMapping in class DatabaseMapping

isInsertable

public boolean isInsertable()

Description copied from class: AbstractDirectMapping

PUBLIC: By default mappings are insertable. Return false otherwise.

Overrides:

isInsertable in class AbstractDirectMapping

isMutable

public boolean isMutable()

PUBLIC: Return true if the attribute for this mapping is a simple atomic value that cannot be modified, only replaced. This is false by default unless a mutable converter is used such as the SerializedObjectConverter. This can be set to false in this case, or if a Calendar or byte[] is desired to be used as a mutable value it can be set to true.

Overrides:

isMutable in class AbstractDirectMapping

isUpdatable

public boolean isUpdatable()

Description copied from class: AbstractDirectMapping

PUBLIC: By default mappings are updatable. Return false otherwise.

Overrides:

isUpdatable in class AbstractDirectMapping

iterateOnMapKey

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

INTERNAL: Called when iterating through descriptors to handle iteration on this mapping when it is used as a MapKey.

Specified by:

iterateOnMapKey in interface MapKeyMapping

remoteInitialization

public void remoteInitialization(DistributedSession session)

INTERNAL: Once descriptors are serialized to the remote session. All its mappings and reference descriptors are traversed. Usually mappings are initialized and serialized reference descriptors are replaced with local descriptors if they already exist on the remote session.

Overrides:

remoteInitialization in class DatabaseMapping

requiresDataModificationEventsForMapKey

public boolean requiresDataModificationEventsForMapKey()

INTERNAL: Return whether this mapping requires extra queries to update the rows if it is used as a key in a map. This will typically be true if there are any parts to this mapping that are not read-only.

Specified by:

requiresDataModificationEventsForMapKey in interface MapKeyMapping

setAttributeClassification

public void setAttributeClassification(java.lang.Class attributeClassification)

PUBLIC: Some databases do not properly support all of the base data types. For these databases, the base data type must be explicitly specified in the mapping to tell EclipseLink to force the instance variable value to that data type

Specified by:

setAttributeClassification in class AbstractDirectMapping

See Also:

org.eclipse.persistence.mappings.foundation.AbstractAttributeDirectMapping.setAttributeClassification(Class)

setAttributeClassificationName

public void setAttributeClassificationName(java.lang.String attributeClassificationName)

INTERNAL: Set the name of the class for MW usage.

Overrides:

setAttributeClassificationName in class AbstractDirectMapping

See Also:

org.eclipse.persistence.mappings.foundation.AbstractAttributeDirectMapping.setAttributeClassificationName(String)

setConverter

public void setConverter(Converter converter)

PUBLIC: Set the converter on the mapping. A converter can be used to convert between the object's value and database value of the attribute.

Overrides:

setConverter in class AbstractDirectMapping

setConverterClassName

public void setConverterClassName(java.lang.String converterClassName)

PUBLIC: Set the converter class name on the mapping. It will be instantiated during the convertClassNamesToClasses. A converter can be used to convert between the object's value and database value of the attribute.

setFieldClassificationClassName

public void setFieldClassificationClassName(java.lang.String className)

INTERNAL: Set the name of the class that will be used for setFieldClassification and deploy time Used internally by JPA deployment.

Parameters:

className -

See Also:

AbstractDirectMapping.setFieldClassification(Class fieldType)

setIsMutable

public void setIsMutable(boolean isMutable)

PUBLIC: Return true if the attribute for this mapping is a simple atomic value that cannot be modified, only replaced. This is false by default unless a mutable converter is used such as the SerializedObjectConverter. This can be set to false in this case, or if a Calendar or byte[] is desired to be used as a mutable value it can be set to true.

Overrides:

setIsMutable in class AbstractDirectMapping

setNullValue

public void setNullValue(java.lang.Object nullValue)

PUBLIC: Allow for the value used for null to be specified. This can be used to convert database null values to application specific values, when null values are not allowed by the application (such as in primitives). Note: the default value for NULL is used on reads, writes, and query SQL generation

Overrides:

setNullValue in class AbstractDirectMapping

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)

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

Overrides:

updateChangeRecord in class DatabaseMapping

unwrapKey

public java.lang.Object unwrapKey(java.lang.Object key,
                                  org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Allow the key mapping to unwrap the object.

Specified by:

unwrapKey in interface MapKeyMapping

Returns:

valueFromObject

public java.lang.Object valueFromObject(java.lang.Object object,
                                        org.eclipse.persistence.internal.helper.DatabaseField field,
                                        org.eclipse.persistence.internal.sessions.AbstractSession session)
                                 throws DescriptorException

INTERNAL: Get the value from the object for this mapping.

Overrides:

valueFromObject in class DatabaseMapping

Throws:

DescriptorException

valueFromRow

public java.lang.Object valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                     org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                     ObjectBuildingQuery query,
                                     org.eclipse.persistence.internal.identitymaps.CacheKey cacheKey,
                                     org.eclipse.persistence.internal.sessions.AbstractSession executionSession,
                                     boolean isTargetProtected,
                                     java.lang.Boolean[] wasCacheUsed)

INTERNAL: Return the mapping's attribute value from the row. The execution session is passed for the case of building a UnitOfWork clone directly from a row, the session set in the query will not know which platform to use for converting the value. Allows the correct session to be passed in.

Overrides:

valueFromRow in class DatabaseMapping

valueFromResultSet

public java.lang.Object valueFromResultSet(java.sql.ResultSet resultSet,
                                           ObjectBuildingQuery query,
                                           org.eclipse.persistence.internal.sessions.AbstractSession session,
                                           org.eclipse.persistence.internal.databaseaccess.DatabaseAccessor accessor,
                                           java.sql.ResultSetMetaData metaData,
                                           int columnNumber,
                                           org.eclipse.persistence.internal.databaseaccess.DatabasePlatform platform)
                                    throws java.sql.SQLException

INTERNAL: Returns the value for the mapping directly from the result-set. PERF: Used for optimized object building.

Overrides:

valueFromResultSet in class DatabaseMapping

Throws:

java.sql.SQLException

wrapKey

public java.lang.Object wrapKey(java.lang.Object key,
                                org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Allow the key mapping to wrap the object.

Specified by:

wrapKey in interface MapKeyMapping

Returns: