org.eclipse.persistence.mappings.foundation
Class AbstractDirectMapping

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AbstractAttributeDirectMapping, MultitenantPrimaryKeyMapping

public abstract class AbstractDirectMapping
extends DatabaseMapping

Purpose: Maps an attribute or some other property 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.

See Also:

AbstractAttributeDirectMapping, org.eclipse.persistence.mappings.foundation.MultitenantPrimaryKeyMapping, Serialized Form

Author:

Sati

Since:

TopLink/Java 1.0

Nested Class Summary

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

DatabaseMapping.WriteType

Field Summary

protected org.eclipse.persistence.internal.helper.DatabaseField

field DatabaseField which this mapping represents.

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

AbstractDirectMapping()
Default constructor.

Method Summary

void	buildCloneFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, java.lang.Object clone, org.eclipse.persistence.internal.identitymaps.CacheKey sharedCacheKey, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork, org.eclipse.persistence.internal.sessions.AbstractSession executionSession) INTERNAL: Extract value from the row and set the attribute to this value in the working copy clone.
Expression	buildExpression(java.lang.Object queryObject, QueryByExamplePolicy policy, Expression expressionBuilder, java.util.Map processedObjects, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: In case Query By Example is used, this method builds and returns an expression that corresponds to a single attribute and it's value for a directToField mapping.
void	buildShallowOriginalFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, java.lang.Object original, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery query, org.eclipse.persistence.internal.sessions.AbstractSession executionSession) INTERNAL: Builds a shallow original object.
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.
java.lang.Object	clone() INTERNAL: The mapping clones itself to create deep copy.
protected java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField>	collectFields() Returns the field this mapping represents.
void	fixObjectReferences(java.lang.Object object, java.util.Map objectDescriptors, java.util.Map processedObjects, ObjectLevelReadQuery query, RemoteSession session) INTERNAL: An object has been serialized from the server to the client.
java.lang.String	getAttributeClassificationName() Deprecated.
java.lang.Object	getAttributeValue(java.lang.Object fieldValue, Session session) Deprecated.
Converter	getConverter() PUBLIC: Return the converter on the mapping.
org.eclipse.persistence.internal.helper.DatabaseField	getField() INTERNAL: Returns the field which this mapping represents.
java.lang.Class	getFieldClassification() ADVANCED: Return the class type of the field value.
java.lang.String	getFieldName() PUBLIC: Name of the field this mapping represents.
abstract java.lang.Object	getFieldValue(java.lang.Object objectValue, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Convert the object (attribute or property) value to a field value.
java.lang.Object	getNullValue() PUBLIC: Allow for the value used for null to be specified.
abstract java.lang.Object	getObjectValue(java.lang.Object fieldValue, Session session) INTERNAL Allows for subclasses to convert the the attribute or property value.
ClassDescriptor	getReferenceDescriptor() INTERNAL: Get the descriptor for this mapping This method is potentially called when this mapping is used as a map key and will return null since direct mappings do not have reference descriptors.
java.lang.Integer	getWeight() INTERNAL: Return the weight of the mapping, used to sort mappings to ensure that DirectToField Mappings get merged first
boolean	hasConverter() Indicates if the mapping has a converter set on it.
boolean	isAbstractDirectMapping() INTERNAL:
boolean	isCloningRequired() INTERNAL: Return if this mapping requires its attribute value to be cloned.
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	iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator) INTERNAL: Iterate on the appropriate attribute.
abstract void	setAttributeClassification(java.lang.Class attributeClassification) Deprecated.
void	setAttributeClassificationName(java.lang.String attributeClassificationName) Deprecated.
void	setConverter(Converter converter) PUBLIC: Set the converter on the mapping.
void	setField(org.eclipse.persistence.internal.helper.DatabaseField theField) ADVANCED: Set the field in the mapping.
void	setFieldClassification(java.lang.Class fieldType) ADVANCED: Set the class type of the field value.
void	setFieldType(int jdbcType) ADVANCED: Set the JDBC type of the field value.
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.String	toString() INTERNAL:
void	validateBeforeInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Allow for subclasses to perform validation.
void	writeFromObjectIntoRow(java.lang.Object object, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType) INTERNAL: Get a value from the object and set that in the respective field of the row.
void	writeFromObjectIntoRowForUpdate(WriteObjectQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow) INTERNAL: Write the attribute value from the object to the row for update.
void	writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.sessions.AbstractSession session, DatabaseMapping.WriteType writeType) INTERNAL: Get a value from the object and set that in the respective field of the row.
void	writeInsertFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Write fields needed for insert into the template for with null values.
void	writeUpdateFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Write fields needed for update into the template for with null values.
protected abstract void	writeValueIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.helper.DatabaseField field, java.lang.Object value)

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

