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

public Class BasicAccessor

extends DirectAccessor
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.IdAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.TransformationAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.VersionAccessor
Imports
java.util.Collection, .Map, org.eclipse.persistence.annotations.CacheIndex, .Index, .Mutable, .ReturnInsert, .ReturnUpdate, .UuidGenerator, org.eclipse.persistence.exceptions.ValidationException, org.eclipse.persistence.internal.helper.DatabaseField, org.eclipse.persistence.internal.jpa.metadata.MetadataDescriptor, .MetadataLogger, org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor, org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject, .MetadataAnnotation, .MetadataClass, org.eclipse.persistence.internal.jpa.metadata.cache.CacheIndexMetadata, org.eclipse.persistence.internal.jpa.metadata.columns.ColumnMetadata, org.eclipse.persistence.internal.jpa.metadata.converters.EnumeratedMetadata, .LobMetadata, org.eclipse.persistence.internal.jpa.metadata.mappings.ReturnInsertMetadata, org.eclipse.persistence.internal.jpa.metadata.sequencing.GeneratedValueMetadata, .SequenceGeneratorMetadata, .TableGeneratorMetadata, .UuidGeneratorMetadata, org.eclipse.persistence.internal.jpa.metadata.tables.IndexMetadata, org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings, org.eclipse.persistence.mappings.DatabaseMapping, org.eclipse.persistence.mappings.foundation.AbstractDirectMapping
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.
Author
Guy Pelletier
Since
TopLink EJB 3.0 Reference Implementation

Field Summary

Modifier and TypeField and Description
private CacheIndexMetadata
m_cacheIndex

private ColumnMetadata
m_column

private DatabaseField
m_databaseField

private GeneratedValueMetadata
m_generatedValue

private IndexMetadata
m_index

private Boolean
m_mutable

private ReturnInsertMetadata
m_returnInsert

private Boolean
m_returnUpdate

private SequenceGeneratorMetadata
m_sequenceGenerator

private TableGeneratorMetadata
m_tableGenerator

private UuidGeneratorMetadata
m_uuidGenerator

Constructor Summary

AccessConstructor and Description
public
BasicAccessor()

INTERNAL: Used for OX mapping.

public
BasicAccessor(String xmlElement)

INTERNAL:

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

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
objectToCompare)

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

INTERNAL:
public CacheIndexMetadata
getCacheIndex()

INTERNAL: Used for OX mapping.

public ColumnMetadata
getColumn()

INTERNAL: Used for OX mapping.

protected ColumnMetadata
getColumn(String loggingCtx)

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

INTERNAL: Return the column from xml if there is one, otherwise look for an annotation.
protected DatabaseField
getDatabaseField()

INTERNAL:

public String
getDefaultFetchType()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor.getDefaultFetchType.

INTERNAL:
public GeneratedValueMetadata
getGeneratedValue()

INTERNAL: Used for OX mapping.

public IndexMetadata
getIndex()

INTERNAL: Used for OX mapping.

public Boolean
getMutable()

INTERNAL: Used for OX mapping.

public ReturnInsertMetadata
getReturnInsert()

INTERNAL: Used for OX mapping.

public Boolean
getReturnUpdate()

INTERNAL: Used for OX mapping.

public SequenceGeneratorMetadata
getSequenceGenerator()

INTERNAL: Used for OX mapping.

public TableGeneratorMetadata
getTableGenerator()

INTERNAL: Used for OX mapping.

public UuidGeneratorMetadata
getUuidGenerator()

INTERNAL: Used for OX mapping.

public int
hashCode()

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

Returns a hash code value for the object.
public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:
public boolean
isBasic()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor.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.

public Boolean
isReturnUpdate()

INTERNAL: USed for OX mapping

public void
process()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor.process.

INTERNAL: Process a basic accessor.
protected void
processCacheIndex()

INTERNAL: Process cache index.

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

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

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)

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

INTERNAL: Process a Lob metadata.
protected void
processReturnInsert()

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

INTERNAL: Process a ReturnInsert annotation.
protected void
processReturnUpdate()

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

INTERNAL: Process a return update setting.
public void
setCacheIndex(CacheIndexMetadata index)

INTERNAL: Used for OX mapping.

public void
setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

public void
setGeneratedValue(GeneratedValueMetadata value)

INTERNAL: Used for OX mapping.

public void
setIndex(IndexMetadata index)

INTERNAL: Used for OX mapping.

public void
setMutable(Boolean mutable)

INTERNAL: Used for OX mapping.

public void
setReturnInsert(ReturnInsertMetadata returnInsert)

INTERNAL: Used for OX mapping.

public void
setReturnUpdate(Boolean returnUpdate)

INTERNAL: Used for OX mapping.

public void
setSequenceGenerator(SequenceGeneratorMetadata sequenceGenerator)

INTERNAL: Used for OX mapping.

public void
setTableGenerator(TableGeneratorMetadata tableGenerator)

INTERNAL: Used for OX mapping.

public void
setUuidGenerator(UuidGeneratorMetadata uuidGenerator)

INTERNAL: Used for OX mapping.

Inherited from org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor:
addConvertgetConvertgetConvertsgetEnumeratedgetEnumeratedgetFetchgetLobgetLobgetOptionalgetTemporalgetTemporalhasEnumeratedhasLobhasTemporalisOptionalsetConvertssetEnumeratedsetFetchsetLobsetOptionalsetTemporalsetTemporalusesIndirection

