org.eclipse.persistence.mappings
Class VariableOneToOneMapping

java.lang.Object
  org.eclipse.persistence.mappings.DatabaseMapping
      org.eclipse.persistence.mappings.ForeignReferenceMapping
          org.eclipse.persistence.mappings.ObjectReferenceMapping
              org.eclipse.persistence.mappings.VariableOneToOneMapping

All Implemented Interfaces:

Serializable, Cloneable, RelationalMapping

public class VariableOneToOneMapping
extends ObjectReferenceMapping
implements RelationalMapping

Purpose: Variable one to one mappings are used to represent a pointer references between a java object and an implementer of an interface. This mapping is usually represented by a single pointer (stored in an instance variable) between the source and target objects. In the relational database tables, these mappings are normally implemented using a foreign key and a type code.

Since:

TOPLink/Java 2.0

Author:

Sati

See Also:

Serialized Form

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

INNER_JOIN, NONE, OUTER_JOIN, QUERY_BATCH_PARAMETER

Constructor Summary

VariableOneToOneMapping()
PUBLIC: Default constructor.

Method Summary

void	addClassIndicator(Class implementer, Object typeIndicator) PUBLIC: Add a type indicator conversion to this mapping.
void	addClassNameIndicator(String className, Object typeIndicator) INTERNAL: Add indicators by classname.
void	addForeignQueryKeyName(org.eclipse.persistence.internal.helper.DatabaseField sourceForeignKeyField, String targetQueryKeyName) PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping.
void	addForeignQueryKeyName(String sourceForeignKeyFieldName, String targetQueryKeyName) PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping.
void	addTargetForeignQueryKeyName(String targetForeignQueryKeyName, String sourcePrimaryKeyFieldName) PUBLIC: Define the target foreign key relationship in the Variable 1-1 mapping.
Object	clone() INTERNAL: This methods clones all the fields and ensures that each collection refers to the same clones.
void	convertClassNamesToClasses(ClassLoader classLoader) INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings.
Vector	getClassIndicatorAssociations() INTERNAL: Return the class indicator associations for XML.
ClassDescriptor	getDescriptorForTarget(Object targetObject, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Return a descriptor for the target of this mapping For normal ObjectReferenceMappings, we return the reference descriptor.
Class	getFieldClassification(org.eclipse.persistence.internal.helper.DatabaseField fieldToClassify) INTERNAL: Return the classification for the field contained in the mapping.
Vector	getForeignKeyFieldNames() PUBLIC: Return the foreign key field names associated with the mapping.
Vector	getSourceToTargetQueryKeyFieldAssociations() PUBLIC: Return a collection of the field to query key associations.
Map	getSourceToTargetQueryKeyNames() INTERNAL: Returns the source keys to target keys fields association.
org.eclipse.persistence.internal.helper.DatabaseField	getTypeField()
String	getTypeFieldName() PUBLIC: This method returns the name of the typeField of the mapping.
Map	getTypeIndicatorNameTranslation() INTERNAL: Return the typeIndicatorName translation Used by the Mapping Workbench to avoid classpath dependencies
Map	getTypeIndicatorTranslation() INTERNAL: Return the type indicators.
void	initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Initialize the mapping.
void	initializeSelectionCriteria(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Selection criteria is created with source foreign keys and target keys.
boolean	isRelationalMapping() INTERNAL:
boolean	isVariableOneToOneMapping() INTERNAL:
void	preInitialize(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Set the type field classification through searching the indicators hashtable.
void	rehashFieldDependancies(org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Rehash any maps based on fields.
void	setClassIndicatorAssociations(Vector classIndicatorAssociations) PUBLIC: Set the class indicator associations.
void	setForeignKeyFieldNames(Vector fieldNames) PUBLIC: Return the foreign key field names associated with the mapping.
void	setForeignQueryKeyName(String sourceForeignKeyFieldName, String targetQueryKeyName) PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping.
void	setSourceToTargetQueryKeyFieldAssociations(Vector sourceToTargetQueryKeyFieldAssociations) PUBLIC: Set a collection of the source to target query key/field associations.
void	setTypeField(org.eclipse.persistence.internal.helper.DatabaseField typeField) INTERNAL: This method set the typeField of the mapping to the parameter field
void	setTypeFieldName(String typeFieldName) PUBLIC: This method sets the name of the typeField of the mapping.
Object	valueFromObject(Object object, org.eclipse.persistence.internal.helper.DatabaseField field, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Get a value from the object and set that in the respective field of the row.
Object	valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row, org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, org.eclipse.persistence.internal.sessions.AbstractSession executionSession) INTERNAL: Return the value of the field from the row or a value holder on the query to obtain the object.
void	writeFromObjectIntoRow(Object object, org.eclipse.persistence.internal.sessions.AbstractRecord record, 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	writeFromObjectIntoRowForShallowInsert(Object object, org.eclipse.persistence.internal.sessions.AbstractRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts.
void	writeFromObjectIntoRowForShallowInsertWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractRecord record, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts.
void	writeFromObjectIntoRowForWhereClause(ObjectLevelModifyQuery query, org.eclipse.persistence.internal.sessions.AbstractRecord record) INTERNAL: Get a value from the object and set that in the respective field of the row.
void	writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord, org.eclipse.persistence.internal.sessions.AbstractRecord record, 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 record, org.eclipse.persistence.internal.sessions.AbstractSession session) INTERNAL: Write fields needed for insert into the template for with null values.

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

buildBackupCloneForPartObject, buildChangeRecord, buildCloneForPartObject, buildCopy, buildExpression, buildReferencesPKList, buildTargetInterfaces, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadeDiscoverAndPersistUnregisteredNewObjects, cascadePerformRemoveIfRequired, cascadePerformRemoveIfRequired, cascadePerformRemovePrivateOwnedObjectFromChangeSetIfRequired, cascadeRegisterNewIfRequired, cascadeRegisterNewIfRequired, compareForChange, createUnitOfWorkValueHolder, extractPrimaryKeyRowForSourceObject, extractPrimaryKeysForReferenceObject, extractPrimaryKeysForReferenceObjectFromRow, extractPrimaryKeysFromRealReferenceObject, fixRealObjectReferences, getForeignKeyFields, getRealAttributeValueFromAttribute, hasConstraintDependency, internalBuildChangeRecord, isChangeTrackingSupported, isForeignKeyRelationship, isObjectReferenceMapping, iterateOnRealAttributeValue, mergeChangesIntoObject, mergeIntoObject, postCalculateChanges, postDelete, postInsert, postUpdate, preDelete, preInsert, preUpdate, recordPrivateOwnedRemovals, setIsForeignKeyRelationship, setNewValueInChangeRecord, updateChangeRecord, useProxyIndirection, useProxyIndirection, useProxyIndirection, valueFromPKList, verifyDelete, writeFromObjectIntoRowForUpdate

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

buildBackupClone, buildClone, buildCloneFromRow, compareObjects, dontUseBatchReading, dontUseIndirection, extendPessimisticLockScopeInSourceQuery, extractResultFromBatchQuery, fixObjectReferences, getAttributeValueFromObject, getAttributeValueWithClonedValueHolders, getBatchFetchType, getIndirectionPolicy, getJoinCriteria, getJoinFetch, getObjectCorrespondingTo, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationshipPartner, getRelationshipPartnerAttributeName, getSelectionCriteria, getSelectionQuery, getValueFromRemoteValueHolder, hasCustomSelectionQuery, instantiateAttribute, isAttributeValueInstantiated, isCascadeDetach, isCascadeMerge, isCascadePersist, isCascadeRefresh, isCascadeRemove, isForeignReferenceMapping, isInnerJoinFetched, isJoinFetched, isJoiningSupported, isLazy, isLockableMapping, isOuterJoinFetched, isPrivateOwned, iterate, mergeRemoteValueHolder, prepareNestedBatchQuery, prepareNestedJoins, privateOwnedRelationship, remoteInitialization, replaceValueHoldersIn, requiresTransientWeavedFields, setBatchFetchType, setCascadeAll, setCascadeDetach, setCascadeMerge, setCascadePersist, setCascadeRefresh, setCascadeRemove, setCustomSelectionQuery, setForceInitializationOfSelectionCriteria, setIndirectionPolicy, setIsPrivateOwned, setJoinFetch, setRealAttributeValueInObject, setReferenceClass, setReferenceClassName, setRelationshipPartner, setRelationshipPartnerAttributeName, setRequiresTransientWeavedFields, setSelectionCall, setSelectionCriteria, setSelectionSQLString, setShouldExtendPessimisticLockScope, setUsesBatchReading, setUsesIndirection, shouldExtendPessimisticLockScope, shouldExtendPessimisticLockScopeInDedicatedQuery, shouldExtendPessimisticLockScopeInSourceQuery, shouldExtendPessimisticLockScopeInTargetQuery, shouldMergeCascadeParts, shouldUseBatchReading, trimRowForJoin, trimRowForJoin, useBasicIndirection, useBatchReading, useContainerIndirection, useInnerJoinFetch, useOuterJoinFetch, usesIndirection, useWeavedIndirection, validateBeforeInitialization

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

buildObjectJoinExpression, buildObjectJoinExpression, buildShallowOriginalFromRow, calculateDeferredChanges, cascadeMerge, derivesId, earlyPreDelete, getAttributeAccessor, getAttributeClassification, getAttributeName, getContainerPolicy, getDerivedIdMapping, getDescriptor, getField, getFields, getGetMethodName, getMapsIdValue, getProperties, getProperty, getRealAttributeValueFromObject, getRealCollectionAttributeValueFromObject, getSelectFields, getSelectTables, getSetMethodName, getWeight, hasDependency, hasInverseConstraintDependency, hasMapsIdValue, isAbstractCompositeCollectionMapping, isAbstractCompositeDirectCollectionMapping, isAbstractCompositeObjectMapping, isAbstractDirectMapping, isAggregateCollectionMapping, isAggregateMapping, isAggregateObjectMapping, isCandidateForPrivateOwnedRemoval, isCascadedLockingSupported, isCloningRequired, isCollectionMapping, isDatabaseMapping, isDirectCollectionMapping, isDirectMapMapping, isDirectToFieldMapping, isDirectToXMLTypeMapping, isEISMapping, isJPAId, isManyToManyMapping, isManyToOneMapping, isMapKeyMapping, isNestedTableMapping, isOneToManyMapping, isOneToOneMapping, isOptional, isOwned, isPrimaryKeyMapping, isReadOnly, isReferenceMapping, isStructureMapping, isTransformationMapping, isUnidirectionalOneToManyMapping, isUsingMethodAccess, isWriteOnly, isXMLMapping, performDataModificationEvent, postCalculateChangesOnDeleted, postInitialize, prepareCascadeLockingPolicy, readFromResultSetIntoObject, readFromRowIntoObject, readOnly, readWrite, setAttributeAccessor, setAttributeName, setAttributeValueInObject, setChangeListener, setDerivedIdMapping, setDerivesId, setDescriptor, setGetMethodName, setIsJPAId, setIsLazy, setIsMapKeyMapping, setIsOptional, setIsPrimaryKeyMapping, setIsReadOnly, setMapsIdValue, setProperties, setProperty, setSetMethodName, setWeight, simpleAddToCollectionChangeRecord, simpleRemoveFromCollectionChangeRecord, toString, updateCollectionChangeRecord, validateAfterInitialization, valueFromResultSet, valueFromRow, writeFromAttributeIntoRow, writeUpdateFieldsIntoRow

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableOneToOneMapping

public VariableOneToOneMapping()

PUBLIC: Default constructor.

Method Detail

isRelationalMapping

public boolean isRelationalMapping()

INTERNAL:

Overrides:

isRelationalMapping in class DatabaseMapping

addClassIndicator

public void addClassIndicator(Class implementer,
                              Object typeIndicator)

PUBLIC: Add a type indicator conversion to this mapping.

addClassNameIndicator

public void addClassNameIndicator(String className,
                                  Object typeIndicator)

INTERNAL: Add indicators by classname. For use by the Mapping Workbench to avoid classpath dependencies

addForeignQueryKeyName

public void addForeignQueryKeyName(org.eclipse.persistence.internal.helper.DatabaseField sourceForeignKeyField,
                                   String targetQueryKeyName)

PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping. This method is used if there are multiple foreign keys.

addForeignQueryKeyName

public void addForeignQueryKeyName(String sourceForeignKeyFieldName,
                                   String targetQueryKeyName)

PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping. This method is used if there are multiple foreign keys.

addTargetForeignQueryKeyName

public void addTargetForeignQueryKeyName(String targetForeignQueryKeyName,
                                         String sourcePrimaryKeyFieldName)

PUBLIC: Define the target foreign key relationship in the Variable 1-1 mapping. This method is used for composite target foreign key relationships, that is the target object's table has multiple foreign key fields to the source object's primary key fields. Both the target foreign key query name and the source primary key field name must be specified. The distinction between a foreign key and target foreign key is that the variable 1-1 mapping will not populate the target foreign key value when written (because it is in the target table). Normally 1-1's are through foreign keys but in bi-directional 1-1's the back reference will be a target foreign key. In obscure composite legacy data models a 1-1 may consist of a foreign key part and a target foreign key part, in this case both method will be called with the correct parts.

clone

public Object clone()

INTERNAL: This methods clones all the fields and ensures that each collection refers to the same clones.

Overrides:

clone in class ForeignReferenceMapping

getClassIndicatorAssociations

public Vector getClassIndicatorAssociations()

INTERNAL: Return the class indicator associations for XML. List of class-name/value associations.

getDescriptorForTarget

public ClassDescriptor getDescriptorForTarget(Object targetObject,
                                              org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Return a descriptor for the target of this mapping For normal ObjectReferenceMappings, we return the reference descriptor. For a VariableOneToOneMapping, the reference descriptor is often a descriptor for an interface and does not contain adequate information. As a result, we look up the descriptor for the specific class we are looking for Bug 2612571

Overrides:

getDescriptorForTarget in class ObjectReferenceMapping

See Also:

Bug 2612571

getFieldClassification

public 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

getForeignKeyFieldNames

public Vector getForeignKeyFieldNames()

PUBLIC: Return the foreign key field names associated with the mapping. These are only the source fields that are writable.

getSourceToTargetQueryKeyFieldAssociations

public Vector getSourceToTargetQueryKeyFieldAssociations()

PUBLIC: Return a collection of the field to query key associations.

getSourceToTargetQueryKeyNames

public Map getSourceToTargetQueryKeyNames()

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

getTypeField

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

getTypeFieldName

public String getTypeFieldName()

PUBLIC: This method returns the name of the typeField of the mapping. The type field is used to store the type of object the relationship is referencing.

getTypeIndicatorTranslation

public Map getTypeIndicatorTranslation()

INTERNAL: Return the type indicators.

getTypeIndicatorNameTranslation

public Map getTypeIndicatorNameTranslation()

INTERNAL: Return the typeIndicatorName translation Used by the Mapping Workbench to avoid classpath dependencies

convertClassNamesToClasses

public void convertClassNamesToClasses(ClassLoader classLoader)

INTERNAL: Convert all the class-name-based settings in this mapping to actual class-based settings. This method is used when converting a project that has been built with class names to a project with classes.

Overrides:

convertClassNamesToClasses in class ForeignReferenceMapping

initialize

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

INTERNAL: Initialize the mapping.

Overrides:

initialize in class ForeignReferenceMapping

initializeSelectionCriteria

public void initializeSelectionCriteria(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Selection criteria is created with source foreign keys and target keys. This criteria is then used to read target records from the table.

isVariableOneToOneMapping

public boolean isVariableOneToOneMapping()

INTERNAL:

Overrides:

isVariableOneToOneMapping in class DatabaseMapping

preInitialize

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

INTERNAL: Set the type field classification through searching the indicators hashtable.

Overrides:

preInitialize in class ObjectReferenceMapping

Throws:

DescriptorException

rehashFieldDependancies

public void rehashFieldDependancies(org.eclipse.persistence.internal.sessions.AbstractSession session)

INTERNAL: Rehash any maps based on fields. This is used to clone descriptors for aggregates, which hammer field names.

Overrides:

rehashFieldDependancies in class DatabaseMapping

setClassIndicatorAssociations

public void setClassIndicatorAssociations(Vector classIndicatorAssociations)

PUBLIC: Set the class indicator associations.

setForeignKeyFieldNames

public void setForeignKeyFieldNames(Vector fieldNames)

PUBLIC: Return the foreign key field names associated with the mapping. These are only the source fields that are writable.

setForeignQueryKeyName

public void setForeignQueryKeyName(String sourceForeignKeyFieldName,
                                   String targetQueryKeyName)

PUBLIC: A foreign key from the source table and abstract query key from the interface descriptor are added to the mapping. This method is used if foreign key is not composite.

setSourceToTargetQueryKeyFieldAssociations

public void setSourceToTargetQueryKeyFieldAssociations(Vector sourceToTargetQueryKeyFieldAssociations)

PUBLIC: Set a collection of the source to target query key/field associations.

setTypeField

public void setTypeField(org.eclipse.persistence.internal.helper.DatabaseField typeField)

INTERNAL: This method set the typeField of the mapping to the parameter field

setTypeFieldName

public void setTypeFieldName(String typeFieldName)

PUBLIC: This method sets the name of the typeField of the mapping. The type field is used to store the type of object the relationship is referencing.

valueFromObject

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

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

Overrides:

valueFromObject in class DatabaseMapping

valueFromRow

public Object valueFromRow(org.eclipse.persistence.internal.sessions.AbstractRecord row,
                           org.eclipse.persistence.internal.queries.JoinedAttributeManager joinManager,
                           ObjectBuildingQuery sourceQuery,
                           org.eclipse.persistence.internal.sessions.AbstractSession executionSession)
                    throws DatabaseException

INTERNAL: Return the value of the field from the row or a value holder on the query to obtain the object. Check for batch + aggregation reading.

Overrides:

valueFromRow in class ForeignReferenceMapping

Throws:

DatabaseException

writeFromObjectIntoRow

public void writeFromObjectIntoRow(Object object,
                                   org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                   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. If the mapping id target foreign key, you must only write the type into the roe, the rest will be updated when the object itself is written

Overrides:

writeFromObjectIntoRow in class DatabaseMapping

writeFromObjectIntoRowWithChangeRecord

public void writeFromObjectIntoRowWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                                                   org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                                   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. If the mapping id target foreign key, you must only write the type into the roe, the rest will be updated when the object itself is written

Overrides:

writeFromObjectIntoRowWithChangeRecord in class DatabaseMapping

writeFromObjectIntoRowForShallowInsert

public void writeFromObjectIntoRowForShallowInsert(Object object,
                                                   org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)

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

Overrides:

writeFromObjectIntoRowForShallowInsert in class DatabaseMapping

writeFromObjectIntoRowForShallowInsertWithChangeRecord

public void writeFromObjectIntoRowForShallowInsertWithChangeRecord(org.eclipse.persistence.internal.sessions.ChangeRecord changeRecord,
                                                                   org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                                                   org.eclipse.persistence.internal.sessions.AbstractSession session)

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

Overrides:

writeFromObjectIntoRowForShallowInsertWithChangeRecord in class DatabaseMapping

writeFromObjectIntoRowForWhereClause

public void writeFromObjectIntoRowForWhereClause(ObjectLevelModifyQuery query,
                                                 org.eclipse.persistence.internal.sessions.AbstractRecord record)

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

Overrides:

writeFromObjectIntoRowForWhereClause in class ObjectReferenceMapping

writeInsertFieldsIntoRow

public void writeInsertFieldsIntoRow(org.eclipse.persistence.internal.sessions.AbstractRecord record,
                                     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