buildBackupClone, buildBackupCloneForPartObject, buildChangeRecord, buildClone, buildCloneForPartObject, buildContainerClone, buildCopy, buildObjectJoinExpression, buildObjectJoinExpression, calculateDeferredChanges, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cloneFields, collectQueryParameters, compareForChange, compareObjects, convertClassNamesToClasses, createCloneValueHolder, derivesId, earlyPreDelete, extractNestedExpressions, fixRealObjectReferences, getAttributeAccessor, getAttributeClassification, getAttributeName, getAttributeValueFromObject, getContainerPolicy, getDerivedIdMapping, getDescriptor, getFieldClassification, getFields, getGetMethodName, getMapsIdValue, getObjectCorrespondingTo, getProperties, getProperty, getRealAttributeValueFromAttribute, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getRelationshipPartner, getSelectFields, getSelectTables, getSetMethodName, getValueFromRemoteValueHolder, hasConstraintDependency, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, hasRootExpressionThatShouldUseOuterJoin, initialize, instantiateAttribute, isAbstractAttributeDirectMapping, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCacheable, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isChangeTrackingSupported, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, 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, mergeChangesIntoObject, mergeIntoObject, performDataModificationEvent, postCalculateChanges, postCalculateChangesOnDeleted, postDelete, postInitialize, postInsert, postUpdate, preDelete, preInitialize, preInsert, prepareCascadeLockingPolicy, preUpdate, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, recordPrivateOwnedRemovals, rehashFieldDependancies, remoteInitialization, 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, updateChangeRecord, updateCollectionChangeRecord, validateAfterInitialization, valueFromObject, valueFromResultSet, valueFromRow, valueFromRow, verifyDelete, writeFromAttributeIntoRow, writeFromObjectIntoRowForShallowInsert, writeFromObjectIntoRowForShallowInsertWithChangeRecord, writeFromObjectIntoRowForWhereClause

Methods inherited from class java.lang.Object

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

Field Detail

field

protected org.eclipse.persistence.internal.helper.DatabaseField field

DatabaseField which this mapping represents.

Constructor Detail

AbstractDirectMapping

public AbstractDirectMapping()

Default constructor.

Method Detail

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.

isInsertable

public boolean isInsertable()

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

isUpdatable

public boolean isUpdatable()

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

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.

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. Subclasses should overwrite this method.

buildExpression

public Expression buildExpression(java.lang.Object queryObject,
                                  QueryByExamplePolicy policy,
                                  Expression expressionBuilder,
                                  java.util.Map processedObjects,
                                  org.eclipse.persistence.internal.sessions.AbstractSession session)

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

Overrides:

buildExpression in class DatabaseMapping

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.

Specified by:

cascadePerformRemoveIfRequired in class DatabaseMapping

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.

Specified by:

cascadeRegisterNewIfRequired in class DatabaseMapping

clone

public java.lang.Object clone()

INTERNAL: The mapping clones itself to create deep copy.

Overrides:

clone in class DatabaseMapping

collectFields

protected java.util.Vector<org.eclipse.persistence.internal.helper.DatabaseField> collectFields()

Returns the field this mapping represents.

Overrides:

collectFields in class DatabaseMapping

fixObjectReferences

public void fixObjectReferences(java.lang.Object object,
                                java.util.Map objectDescriptors,
                                java.util.Map processedObjects,
                                ObjectLevelReadQuery query,
                                RemoteSession session)

INTERNAL: An object has been serialized from the server to the client. Replace the transient attributes of the remote value holders with client-side objects.

Specified by:

fixObjectReferences in class DatabaseMapping

getConverter

public Converter getConverter()

PUBLIC: Return the converter on the mapping. By default there isn't one unless a sub class supports it. A converter can be used to convert between the object's value and database value of the attribute.

getField

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

INTERNAL: Returns the field which this mapping represents.

Overrides:

getField in class DatabaseMapping

isAbstractDirectMapping

public boolean isAbstractDirectMapping()

INTERNAL:

Overrides:

isAbstractDirectMapping in class DatabaseMapping

getReferenceDescriptor

public ClassDescriptor getReferenceDescriptor()

INTERNAL: Get the descriptor for this mapping This method is potentially called when this mapping is used as a map key and will return null since direct mappings do not have reference descriptors.

Overrides:

getReferenceDescriptor in class DatabaseMapping

getFieldClassification

public java.lang.Class getFieldClassification()

ADVANCED: Return 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.

setFieldClassification

