Module org.eclipse.persistence.jpa

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

Class BasicAccessor

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

org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.BasicAccessor

Direct Known Subclasses:

IdAccessor, TransformationAccessor, VersionAccessor

public class BasicAccessor
extends DirectAccessor

INTERNAL: A relational accessor. A Basic annotation may or may not be present on the accessible object. 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

Field Summary

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

KEY_DOT_NOTATION, m_field, VALUE_DOT_NOTATION

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

m_project

Constructor Summary

Constructors

Constructor	Description
BasicAccessor()	INTERNAL: Used for OX mapping.
BasicAccessor(String xmlElement)	INTERNAL:
BasicAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor)	INTERNAL:

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	INTERNAL:
CacheIndexMetadata	getCacheIndex()	INTERNAL: Used for OX mapping.
ColumnMetadata	getColumn()	INTERNAL: Used for OX mapping.
protected ColumnMetadata	getColumn(String loggingCtx)	INTERNAL: Return the column from xml if there is one, otherwise look for an annotation.
protected DatabaseField	getDatabaseField()	INTERNAL:
String	getDefaultFetchType()	INTERNAL:
GeneratedValueMetadata	getGeneratedValue()	INTERNAL: Used for OX mapping.
IndexMetadata	getIndex()	INTERNAL: Used for OX mapping.
Boolean	getMutable()	INTERNAL: Used for OX mapping.
ReturnInsertMetadata	getReturnInsert()	INTERNAL: Used for OX mapping.
Boolean	getReturnUpdate()	INTERNAL: Used for OX mapping.
SequenceGeneratorMetadata	getSequenceGenerator()	INTERNAL: Used for OX mapping.
TableGeneratorMetadata	getTableGenerator()	INTERNAL: Used for OX mapping.
UuidGeneratorMetadata	getUuidGenerator()	INTERNAL: Used for OX mapping.
int	hashCode()
void	initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)	INTERNAL:
boolean	isBasic()	INTERNAL: Return true if this accessor represents a basic mapping.
protected boolean	isCollectionClass(MetadataClass cls)	INTERNAL: Method to return whether a class is a collection or not.
protected boolean	isMapClass(MetadataClass cls)	INTERNAL: Method to return whether a class is a map or not.
Boolean	isReturnUpdate()	INTERNAL: USed for OX mapping
void	process()	INTERNAL: Process a basic accessor.
protected void	processCacheIndex()	INTERNAL: Process cache index.
protected void	processEnumerated(EnumeratedMetadata enumerated, DatabaseMapping mapping, MetadataClass referenceClass, boolean isForMapKey)	INTERNAL: Process an Enumerated annotation.
protected void	processGeneratedValue()	INTERNAL: Process the generated value metadata.
protected void	processIndex()	INTERNAL: Process index information for the given mapping.
protected void	processLob(LobMetadata lob, DatabaseMapping mapping, MetadataClass referenceClass, boolean isForMapKey)	INTERNAL: Process a Lob metadata.
protected void	processReturnInsert()	INTERNAL: Process a ReturnInsert annotation.
protected void	processReturnUpdate()	INTERNAL: Process a return update setting.
void	setCacheIndex(CacheIndexMetadata index)	INTERNAL: Used for OX mapping.
void	setColumn(ColumnMetadata column)	INTERNAL: Used for OX mapping.
void	setGeneratedValue(GeneratedValueMetadata value)	INTERNAL: Used for OX mapping.
void	setIndex(IndexMetadata index)	INTERNAL: Used for OX mapping.
void	setMutable(Boolean mutable)	INTERNAL: Used for OX mapping.
void	setReturnInsert(ReturnInsertMetadata returnInsert)	INTERNAL: Used for OX mapping.
void	setReturnUpdate(Boolean returnUpdate)	INTERNAL: Used for OX mapping.
void	setSequenceGenerator(SequenceGeneratorMetadata sequenceGenerator)	INTERNAL: Used for OX mapping.
void	setTableGenerator(TableGeneratorMetadata tableGenerator)	INTERNAL: Used for OX mapping.
void	setUuidGenerator(UuidGeneratorMetadata uuidGenerator)	INTERNAL: Used for OX mapping.

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

addConvert, getConvert, getConverts, getEnumerated, getEnumerated, getFetch, getLob, getLob, getOptional, getTemporal, getTemporal, hasEnumerated, hasLob, hasTemporal, isOptional, setConverts, setEnumerated, setFetch, setLob, setOptional, setTemporal, setTemporal, usesIndirection

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

