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

Author:

Guy Pelletier

Method Summary

Modifier and Type	Method and Description
boolean	derivesId() INTERNAL: Return true is this accessor is a derived id accessor.
boolean	equals(java.lang.Object objectToCompare) INTERNAL:
java.lang.String	getAttributeType() INTERNAL: The attribute type for virtual object accessors is the target entity.
java.lang.String	getDefaultFetchType() INTERNAL: Return the default fetch type for an object mapping.
java.lang.Boolean	getId() INTERNAL:
java.lang.String	getMapsId() INTERNAL: Used for OX mapping.
java.lang.Boolean	getOptional() INTERNAL: Used for OX mapping.
PrimaryKeyForeignKeyMetadata	getPrimaryKeyForeignKey() INTERNAL: Used for OX mapping.
java.util.List<PrimaryKeyJoinColumnMetadata>	getPrimaryKeyJoinColumns() INTERNAL: Used for OX mapping.
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.
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.
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
boolean	isOneToOnePrimaryKeyRelationship() INTERNAL: Return true if this accessor represents a 1-1 primary key relationship.
boolean	isOptional() INTERNAL:
void	setId(java.lang.Boolean id) INTERNAL: Used for OX mapping.
void	setMapsId(java.lang.String mapsId) INTERNAL: Used for OX mapping.
void	setOptional(java.lang.Boolean isOptional) INTERNAL: Used for OX mapping.
void	setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey) INTERNAL: Used for OX mapping.
void	setPrimaryKeyJoinColumns(java.util.List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns) INTERNAL: Used for OX mapping.

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.RelationshipAccessor

getBatchFetch, getCascade, getCascadeOnDelete, getFetch, getForeignKey, getJoinColumns, getJoinFetch, getJoinFields, getJoinTable, getMappedBy, getNonCacheable, getOrphanRemoval, getPrivateOwned, getReferenceDescriptor, getTargetEntity, getTargetEntityName, hasMappedBy, isCascadeOnDelete, isLazy, isNonCacheable, isPrivateOwned, isValueHolderInterface, process, setBatchFetch, setCascade, setCascadeOnDelete, setFetch, setForeignKey, setJoinColumns, setJoinFetch, setJoinFields, setJoinTable, setMappedBy, setNonCacheable, setOrphanRemoval, setPrivateOwned, setTargetEntity, setTargetEntityName

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor

getAttributeName, getClassAccessor, getEnumerated, getField, getGetMethodName, getLob, getMapKey, getMapKeyReferenceClass, getMapKeyReferenceClassName, getMapKeyReferenceClassWithGenerics, getMapping, getOwningDescriptor, getOwningDescriptors, getRawClass, getRawClassWithGenerics, getReferenceAccessors, getReferenceClassFromGeneric, getReferenceClassName, getReferenceClassWithGenerics, getSetMethodName, getTemporal, hasMapKey, hasTemporal, initXMLMappingAccessor, isAnnotationPresent, isBasic, isBasicCollection, isBasicMap, isCollectionAccessor, isDerivedIdClass, isDirectCollection, isDirectEmbeddableCollection, isEmbedded, isEmbeddedId, isId, isManyToMany, isManyToOne, isMapAccessor, isMappedKeyMapAccessor, isMultitenantId, isOneToMany, isOneToOne, isProcessed, isRelationship, isSerialized, isTransient, isVariableOneToOne, setAttributeType, setClassAccessor, setField, toString, usesFieldAccess, usesPropertyAccess, usesVirtualAccess

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor

getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getConverters, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getIdentifier, getJavaClass, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, merge, processConverters, processPartitioned, setAccess, setAccessMethods, setConverters, setDescriptor, setHashPartitioning, setName, setObjectTypeConverters, setPartitioned, setPartitioning, setPinnedPartitioning, setProperties, setRangePartitioning, setReplicationPartitioning, setRoundRobinPartitioning, setSerializedConverters, setStructConverters, setTypeConverters, setUnionPartitioning, setValuePartitioning

Methods inherited from class org.eclipse.persistence.internal.jpa.metadata.ORMetadata

getAccessibleObjectName, getAnnotation, getEntityMappings, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getProject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, setAccessibleObject, setEntityMappings, setProject, shouldOverride

Methods inherited from class java.lang.Object

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

Method Detail

equals

public boolean equals(java.lang.Object objectToCompare)

INTERNAL:

Overrides:

equals 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:

ObjectAccessor

getAttributeType

public java.lang.String getAttributeType()

INTERNAL: The attribute type for virtual object accessors is the target entity.

Overrides:

getAttributeType in class MappingAccessor

getDefaultFetchType

public java.lang.String getDefaultFetchType()

INTERNAL: Return the default fetch type for an object mapping.

Specified by:

getDefaultFetchType in class RelationshipAccessor

getId

public java.lang.Boolean getId()

INTERNAL:

getMapsId

public java.lang.String getMapsId()

INTERNAL: Used for OX mapping.

getPrimaryKeyForeignKey

public PrimaryKeyForeignKeyMetadata getPrimaryKeyForeignKey()

INTERNAL: Used for OX mapping.

getPrimaryKeyJoinColumns

public java.util.List<PrimaryKeyJoinColumnMetadata> getPrimaryKeyJoinColumns()

INTERNAL: Used for OX mapping.

getOptional

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

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

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:

setId

public void setId(java.lang.Boolean id)

INTERNAL: Used for OX mapping.

setMapsId

public void setMapsId(java.lang.String mapsId)

INTERNAL: Used for OX mapping.

setOptional

public void setOptional(java.lang.Boolean isOptional)

INTERNAL: Used for OX mapping.

setPrimaryKeyForeignKey

public void setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey)

INTERNAL: Used for OX mapping.

setPrimaryKeyJoinColumns

public void setPrimaryKeyJoinColumns(java.util.List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns)

INTERNAL: Used for OX mapping.