public void setFieldClassification(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.

setFieldType

public void setFieldType(int jdbcType)

ADVANCED: Set the JDBC type of the field value. This can be used if field type does not correspond directly to a Java class type, such as MONEY. This is used for binding.

getFieldName

public java.lang.String getFieldName()

PUBLIC: Name of the field this mapping represents.

getFieldValue

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

INTERNAL: Convert the object (attribute or property) value to a field value.

getAttributeClassificationName

@Deprecated
public java.lang.String getAttributeClassificationName()

Deprecated.

INTERNAL: Return the class name of the attribute type (if there is one). This is only used by the MW.

See Also:

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

getAttributeValue

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

Deprecated.

INTERNAL: Allows for subclasses to convert the attribute value. Deprecated this method versus removing all together since a customer may have subclassed this class?

See Also:

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

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. Subclasses should overwrite this method.

getObjectValue

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

INTERNAL Allows for subclasses to convert the the attribute or property value.

getWeight

public java.lang.Integer getWeight()

INTERNAL: Return the weight of the mapping, used to sort mappings to ensure that DirectToField Mappings get merged first

Overrides:

getWeight in class DatabaseMapping

hasConverter

public boolean hasConverter()

Indicates if the mapping has a converter set on it.

Returns:

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

iterate

public void iterate(org.eclipse.persistence.internal.descriptors.DescriptorIterator iterator)

INTERNAL: Iterate on the appropriate attribute.

Specified by:

iterate in class DatabaseMapping

setAttributeClassification

@Deprecated
public abstract void setAttributeClassification(java.lang.Class attributeClassification)

Deprecated.

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

See Also:

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

setAttributeClassificationName

@Deprecated
public void setAttributeClassificationName(java.lang.String attributeClassificationName)

Deprecated.

INTERNAL: Return the class name of the attribute type (if there is one). This is only used by the MW.

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.

setField

public void setField(org.eclipse.persistence.internal.helper.DatabaseField theField)

ADVANCED: Set the field in the mapping. This can be used for advanced field types, such as XML nodes, or to set the field type.

toString

public java.lang.String toString()

INTERNAL:

Overrides:

toString in class DatabaseMapping

isCloningRequired

public boolean isCloningRequired()

INTERNAL: Return if this mapping requires its attribute value to be cloned.

Overrides:

isCloningRequired in class DatabaseMapping

validateBeforeInitialization

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

INTERNAL: Allow for subclasses to perform validation.

Overrides:

validateBeforeInitialization in class DatabaseMapping

Throws:

DescriptorException

buildCloneFromRow

public void buildCloneFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                              org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                              java.lang.Object clone,
                              org.eclipse.persistence.internal.identitymaps.CacheKey sharedCacheKey,
                              ObjectBuildingQuery sourceQuery,
                              org.eclipse.persistence.internal.sessions.UnitOfWorkImpl unitOfWork,
                              org.eclipse.persistence.internal.sessions.AbstractSession executionSession)

INTERNAL: Extract value from the row and set the attribute to this value in the working copy clone. In order to bypass the shared cache when in transaction a UnitOfWork must be able to populate working copies directly from the row.

Specified by:

buildCloneFromRow in class DatabaseMapping

buildShallowOriginalFromRow

public void buildShallowOriginalFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                                        java.lang.Object original,
                                        org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                                        ObjectBuildingQuery query,
                                        org.eclipse.persistence.internal.sessions.AbstractSession executionSession)

INTERNAL: Builds a shallow original object. Only direct attributes and primary keys are populated. In this way the minimum original required for instantiating a working copy clone can be built without placing it in the shared cache (no concern over cycles).

Overrides:

buildShallowOriginalFromRow in class DatabaseMapping

writeValueIntoRow

protected abstract void writeValueIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                          org.eclipse.persistence.internal.helper.DatabaseField field,
                                          java.lang.Object value)

writeFromObjectIntoRow

public void writeFromObjectIntoRow(java.lang.Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                   DatabaseMapping.WriteType writeType)

INTERNAL: Get a value from the object and set that in the respective field of the row.

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

writeFromObjectIntoRowForUpdate

public void writeFromObjectIntoRowForUpdate(WriteObjectQuery query,
                                            org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow)

INTERNAL: Write the attribute value from the object to the row for update.

Overrides:

writeFromObjectIntoRowForUpdate in class DatabaseMapping

writeFromObjectIntoRowWithChangeRecord

public void writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                                                   org.eclipse.persistence.internal.sessions.AbstractRecord row,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session,
                                                   DatabaseMapping.WriteType writeType)

INTERNAL: Get a value from the object and set that in the respective field of the row. Validation preventing primary key updates is implemented here.

Overrides:

writeFromObjectIntoRowWithChangeRecord in class DatabaseMapping

writeInsertFieldsIntoRow

public void writeInsertFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)

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

Overrides:

writeInsertFieldsIntoRow in class DatabaseMapping

writeUpdateFieldsIntoRow

public void writeUpdateFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord databaseRow,
                                     org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Write fields needed for update into the template for with null values. By default inserted fields are used.

Overrides:

writeUpdateFieldsIntoRow in class DatabaseMapping