oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors

Class BasicAccessor

java.lang.Object

oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.MetadataAccessor

oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.NonRelationshipAccessor

oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.DirectAccessor

oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.BasicAccessor

Direct Known Subclasses:

XMLBasicAccessor

public class BasicAccessor
extends DirectAccessor

A relational accessor. A @Basic annotation may or may not be present on the accessible object.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

Fields inherited from class oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.MetadataAccessor

m_accessibleObject, m_descriptor, m_logger, m_processor, m_project, m_validator

Constructor Summary

Constructors

Constructor and Description
BasicAccessor(MetadataAccessibleObject accessibleObject, ClassAccessor classAccessor) INTERNAL:

Method Summary

Modifier and Type	Method and Description
protected MetadataColumn	getColumn(java.lang.String loggingCtx) INTERNAL: (Overridden in XMLBasicAccessor) Build a metadata column.
java.lang.String	getFetchType() INTERNAL: (Overridden in XMLBasicAccessor)
boolean	isBasic() INTERNAL: (Override from MetadataAccessor)
boolean	isId() INTERNAL: (Overridden in XMLBasicAccessor) Return true if this accessor represents an id field.
boolean	isOptional() INTERNAL: (Overridden in XMLBasicAccessor)
boolean	isVersion() INTERNAL: (Overridden in XMLBasicAccessor) Return true if this accessor represents an optimistic locking field.
void	process() INTERNAL: Process a basic accessor.
protected void	processDirectToFieldMapping(DatabaseField field) INTERNAL: Process a Serialized or Basic into a DirectToFieldMapping.
protected void	processEnumerated(DatabaseMapping mapping) INTERNAL: (Override from DirectAccessor) Process an @Enumerated.
protected void	processGeneratedValue(DatabaseField field) INTERNAL: (Overridden In XMLBasicAccessor) Process a @GeneratedValue.
protected void	processGeneratedValue(MetadataGeneratedValue generatedValue, DatabaseField sequenceNumberField) INTERNAL:
protected void	processId(DatabaseField field) INTERNAL: Process an @Id or id element if there is one.
protected void	processLob(DatabaseMapping mapping) INTERNAL: (Override from DirectAccessor) Process a @Lob or lob sub-element.
protected void	processVersion(DatabaseField field) INTERNAL:
void	setConverter(DatabaseMapping mapping, Converter converter) INTERNAL:
void	setFieldClassification(DatabaseMapping mapping, java.lang.Class classification) INTERNAL:

Methods inherited from class oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.DirectAccessor

getDatabaseField, getEnumeratedType, getTemporalType, hasEnumerated, hasLob, hasTemporal, isEnumerated, isLob, isSerialized, isTemporal, processJPAConverters, processMappingConverter, processSerialized, processTemporal

Methods inherited from class oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.NonRelationshipAccessor

processSequenceGenerator, processSequenceGenerator, processTableGenerator, processTableGenerator

Methods inherited from class oracle.toplink.essentials.internal.ejb.cmp3.metadata.accessors.MetadataAccessor

getAnnotatedElement, getAnnotation, getAnnotation, getAttributeName, getDescriptor, getJavaClass, getJavaClassName, getLogger, getMapKeyClass, getName, getName, getName, getPrimaryKeyJoinColumns, getProcessor, getProject, getRawClass, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationType, getSetMethodName, getUpperCaseAttributeName, getUpperCaseShortJavaClassName, getValidator, hasColumn, hasPrimaryKeyJoinColumns, isAnnotationPresent, isAnnotationPresent, isClass, isEmbedded, isEmbeddedId, isManyToMany, isManyToOne, isOneToMany, isOneToOne, isProcessed, isRelationship, isXMLAccessor, processAccessor, processPrimaryKeyJoinColumns, processTable, setAccessorMethods, setAnnotatedElement, setIndirectionPolicy, setIsProcessed, usesIndirection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicAccessor

public BasicAccessor(MetadataAccessibleObject accessibleObject,
                     ClassAccessor classAccessor)

INTERNAL:

Method Detail

getColumn

protected MetadataColumn getColumn(java.lang.String loggingCtx)

INTERNAL: (Overridden in XMLBasicAccessor) Build a metadata column.

Specified by:

getColumn in class DirectAccessor

getFetchType

public java.lang.String getFetchType()

INTERNAL: (Overridden in XMLBasicAccessor)

Overrides:

getFetchType in class MetadataAccessor

isBasic

public boolean isBasic()

INTERNAL: (Override from MetadataAccessor)

Overrides:

isBasic in class MetadataAccessor

isId

public boolean isId()

INTERNAL: (Overridden in XMLBasicAccessor) Return true if this accessor represents an id field.

isOptional

public boolean isOptional()

INTERNAL: (Overridden in XMLBasicAccessor)

Overrides:

isOptional in class MetadataAccessor

isVersion

public boolean isVersion()

INTERNAL: (Overridden in XMLBasicAccessor) Return true if this accessor represents an optimistic locking field.

process

public void process()

INTERNAL: Process a basic accessor.

Specified by:

process in class MetadataAccessor

processDirectToFieldMapping

protected void processDirectToFieldMapping(DatabaseField field)

INTERNAL: Process a Serialized or Basic into a DirectToFieldMapping. If neither is found a DirectToFieldMapping is created regardless.

processEnumerated

protected void processEnumerated(DatabaseMapping mapping)

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

Overrides:

processEnumerated in class DirectAccessor

processGeneratedValue

protected void processGeneratedValue(DatabaseField field)

INTERNAL: (Overridden In XMLBasicAccessor) Process a @GeneratedValue.

processGeneratedValue

protected void processGeneratedValue(MetadataGeneratedValue generatedValue,
                                     DatabaseField sequenceNumberField)

INTERNAL:

processId

protected void processId(DatabaseField field)

INTERNAL: Process an @Id or id element if there is one.

processLob

protected void processLob(DatabaseMapping mapping)

INTERNAL: (Override from DirectAccessor) Process a @Lob or lob sub-element. The lob must be specified to process and create a lob type mapping.

Overrides:

processLob in class DirectAccessor

processVersion

protected void processVersion(DatabaseField field)

INTERNAL:

setConverter

public void setConverter(DatabaseMapping mapping,
                         Converter converter)

INTERNAL:

Specified by:

setConverter in class DirectAccessor

setFieldClassification

public void setFieldClassification(DatabaseMapping mapping,
                                   java.lang.Class classification)

INTERNAL:

Specified by:

setFieldClassification in class DirectAccessor