addConvertMetadata, addFieldNameTranslation, addMapKeyConvert, derivesId, getAnnotation, getAssociationOverrides, getAttributeName, getAttributeOverride, getAttributeOverrides, getAttributeType, getClassAccessor, getConverts, getDatabaseField, getDefaultTableForEntityMapKey, getField, getForeignKey, getGetMethodName, getJoinColumns, getJoinColumnsAndValidate, getMapKey, getMapKeyConverts, getMapKeyReferenceClass, getMapKeyReferenceClassName, getMapKeyReferenceClassWithGenerics, getMapping, getOwningDescriptor, getOwningDescriptors, getRawClass, getRawClassWithGenerics, getReferenceAccessors, getReferenceClass, getReferenceClassFromGeneric, getReferenceClassName, getReferenceClassWithGenerics, getReferenceDatabaseTable, getReferenceDescriptor, getSetMethodName, hasAttributeOverride, hasAttributeType, hasMapKey, hasReturnInsert, hasReturnUpdate, initXMLMappingAccessor, isAnnotationPresent, isBasicCollection, isBasicMap, isCollectionAccessor, isDerivedIdClass, isDirectCollection, isDirectEmbeddableCollection, isEmbedded, isEmbeddedId, isEnumerated, isId, isJson, isLob, isManyToMany, isManyToOne, isMapAccessor, isMappedKeyMapAccessor, isMultitenantId, isOneToMany, isOneToOne, isPrimitiveWrapperClass, isProcessed, isRelationship, isSerialized, isTemporal, isTimeClass, isTransient, isUUID, isValidJsonType, isValidSerializedType, isVariableOneToOne, processAssociationOverride, processAssociationOverrides, processAttributeOverrides, processContainerPolicyAndIndirection, processConvert, processConverts, processDirectMapKeyClass, processEmbeddableMapKeyClass, processEntityMapKeyClass, processForeignKeyRelationship, processIndirection, processJoinFetch, processJson, processMapKeyClass, processMappingConverter, processMappingKeyConverter, processMappingValueConverter, processProperties, processProperty, processReturnInsertAndUpdate, processSerialized, processSerialized, processTemporal, processUUID, setAccessorMethods, setAttributeType, setClassAccessor, setField, setIndirectionPolicy, setMapping, setOverrideMapping, toString, updatePrimaryKeyField, usesFieldAccess, usesPropertyAccess, usesVirtualAccess

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

getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getConverters, getDefaultAttributeName, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getIdentifier, getJavaClass, getJavaClassName, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReferencedField, getReferencedField, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getUpperCaseShortJavaClassName, getValue, getValue, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, merge, processConverters, processCustomConverters, processObjectTypeConverters, processPartitioned, processPartitioning, processPrimaryKeyJoinColumns, processSerializedConverters, processStructConverters, processTable, processTypeConverters, 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, getBoxedType, getDatabaseTypeEnum, getEntityMappings, getFullyQualifiedClassName, getJavaClass, getJavaClassName, getLoader, getLocation, getLogger, getMetadataClass, getMetadataClass, getMetadataClass, getMetadataFactory, getName, getPrimitiveClassForName, getProject, getText, getXMLElement, hasIdentifier, hasText, initXMLClassName, initXMLObject, initXMLObjects, initXMLTextObject, loadedFromAnnotation, loadedFromEclipseLinkXML, loadedFromXML, mergeORObjectLists, mergeORObjects, mergeSimpleObjects, reloadEntity, reloadMappedSuperclass, setAccessibleObject, setEntityMappings, setFieldName, setFieldName, setProject, shouldOverride, valuesMatch, valuesMatch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicAccessor

public BasicAccessor()

INTERNAL: Used for OX mapping.

BasicAccessor

public BasicAccessor(String xmlElement)

INTERNAL:

BasicAccessor

public BasicAccessor(MetadataAnnotation annotation,
                     MetadataAccessibleObject accessibleObject,
                     ClassAccessor classAccessor)

INTERNAL:

Method Detail

equals

public boolean equals(Object objectToCompare)

INTERNAL:

Overrides:

equals in class DirectAccessor

hashCode

public int hashCode()

Overrides:

hashCode in class DirectAccessor

getColumn

public ColumnMetadata getColumn()

INTERNAL: Used for OX mapping.

getColumn

protected ColumnMetadata getColumn(String loggingCtx)

INTERNAL: Return the column from xml if there is one, otherwise look for an annotation.

Overrides:

getColumn in class MappingAccessor

See Also:

BasicAccessor, BasicCollectionAccessor, BasicMapAccessor, ElementCollectionAccessor, CollectionAccessor

