org.eclipse.persistence.internal.jpa.metadata.accessors.classes

Class InterfaceAccessor

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.classes.ClassAccessor

org.eclipse.persistence.internal.jpa.metadata.accessors.classes.InterfaceAccessor

public class InterfaceAccessor
extends ClassAccessor

An interface accessor. This is kinda forward thinking. I assume once we get into full interface support etc. this class will handle much more and will map directly to an interface schema element from the eclipselink orm schema. Things that should or could be mapped on this interface are: - alias - query keys 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:

EclipseLink 1.0

Author:

Guy Pelletier

Field Summary

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

m_project

Constructor Summary

Constructors

Constructor and Description
InterfaceAccessor(MetadataAnnotation annotation, MetadataClass cls, MetadataProject project) INTERNAL:

Method Summary

Modifier and Type	Method and Description
void	addEntityAccessor(EntityAccessor accessor) INTERNAL: Add the given entity accessor to this interface's list of variable one to one accessors.
void	addQueryKey(java.lang.String queryKeyName) INTERNAL: Query keys are stored internally in a map (keyed on the query key name).
void	addVariableOneToOneAccessor(VariableOneToOneAccessor accessor) INTERNAL: Add a variable one to one accessor for this interface.
void	process() INTERNAL:
void	processAccessType() INTERNAL:

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

addAccessor, addAccessorFields, addAccessorMethods, addAccessors, addPotentialEmbeddableAccessor, addPotentialMappedSuperclass, buildAccessor, clearMappedSuperclassesAndInheritanceParents, clearPreProcessed, equals, excludeDefaultMappings, getAccessibleField, getAccessibleMethod, getAccessibleVirtualMethod, getAccessType, getAnnotation, getAssociationOverrides, getAttributeOverrides, getAttributes, getChangeTracking, getClassName, getCloneCopyPolicy, getCopyPolicy, getCustomCopyPolicy, getCustomizerClass, getCustomizerClassName, getDescription, getExcludeDefaultMappings, getIdentifier, getInstantiationCopyPolicy, getJavaClass, getJavaClassName, getMappedSuperclasses, getMetadataComplete, getNoSql, getOracleArrayTypes, getOracleObjectTypes, getOwningDescriptor, getOwningDescriptors, getParentClass, getParentClassName, getPLSQLRecords, getPLSQLTables, getStruct, hasDerivedId, hashCode, hasParentClass, ignoreAnnotations, initXMLClassAccessor, initXMLObject, isAnnotationPresent, isClassAccessor, isEmbeddableAccessor, isEntityAccessor, isMappedSuperclass, isMetadataComplete, isPreProcessed, isProcessed, merge, preProcess, preProcessForCanonicalModel, preProcessMappedSuperclassMetadata, processAssociationOverride, processAssociationOverrides, processAttributeOverride, processAttributeOverrides, processChangeTracking, processComplexMetadataTypes, processCopyPolicy, processCustomizer, processDerivedId, processMappedSuperclassMetadata, processMappingAccessors, processNoSql, processParentClass, processProperties, processStruct, processVirtualClass, resolveGenericTypes, setAssociationOverrides, setAttributeOverrides, setAttributes, setChangeTracking, setClassName, setCloneCopyPolicy, setCustomCopyPolicy, setCustomizerClassName, setDescription, setExcludeDefaultMappings, setInstantiationCopyPolicy, setIsPreProcessed, setIsProcessed, setJavaClass, setMetadataComplete, setNoSql, setOracleArrayTypes, setOracleObjectTypes, setParentClass, setParentClassName, setPLSQLRecords, setPLSQLTables, setStruct, toString, usesFieldAccess, usesPropertyAccess, usesVirtualAccess

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

getAccess, getAccessibleObject, getAccessMethods, getAnnotatedElement, getAnnotatedElementName, getAnnotation, getAttributeName, getConverters, getDefaultAttributeName, getDescriptor, getDescriptorJavaClass, getHashPartitioning, getName, getObjectTypeConverters, getPartitioned, getPartitioning, getPinnedPartitioning, getProperties, getRangePartitioning, getReferencedField, getReferencedField, getReplicationPartitioning, getRoundRobinPartitioning, getSerializedConverters, getStructConverters, getTypeConverters, getUnionPartitioning, getUpperCaseShortJavaClassName, getValue, getValue, getValuePartitioning, hasAccess, hasAccessMethods, initAccess, initXMLAccessor, isAnnotationPresent, 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

InterfaceAccessor

public InterfaceAccessor(MetadataAnnotation annotation,
                         MetadataClass cls,
                         MetadataProject project)

INTERNAL:

Method Detail

addEntityAccessor

public void addEntityAccessor(EntityAccessor accessor)

INTERNAL: Add the given entity accessor to this interface's list of variable one to one accessors.

addQueryKey

public void addQueryKey(java.lang.String queryKeyName)

INTERNAL: Query keys are stored internally in a map (keyed on the query key name). Therefore, adding the same query key name multiple times (for each variable one to one accessor to this interface) will not cause a problem.

addVariableOneToOneAccessor

public void addVariableOneToOneAccessor(VariableOneToOneAccessor accessor)

INTERNAL: Add a variable one to one accessor for this interface. Those entities that implement the interface on the accessor will need to make sure they add themselves to the class indicator list. See the process method below which is called from MetadataProject processing.

process

public void process()

INTERNAL:

Overrides:

process in class ClassAccessor

processAccessType

public void processAccessType()

INTERNAL:

Specified by:

processAccessType in class ClassAccessor