Top Description Fields Constructors Methods
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings

public abstract Class DirectAccessor

extends MappingAccessor
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectCollectionAccessor, org.eclipse.persistence.internal.jpa.metadata.structures.ArrayAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.BasicAccessor
Imports
java.util.ArrayList, .List, org.eclipse.persistence.annotations.Convert, org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, org.eclipse.persistence.internal.jpa.metadata.converters.EnumeratedMetadata, .ConvertMetadata, .LobMetadata, .TemporalMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings
A direct accessor. Subclasses: BasicAccessor, BasicCollectionAccessor, BasicMapAccessor. 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.
Author
Guy Pelletier
Since
TopLink 11g

Field Summary

Modifier and TypeField and Description
private String
m_convert

private List<ConvertMetadata>
m_converts

private EnumeratedMetadata
m_enumerated

private String
m_fetch

private LobMetadata
m_lob

private Boolean
m_optional

private TemporalMetadata
m_temporal

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor:
KEY_DOT_NOTATIONm_fieldVALUE_DOT_NOTATION

Constructor Summary

AccessConstructor and Description
protected
DirectAccessor(String xmlElement)

INTERNAL:

protected
DirectAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor)

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
protected void
addConvert(ConvertMetadata convert)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.addConvert.

INTERNAL: Subclasses that support key converts need to override this method.
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.equals.

INTERNAL:
public String
getConvert()

INTERNAL:

public List<ConvertMetadata>
getConverts()

INTERNAL: Used for OX mapping.

public abstract String
getDefaultFetchType()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultFetchType.

INTERNAL:
public EnumeratedMetadata
getEnumerated()

INTERNAL: Used for OX mapping.