Field Detail

m_cacheIndexback to summary
private CacheIndexMetadata m_cacheIndex
m_columnback to summary
private ColumnMetadata m_column
m_databaseFieldback to summary
private DatabaseField m_databaseField
m_generatedValueback to summary
private GeneratedValueMetadata m_generatedValue
m_indexback to summary
private IndexMetadata m_index
m_mutableback to summary
private Boolean m_mutable
m_returnInsertback to summary
private ReturnInsertMetadata m_returnInsert
m_returnUpdateback to summary
private Boolean m_returnUpdate
m_sequenceGeneratorback to summary
private SequenceGeneratorMetadata m_sequenceGenerator
m_tableGeneratorback to summary
private TableGeneratorMetadata m_tableGenerator
m_uuidGeneratorback to summary
private UuidGeneratorMetadata m_uuidGenerator

Constructor Detail

BasicAccessorback to summary
public BasicAccessor()

INTERNAL: Used for OX mapping.

BasicAccessorback to summary
public BasicAccessor(String xmlElement)

INTERNAL:

BasicAccessorback to summary
public BasicAccessor(MetadataAnnotation annotation, MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor)

INTERNAL:

Method Detail

equalsback to summary
public boolean equals(Object objectToCompare)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor.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
getCacheIndexback to summary
public CacheIndexMetadata getCacheIndex()

INTERNAL: Used for OX mapping.

getColumnback to summary
public ColumnMetadata getColumn()

INTERNAL: Used for OX mapping.

getColumnback to summary
protected ColumnMetadata getColumn(String loggingCtx)

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

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

Annotations
@Override
getDatabaseFieldback to summary
protected DatabaseField getDatabaseField()

INTERNAL:

getDefaultFetchTypeback to summary
public String getDefaultFetchType()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor.getDefaultFetchType.

INTERNAL:

Annotations
@Override
getGeneratedValueback to summary
public GeneratedValueMetadata getGeneratedValue()

INTERNAL: Used for OX mapping.

getIndexback to summary
public IndexMetadata getIndex()

INTERNAL: Used for OX mapping.

getMutableback to summary
public Boolean getMutable()

INTERNAL: Used for OX mapping.

getReturnInsertback to summary
public ReturnInsertMetadata getReturnInsert()

INTERNAL: Used for OX mapping.

getReturnUpdateback to summary
public Boolean getReturnUpdate()

INTERNAL: Used for OX mapping.

getSequenceGeneratorback to summary
public SequenceGeneratorMetadata getSequenceGenerator()

INTERNAL: Used for OX mapping.

getTableGeneratorback to summary
public TableGeneratorMetadata getTableGenerator()

INTERNAL: Used for OX mapping.

getUuidGeneratorback to summary
public UuidGeneratorMetadata getUuidGenerator()

INTERNAL: Used for OX mapping.

hashCodeback to summary
public int hashCode()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.DirectAccessor.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
initXMLObjectback to summary
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

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

INTERNAL:

Annotations
@Override
isBasicback to summary
public boolean isBasic()

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

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

Annotations
@Override
isCollectionClassback to summary
protected boolean isCollectionClass(MetadataClass cls)

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

isMapClassback to summary
protected boolean isMapClass(MetadataClass cls)

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

isReturnUpdateback to summary
public Boolean isReturnUpdate()

INTERNAL: USed for OX mapping

processback to summary
public void process()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor.process.

INTERNAL: Process a basic accessor.

Annotations
@Override
processCacheIndexback to summary
protected void processCacheIndex()

INTERNAL: Process cache index.

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

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

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.

Annotations
@Override
processGeneratedValueback to summary
protected void processGeneratedValue()

INTERNAL: Process the generated value metadata.

processIndexback to summary
protected void processIndex()

INTERNAL: Process index information for the given mapping.

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

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

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

Annotations
@Override
processReturnInsertback to summary
protected void processReturnInsert()

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

INTERNAL: Process a ReturnInsert annotation.

Annotations
@Override
processReturnUpdateback to summary
protected void processReturnUpdate()

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

INTERNAL: Process a return update setting.

Annotations
@Override
setCacheIndexback to summary
public void setCacheIndex(CacheIndexMetadata index)

INTERNAL: Used for OX mapping.

setColumnback to summary
public void setColumn(ColumnMetadata column)

INTERNAL: Used for OX mapping.

setGeneratedValueback to summary
public void setGeneratedValue(GeneratedValueMetadata value)

INTERNAL: Used for OX mapping.

setIndexback to summary
public void setIndex(IndexMetadata index)

INTERNAL: Used for OX mapping.

setMutableback to summary
public void setMutable(Boolean mutable)

INTERNAL: Used for OX mapping.

setReturnInsertback to summary
public void setReturnInsert(ReturnInsertMetadata returnInsert)

INTERNAL: Used for OX mapping.

setReturnUpdateback to summary
public void setReturnUpdate(Boolean returnUpdate)

INTERNAL: Used for OX mapping.

setSequenceGeneratorback to summary
public void setSequenceGenerator(SequenceGeneratorMetadata sequenceGenerator)

INTERNAL: Used for OX mapping.

setTableGeneratorback to summary
public void setTableGenerator(TableGeneratorMetadata tableGenerator)

INTERNAL: Used for OX mapping.

setUuidGeneratorback to summary
public void setUuidGenerator(UuidGeneratorMetadata uuidGenerator)

INTERNAL: Used for OX mapping.