Module org.eclipse.persistence.jpa
Package org.eclipse.persistence.internal.jpa.metadata.accessors.mappings

Class ObjectAccessor

java.lang.Object
org.eclipse.persistence.internal.jpa.metadata.ORMetadata
org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.RelationshipAccessor
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.ObjectAccessor
Direct Known Subclasses:
ManyToOneAccessor, OneToOneAccessor, VariableOneToOneAccessor
public abstract class ObjectAccessor extends RelationshipAccessor
INTERNAL: A single object relationship accessor. Key notes: - any metadata mapped from XML to this class must be compared in the equals method. - any metadata mapped from XML to this class must be handled in the merge method. (merging is done at the accessor/mapping level) - any metadata mapped from XML to this class must be initialized in the initXMLObject method. - methods should be preserved in alphabetical order.
Since:
TopLink EJB 3.0 Reference Implementation

  • Constructor Details

  • Method Details

    • equals

      public boolean equals(Object objectToCompare)
      INTERNAL:
      Overrides:
      equals in class RelationshipAccessor

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class RelationshipAccessor

    • derivesId

      public boolean derivesId()
      INTERNAL: Return true is this accessor is a derived id accessor.
      Overrides:
      derivesId in class MappingAccessor
      See Also:

    • getAttributeType

      public String getAttributeType()
      INTERNAL: The attribute type for virtual object accessors is the target entity.
      Overrides:
      getAttributeType in class MappingAccessor

    • getDefaultFetchType

      public String getDefaultFetchType()
      INTERNAL: Return the default fetch type for an object mapping.
      Specified by:
      getDefaultFetchType in class RelationshipAccessor

    • getId

      public Boolean getId()
      INTERNAL:

    • getMapsId

      public String getMapsId()
      INTERNAL: Used for OX mapping.

    • getPrimaryKeyForeignKey

      public PrimaryKeyForeignKeyMetadata getPrimaryKeyForeignKey()
      INTERNAL: Used for OX mapping.

    • getPrimaryKeyJoinColumns

      public List<PrimaryKeyJoinColumnMetadata> getPrimaryKeyJoinColumns()
      INTERNAL: Used for OX mapping.

    • getOptional

      public Boolean getOptional()
      INTERNAL: Used for OX mapping.

    • getReferenceClass

      public MetadataClass getReferenceClass()
      INTERNAL: If a target entity is specified in metadata, it will be set as the reference class, otherwise we will use the raw class.
      Overrides:
      getReferenceClass in class MappingAccessor

    • getSimplePKType

      protected MetadataClass getSimplePKType()
      INTERNAL: Used to process primary keys and DerivedIds.

    • hasAttributeType

      public boolean hasAttributeType()
      INTERNAL: Object accessors don't require a separate attribute-type specification in XML, instead they can use the reference class to determine the attribute-type.
      Overrides:
      hasAttributeType in class MappingAccessor

    • hasId

      protected boolean hasId()
      INTERNAL:

    • hasMapsId

      protected boolean hasMapsId()
      INTERNAL:

    • initManyToOneMapping

      protected ObjectReferenceMapping initManyToOneMapping()
      INTERNAL: Initialize a ManyToOneMapping.

    • initOneToOneMapping

      protected ObjectReferenceMapping initOneToOneMapping()
      INTERNAL: Initialize a OneToOneMapping.

    • initXMLObject

      public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)
      INTERNAL:
      Overrides:
      initXMLObject in class RelationshipAccessor

    • isOneToOnePrimaryKeyRelationship

      public boolean isOneToOnePrimaryKeyRelationship()
      INTERNAL: Return true if this accessor represents a 1-1 primary key relationship.

    • isOptional

      public boolean isOptional()
      INTERNAL:

    • processAssociationOverride

      protected void processAssociationOverride(AssociationOverrideMetadata associationOverride, EmbeddableMapping embeddableMapping, MetadataDescriptor owningDescriptor)
      INTERNAL: Process an association override for either an embedded object mapping, or a map mapping (element-collection, 1-M and M-M) containing an embeddable object as the value or key.
      Overrides:
      processAssociationOverride in class MappingAccessor

    • processAssociationOverride

      protected void processAssociationOverride(AssociationOverrideMetadata associationOverride, EmbeddableMapping embeddableMapping, DatabaseTable defaultTable, MetadataDescriptor owningDescriptor)
      INTERNAL: Process an association override for either an embedded object mapping, or a map mapping (element-collection, 1-M and M-M) containing an embeddable object as the value or key.

    • processId

      protected void processId(OneToOneMapping mapping)
      INTERNAL: Used to process primary keys and DerivedIds.

    • processMapsId

      protected void processMapsId(OneToOneMapping oneToOneMapping)
      INTERNAL: Process the mapping keys from the maps id value.

    • processMapsIdFields

      protected void processMapsIdFields(OneToOneMapping oneToOneMapping, EmbeddedIdAccessor embeddedIdAccessor, MappingAccessor mapsIdAccessor)
      INTERNAL: We're going to add field name translations where necessary. If the user specified (erroneously that is) attribute overrides this will override them.

    • processForeignKeyRelationship

      protected void processForeignKeyRelationship(ObjectReferenceMapping mapping)
      INTERNAL: Process the join columns for the owning side of a one to one mapping. The default pk and pk field names are used only with single primary key entities. The processor should never get as far as to use them with entities that have a composite primary key (validation exception will be thrown).

    • processOneToOnePrimaryKeyRelationship

      protected void processOneToOnePrimaryKeyRelationship(OneToOneMapping mapping)
      INTERNAL: Process the primary key join columns for the owning side of a one to one mapping. The default pk and pk field names are used only with single primary key entities. The processor should never get as far as to use them with entities that have a composite primary key (validation exception will be thrown).

    • processOwningMappingKeys

      protected void processOwningMappingKeys(OneToOneMapping mapping)
      INTERNAL: Process the the correct metadata for the owning side of a one to one mapping. Note, the order of checking is important, that is, check for a mapsId first.

    • setId

      public void setId(Boolean id)
      INTERNAL: Used for OX mapping.

    • setMapsId

      public void setMapsId(String mapsId)
      INTERNAL: Used for OX mapping.

    • setOptional

      public void setOptional(Boolean isOptional)
      INTERNAL: Used for OX mapping.

    • setPrimaryKeyForeignKey

      public void setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey)
      INTERNAL: Used for OX mapping.

    • setPrimaryKeyJoinColumns

      public void setPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns)
      INTERNAL: Used for OX mapping.