public EnumeratedMetadata
getEnumerated(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getEnumerated.

INTERNAL: Return the enumerated metadata for this accessor.
public String
getFetch()

INTERNAL: Used for OX mapping.

public LobMetadata
getLob()

INTERNAL: Used for OX mapping.

public LobMetadata
getLob(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getLob.

INTERNAL: Return the lob metadata for this accessor.
public Boolean
getOptional()

INTERNAL: Used for OX mapping.

public TemporalMetadata
getTemporal()

INTERNAL: Used for OX mapping.

public TemporalMetadata
getTemporal(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getTemporal.

INTERNAL: Return the temporal metadata for this accessor.
public boolean
hasEnumerated(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasEnumerated.

INTERNAL: Return true if this accessor has enumerated metadata.
public int
hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hashCode.

Returns a hash code value for the object.
public boolean
hasLob(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasLob.

INTERNAL: Return true if this accessor has lob metadata.
public boolean
hasTemporal(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasTemporal.

INTERNAL: Return true if this accessor has temporal metadata.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.initXMLObject.

INTERNAL:
public boolean
isOptional()

INTERNAL:

public void
setConverts(List<ConvertMetadata> converts)

INTERNAL: Used for OX mapping.

public void
setEnumerated(EnumeratedMetadata enumerated)

INTERNAL: Used for OX mapping.

public void
setFetch(String fetch)

INTERNAL: Used for OX mapping.

public void
setLob(LobMetadata lob)

INTERNAL: Used for OX mapping.

public void
setOptional(Boolean optional)

INTERNAL: Used for OX mapping.

public void
setTemporal(TemporalMetadata metadata, boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.setTemporal.

INTERNAL: Set the temporal metadata for this accessor.
public void
setTemporal(TemporalMetadata temporalType)

INTERNAL: Used for OX mapping.

protected boolean
usesIndirection()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.usesIndirection.

INTERNAL:
Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor:
addConvertMetadataaddFieldNameTranslationaddMapKeyConvertderivesIdgetAnnotationgetAssociationOverridesgetAttributeNamegetAttributeOverridegetAttributeOverridesgetAttributeTypegetClassAccessorgetColumngetConvertsgetDatabaseFieldgetDefaultTableForEntityMapKeygetFieldgetForeignKeygetGetMethodNamegetJoinColumnsgetJoinColumnsAndValidategetMapKeygetMapKeyConvertsgetMapKeyReferenceClassgetMapKeyReferenceClassNamegetMapKeyReferenceClassWithGenericsgetMappinggetOwningDescriptorgetOwningDescriptorsgetRawClassgetRawClassWithGenericsgetReferenceAccessorsgetReferenceClassgetReferenceClassFromGenericgetReferenceClassNamegetReferenceClassWithGenericsgetReferenceDatabaseTablegetReferenceDescriptorgetSetMethodNamehasAttributeOverridehasAttributeTypehasMapKeyhasReturnInserthasReturnUpdateinitXMLMappingAccessorisAnnotationPresentisBasicisBasicCollectionisBasicMapisCollectionAccessorisDerivedIdClassisDirectCollectionisDirectEmbeddableCollectionisEmbeddedisEmbeddedIdisEnumeratedisIdisJsonisLobisManyToManyisManyToOneisMapAccessorisMappedKeyMapAccessorisMultitenantIdisOneToManyisOneToOneisPrimitiveWrapperClassisProcessedisRelationshipisSerializedisTemporalisTimeClassisTransientisUUIDisValidJsonTypeisValidSerializedTypeisVariableOneToOneprocessAssociationOverrideprocessAssociationOverridesprocessAttributeOverridesprocessContainerPolicyAndIndirectionprocessConvertprocessConvertsprocessDirectMapKeyClassprocessEmbeddableMapKeyClassprocessEntityMapKeyClassprocessEnumeratedprocessForeignKeyRelationshipprocessIndirectionprocessJoinFetchprocessJsonprocessLobprocessMapKeyClassprocessMappingConverterprocessMappingKeyConverterprocessMappingValueConverterprocessPropertiesprocessPropertyprocessReturnInsertprocessReturnInsertAndUpdateprocessReturnUpdateprocessSerializedprocessSerializedprocessTemporalprocessUUIDsetAccessorMethodssetAttributeTypesetClassAccessorsetFieldsetIndirectionPolicysetMappingsetOverrideMappingtoStringupdatePrimaryKeyFieldusesFieldAccessusesPropertyAccessusesVirtualAccess

Field Detail

m_convertback to summary
private String m_convert
m_convertsback to summary
private List<ConvertMetadata> m_converts
m_enumeratedback to summary
private EnumeratedMetadata m_enumerated
m_fetchback to summary
private String m_fetch
m_lobback to summary
private LobMetadata m_lob
m_optionalback to summary
private Boolean m_optional
m_temporalback to summary
private TemporalMetadata m_temporal

Constructor Detail

DirectAccessorback to summary
protected DirectAccessor(String xmlElement)

INTERNAL:

DirectAccessorback to summary
protected DirectAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor)

INTERNAL:

Method Detail

addConvertback to summary
protected void addConvert(ConvertMetadata convert)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.addConvert.

INTERNAL: Subclasses that support key converts need to override this method.

Annotations
@Override
equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.equals.

INTERNAL:

Parameters
objectToCompare:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getConvertback to summary
public String getConvert()

INTERNAL:

getConvertsback to summary
public List<ConvertMetadata> getConverts()

INTERNAL: Used for OX mapping.

getDefaultFetchTypeback to summary
public abstract String getDefaultFetchType()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getDefaultFetchType.

INTERNAL:

Annotations
@Override
getEnumeratedback to summary
public EnumeratedMetadata getEnumerated()

INTERNAL: Used for OX mapping.

getEnumeratedback to summary
public EnumeratedMetadata getEnumerated(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getEnumerated.

INTERNAL: Return the enumerated metadata for this accessor.

Annotations
@Override
getFetchback to summary
public String getFetch()

INTERNAL: Used for OX mapping.

getLobback to summary
public LobMetadata getLob()

INTERNAL: Used for OX mapping.

getLobback to summary
public LobMetadata getLob(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getLob.

INTERNAL: Return the lob metadata for this accessor.

Annotations
@Override
getOptionalback to summary
public Boolean getOptional()

INTERNAL: Used for OX mapping.

getTemporalback to summary
public TemporalMetadata getTemporal()

INTERNAL: Used for OX mapping.

getTemporalback to summary
public TemporalMetadata getTemporal(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.getTemporal.

INTERNAL: Return the temporal metadata for this accessor.

Annotations
@Override
hasEnumeratedback to summary
public boolean hasEnumerated(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasEnumerated.

INTERNAL: Return true if this accessor has enumerated metadata.

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
hasLobback to summary
public boolean hasLob(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasLob.

INTERNAL: Return true if this accessor has lob metadata.

Annotations
@Override
hasTemporalback to summary
public boolean hasTemporal(boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.hasTemporal.

INTERNAL: Return true if this accessor has temporal metadata.

Annotations
@Override
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.initXMLObject.

INTERNAL:

Annotations
@Override
isOptionalback to summary
public boolean isOptional()

INTERNAL:

setConvertsback to summary
public void setConverts(List<ConvertMetadata> converts)

INTERNAL: Used for OX mapping.

setEnumeratedback to summary
public void setEnumerated(EnumeratedMetadata enumerated)

INTERNAL: Used for OX mapping.

setFetchback to summary
public void setFetch(String fetch)

INTERNAL: Used for OX mapping.

setLobback to summary
public void setLob(LobMetadata lob)

INTERNAL: Used for OX mapping.

setOptionalback to summary
public void setOptional(Boolean optional)

INTERNAL: Used for OX mapping.

setTemporalback to summary
public void setTemporal(TemporalMetadata metadata, boolean isForMapKey)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.setTemporal.

Doc from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.setTemporal.

INTERNAL: Set the temporal metadata for this accessor.

Annotations
@Override
setTemporalback to summary
public void setTemporal(TemporalMetadata temporalType)

INTERNAL: Used for OX mapping.

usesIndirectionback to summary
protected boolean usesIndirection()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.usesIndirection.

INTERNAL:

Annotations
@Override