getDefaultFetchType

public String getDefaultFetchType()

INTERNAL:

Specified by:

getDefaultFetchType in class DirectAccessor

getDatabaseField

protected DatabaseField getDatabaseField()

INTERNAL:

getGeneratedValue

public GeneratedValueMetadata getGeneratedValue()

INTERNAL: Used for OX mapping.

getMutable

public Boolean getMutable()

INTERNAL: Used for OX mapping.

getReturnInsert

public ReturnInsertMetadata getReturnInsert()

INTERNAL: Used for OX mapping.

getReturnUpdate

public Boolean getReturnUpdate()

INTERNAL: Used for OX mapping.

getSequenceGenerator

public SequenceGeneratorMetadata getSequenceGenerator()

INTERNAL: Used for OX mapping.

getTableGenerator

public TableGeneratorMetadata getTableGenerator()

INTERNAL: Used for OX mapping.

getUuidGenerator

public UuidGeneratorMetadata getUuidGenerator()

INTERNAL: Used for OX mapping.

initXMLObject

public void initXMLObject(MetadataAccessibleObject accessibleObject,
                          XMLEntityMappings entityMappings)

INTERNAL:

Overrides:

initXMLObject in class DirectAccessor

isBasic

public boolean isBasic()

INTERNAL: Return true if this accessor represents a basic mapping.

Overrides:

isBasic in class MappingAccessor

isCollectionClass

protected boolean isCollectionClass(MetadataClass cls)

INTERNAL: Method to return whether a class is a collection or not.

isMapClass

protected boolean isMapClass(MetadataClass cls)

INTERNAL: Method to return whether a class is a map or not.

isReturnUpdate

public Boolean isReturnUpdate()

INTERNAL: USed for OX mapping

process

public void process()

INTERNAL: Process a basic accessor.

Specified by:

process in class MetadataAccessor

processEnumerated

protected void processEnumerated(EnumeratedMetadata enumerated,
                                 DatabaseMapping mapping,
                                 MetadataClass referenceClass,
                                 boolean isForMapKey)

INTERNAL: Process an Enumerated annotation. The method may still be called if no Enumerated annotation has been specified but the accessor's reference class is a valid enumerated type.

Overrides:

processEnumerated in class MappingAccessor

processGeneratedValue

protected void processGeneratedValue()

INTERNAL: Process the generated value metadata.

processIndex

protected void processIndex()

INTERNAL: Process index information for the given mapping.

processCacheIndex

protected void processCacheIndex()

INTERNAL: Process cache index.

processLob

protected void processLob(LobMetadata lob,
                          DatabaseMapping mapping,
                          MetadataClass referenceClass,
                          boolean isForMapKey)

INTERNAL: Process a Lob metadata. The lob must be specified to process and create a lob type mapping.

Overrides:

processLob in class MappingAccessor

processReturnInsert

protected void processReturnInsert()

INTERNAL: Process a ReturnInsert annotation.

Overrides:

processReturnInsert in class MappingAccessor

See Also:

BasicAccessor

processReturnUpdate

protected void processReturnUpdate()

INTERNAL: Process a return update setting.

Overrides:

processReturnUpdate in class MappingAccessor

See Also:

BasicAccessor

getIndex

public IndexMetadata getIndex()

INTERNAL: Used for OX mapping.

setIndex

public void setIndex(IndexMetadata index)

INTERNAL: Used for OX mapping.

getCacheIndex

public CacheIndexMetadata getCacheIndex()

INTERNAL: Used for OX mapping.

setCacheIndex

public void setCacheIndex(CacheIndexMetadata index)

INTERNAL: Used for OX mapping.

setColumn

public void setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

setGeneratedValue

public void setGeneratedValue(GeneratedValueMetadata value)

INTERNAL: Used for OX mapping.

setMutable

public void setMutable(Boolean mutable)

INTERNAL: Used for OX mapping.

setReturnInsert

public void setReturnInsert(ReturnInsertMetadata returnInsert)

INTERNAL: Used for OX mapping.

setReturnUpdate

public void setReturnUpdate(Boolean returnUpdate)

INTERNAL: Used for OX mapping.

setSequenceGenerator

public void setSequenceGenerator(SequenceGeneratorMetadata sequenceGenerator)

INTERNAL: Used for OX mapping.

setTableGenerator

public void setTableGenerator(TableGeneratorMetadata tableGenerator)

INTERNAL: Used for OX mapping.

setUuidGenerator

public void setUuidGenerator(UuidGeneratorMetadata uuidGenerator)

INTERNAL: Used for OX mapping.