Module org.eclipse.persistence.core
Package org.eclipse.persistence.mappings

Class VariableOneToOneMapping

java.lang.Object
org.eclipse.persistence.core.mappings.CoreMapping<AttributeAccessor,AbstractSession,ContainerPolicy,ClassDescriptor,DatabaseField>
org.eclipse.persistence.mappings.DatabaseMapping
org.eclipse.persistence.mappings.ForeignReferenceMapping
org.eclipse.persistence.mappings.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
See Also:

  • Field Details

    • typeField

      protected DatabaseField typeField

    • sourceToTargetQueryKeyNames

      protected Map sourceToTargetQueryKeyNames

    • typeIndicatorTranslation

      protected Map typeIndicatorTranslation

    • typeIndicatorNameTranslation

      protected Map typeIndicatorNameTranslation
      parallel table typeIndicatorTranslation used prior to initialization to avoid type indicators on Mapping Workbench

  • Constructor Details

    • VariableOneToOneMapping

      public VariableOneToOneMapping()
      PUBLIC: Default constructor.

  • Method Details

    • 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(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.

    • batchedValueFromRow

      protected Object batchedValueFromRow(AbstractRecord row, ObjectLevelReadQuery query, CacheKey parentCacheKey)
      INTERNAL: Possible for future development, not currently supported. Retrieve the value through using batch reading. This executes a single query to read the target for all of the objects and stores the result of the batch query in the original query to allow the other objects to share the results.
      Overrides:
      batchedValueFromRow in class ForeignReferenceMapping

    • 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
      Returns:
      new instance of itself

    • collectFields

      protected Vector collectFields()
      INTERNAL: Return all the fields populated by this mapping.
      Overrides:
      collectFields in class ObjectReferenceMapping
      Returns:
      TODO

    • compareObjectsWithoutPrivateOwned

      protected boolean compareObjectsWithoutPrivateOwned(Object firstObject, Object secondObject, AbstractSession session)
      INTERNAL: Compare the references of the two objects are the same, not the objects themselves. Used for independent relationships. This is used for testing and validation purposes. Must get separate fields for the objects because we may be adding a different class to the attribute because of the interface
      Overrides:
      compareObjectsWithoutPrivateOwned in class ObjectReferenceMapping

    • getClassIndicatorAssociations

      public Vector getClassIndicatorAssociations()
      INTERNAL: Return the class indicator associations for XML. List of class-name/value associations.

    • getDescriptorForTarget

      public ClassDescriptor getDescriptorForTarget(Object targetObject, 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:

    • getFieldClassification

      public Class<?> getFieldClassification(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.

    • getImplementorForType

      protected Object getImplementorForType(Object type, AbstractSession session)
      INTERNAL: Return the implementor for a specified type

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

    • getTypeForImplementor

      protected Object getTypeForImplementor(Class<?> implementor)
      INTERNAL: Return the type for a specified implementor

    • 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
      Parameters:
      classLoader - TODO

    • initialize

      public void initialize(AbstractSession session)
      INTERNAL: Initialize the mapping.
      Overrides:
      initialize in class ForeignReferenceMapping

    • initializeForeignKeys

      protected void initializeForeignKeys(AbstractSession session)
      INTERNAL: The foreign key names and their primary keys are converted to DatabaseField and stored.

    • initializeSelectionCriteria

      public void initializeSelectionCriteria(AbstractSession session)
      INTERNAL: Selection criteria is created with source foreign keys and target keys. This criteria is then used to read target records from the table.

    • isVariableOneToOneMapping

      public boolean isVariableOneToOneMapping()
      INTERNAL:
      Overrides:
      isVariableOneToOneMapping in class DatabaseMapping

    • getPrimaryKeyForObject

      protected Object getPrimaryKeyForObject(Object object, AbstractSession session)
      INTERNAL:
      Overrides:
      getPrimaryKeyForObject in class ObjectReferenceMapping

    • preInitialize

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

    • setSourceToTargetQueryKeyFields

      protected void setSourceToTargetQueryKeyFields(Map sourceToTargetQueryKeyNames)
      INTERNAL: Set the source keys to target keys fields association.

    • setTypeField

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

    • setTypeIndicatorTranslation

      protected void setTypeIndicatorTranslation(Map translations)
      INTERNAL: Set the typeIndicatorTranslations hashtable to the new Hashtable translations

    • setTypeIndicatorNameTranslation

      protected void setTypeIndicatorNameTranslation(Map translations)
      INTERNAL: For avoiding classpath dependencies on the Mapping Workbench

    • valueFromObject

      public Object valueFromObject(Object object, DatabaseField field, AbstractSession session)
      INTERNAL: Get a value from the object and set that in the respective field of the row.
      Overrides:
      valueFromObject in class DatabaseMapping
      Parameters:
      object - TODO
      field - TODO
      session - TODO
      Returns:
      TODO

    • valueFromRow

      public Object valueFromRow(AbstractRecord row, JoinedAttributeManager joinManager, ObjectBuildingQuery sourceQuery, CacheKey cacheKey, AbstractSession executionSession, boolean isTargetProtected, Boolean[] wasCacheUsed) throws DatabaseException
      INTERNAL: Return the value of the 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

    • writeFromNullObjectIntoRow

      protected void writeFromNullObjectIntoRow(AbstractRecord record)
      INTERNAL: Get a value from the object and set that in the respective field of the row.

    • writeFromObjectIntoRow

      public void writeFromObjectIntoRow(Object object, AbstractRecord record, 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(ChangeRecord changeRecord, AbstractRecord record, 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, AbstractRecord record, AbstractSession session)
      INTERNAL: This row is built for shallow insert which happens in case of bidirectional inserts. The foreign keys must be set to null to avoid constraints.
      Overrides:
      writeFromObjectIntoRowForShallowInsert in class DatabaseMapping

    • writeFromObjectIntoRowForUpdateAfterShallowInsert

      public void writeFromObjectIntoRowForUpdateAfterShallowInsert(Object object, AbstractRecord row, AbstractSession session, DatabaseTable table)
      INTERNAL: This row is built for update after shallow insert which happens in case of bidirectional inserts. It contains the foreign keys with non null values that were set to null for shallow insert. If mapping overrides writeFromObjectIntoRowForShallowInsert method it must override this one, too.
      Overrides:
      writeFromObjectIntoRowForUpdateAfterShallowInsert in class DatabaseMapping

    • writeFromObjectIntoRowForShallowInsertWithChangeRecord

      public void writeFromObjectIntoRowForShallowInsertWithChangeRecord(ChangeRecord changeRecord, AbstractRecord record, 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, 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(AbstractRecord record, AbstractSession session)
      INTERNAL: Write fields needed for insert into the template for with null values.
      Overrides:
      writeInsertFieldsIntoRow in class DatabaseMapping