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

Class XMLClassAccessor

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

oracle.toplink.essentials.internal.ejb.cmp3.xml.accessors.XMLClassAccessor

All Implemented Interfaces:

XMLAccessor

Direct Known Subclasses:

XMLMappedSuperclassAccessor

public class XMLClassAccessor
extends ClassAccessor
implements XMLAccessor

An XML extended class accessor.

Since:

TopLink EJB 3.0 Reference Implementation

Author:

Guy Pelletier

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	m_entityMappingsAccess
protected static java.lang.String	m_entityMappingsCatalog
protected static java.lang.String	m_entityMappingsSchema
protected XMLHelper	m_helper
protected org.w3c.dom.Node	m_node

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

m_inheritanceParentClass, m_isInheritanceSubclass, m_mappedSuperclasses

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
XMLClassAccessor(MetadataAccessibleObject accessibleObject, org.w3c.dom.Node node, XMLHelper helper, MetadataProcessor processor, MetadataDescriptor descriptor) INTERNAL:

Method Summary

Modifier and Type	Method and Description
protected MetadataAccessor	buildAccessor(org.w3c.dom.Node node) INTERNAL: Create and return the appropriate accessor based on the given node.
java.lang.String	getCatalog() INTERNAL:
java.lang.String	getDiscriminatorValue() INTERNAL: (OVERRIDE) Return the discriminator value for this accessor.
java.lang.String	getDocumentName() INTERNAL:
java.lang.String	getEntityName() INTERNAL: (OVERRIDE) Return the name of this entity class.
XMLHelper	getHelper() INTERNAL:
protected java.lang.String	getInheritanceStrategy() INTERNAL: (OVERRIDE) Return the inheritance strategy.
protected MetadataPrimaryKeyJoinColumns	getPrimaryKeyJoinColumns(java.lang.String sourceTableName, java.lang.String targetTableName) INTERNAL: (OVERRIDE) Process the primary-key-join-column(s) elements.
java.lang.String	getSchema() INTERNAL:
protected boolean	hasEntity(java.lang.Class cls) INTERNAL: (Override from ClassAccessor) Return true if this class has an entity node.
protected boolean	hasInheritance(java.lang.Class entityClass) INTERNAL: (Override from ClassAccessor) Return true if this class has an inheritance node.
boolean	isXMLAccessor() INTERNAL: Return true if this is an XML processing accessor.
void	process() INTERNAL: Process any entity tag specifics then call the parent process.
protected ClassAccessor	processAccessor(MetadataDescriptor descriptor) INTERNAL: (OVERRIDE) Fast track processing a ClassAccessor for the given descriptor.
protected void	processAccessors() INTERNAL: (OVERRIDE) Process the accessors for the given class.
protected void	processAssociationOverrides() INTERNAL: (OVERRIDE) Process the association overrides for a class that inherits from a mapped superclass.
protected void	processAttributeOverrides() INTERNAL: (OVERRIDE) Process the attribute overrides for a class that inherits from a mapped superclass.
protected void	processDiscriminatorColumn() INTERNAL: Process an XML discriminator-column metadata.
MetadataEntityListener	processEntityEventListener(java.lang.ClassLoader loader) INTERNAL: (OVERRIDE) Process the entity class for lifecycle callback event methods.
void	processEntityListeners(java.lang.Class entityClass, java.lang.ClassLoader loader) INTERNAL: (OVERRIDE) Process the entity listeners for this class accessor.
void	processEntityMappings() INTERNAL: Process the information contained in the entity-mappings node.
protected void	processExcludeDefaultListeners() INTERNAL: (OVERRIDE) Process the exclude-default-listeners tag if one is specified, otherwise, ask the parent to look for an annotation.
protected void	processExcludeSuperclassListeners() INTERNAL: (OVERRIDE) Process the exclude-superclass-listeners tag if one is specified, otherwise, ask the parent to look for an annotation.
protected void	processIdClass() INTERNAL: (OVERRIDE) Process an id-class element
void	processMappedSuperclassEventListener(MetadataEntityListener listener, java.lang.Class entityClass, java.lang.ClassLoader loader) INTERNAL: (OVERRIDE) Process the mapped superclass class for lifecycle callback event methods.
protected void	processNamedNativeQueries() INTERNAL: (OVERRIDE) Process the named native queries for the given class which could be an entity or a mapped superclass.
protected void	processNamedNativeQueries(org.w3c.dom.NodeList queryNodes) INTERNAL: Process named-queries at either the entity-mappings or entity level.
protected void	processNamedQueries() INTERNAL: (OVERRIDE) Process the named queries for the given class which could be an entity or a mapped superclass.
protected void	processNamedQueries(org.w3c.dom.NodeList queryNodes) INTERNAL: Process named queries at either the entity-mapping or entity level.
protected void	processSecondaryTables() INTERNAL: (OVERRIDE) Process secondary-table(s) for a given entity.
protected void	processSequenceGenerator() INTERNAL: (OVERRIDE) Process this accessor's sequence-generator node into a common metadata sequence generator.
protected void	processSequenceGenerator(org.w3c.dom.Node node) INTERNAL: Process a sequence-generator node into a common metadata sequence generator.
protected void	processSqlResultSetMappings() INTERNAL: (OVERRIDE) Process the sql result set mappings for the given class which could be an entity or a mapped superclass.
protected void	processSqlResultSetMappings(org.w3c.dom.NodeList sqlResultSetNodes) INTERNAL: Process sql-result-set-mappings and store them on the session.
protected void	processTable() INTERNAL: (OVERRIDE) Process table information for the given metadata descriptor.
protected void	processTableGenerator() INTERNAL: (OVERRIDE) Process the table generator for the given class which could be an entity or a mapped superclass.
protected void	processTableGenerator(org.w3c.dom.Node node) INTERNAL: Process a table-generator node into a common metadata table generator.

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

addMultipleTableKeyFields, buildAccessor, clearMappedSuperclasses, getInheritanceParentClass, getInheritanceParentDescriptor, getJavaClass, getMappedSuperclasses, hasInheritance, isClass, isInheritanceSubclass, isTransient, isValidPersistenceElement, isValidPersistenceField, isValidPersistenceMethod, processAccessor, processAccessorFields, processAccessorMethods, processAssociationOverride, processAttributeOverride, processCallbackMethods, processClassMetadata, processDefaultListeners, processDiscriminatorColumn, processDiscriminatorValue, processEntity, processIdClass, processInheritance, processInheritanceSubclass, processJoinColumns, processLifecycleEvent, processLifecycleEvents, processListeners, processMappedSuperclass, processMappedSuperclasses, processNamedNativeQuery, processNamedQuery, processSecondaryTable, processSqlResultSetMapping, processTable, processTableAndInheritance, setPostLoad, setPostPersist, setPostRemove, setPostUpdate, setPrePersist, setPreRemove, setPreUpdate, validatePrimaryKey

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

processSequenceGenerator, processTableGenerator

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

getAnnotatedElement, getAnnotation, getAnnotation, getAttributeName, getDescriptor, getFetchType, getJavaClassName, getLogger, getMapKeyClass, getName, getName, getName, getProcessor, getProject, getRawClass, getReferenceClass, getReferenceClassName, getReferenceDescriptor, getRelationType, getSetMethodName, getUpperCaseAttributeName, getUpperCaseShortJavaClassName, getValidator, hasColumn, hasPrimaryKeyJoinColumns, isAnnotationPresent, isAnnotationPresent, isBasic, isEmbedded, isEmbeddedId, isManyToMany, isManyToOne, isOneToMany, isOneToOne, isOptional, isProcessed, isRelationship, 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

Field Detail

m_node

protected org.w3c.dom.Node m_node

m_helper

protected XMLHelper m_helper

m_entityMappingsAccess

protected static java.lang.String m_entityMappingsAccess

m_entityMappingsSchema

protected static java.lang.String m_entityMappingsSchema

m_entityMappingsCatalog

protected static java.lang.String m_entityMappingsCatalog

Constructor Detail

XMLClassAccessor

public XMLClassAccessor(MetadataAccessibleObject accessibleObject,
                        org.w3c.dom.Node node,
                        XMLHelper helper,
                        MetadataProcessor processor,
                        MetadataDescriptor descriptor)

INTERNAL:

Method Detail

buildAccessor

protected MetadataAccessor buildAccessor(org.w3c.dom.Node node)

INTERNAL: Create and return the appropriate accessor based on the given node.

getCatalog

public java.lang.String getCatalog()

INTERNAL:

Specified by:

getCatalog in interface XMLAccessor

getDiscriminatorValue

public java.lang.String getDiscriminatorValue()

INTERNAL: (OVERRIDE) Return the discriminator value for this accessor. If it is not defined call the parent to check for an annotation.

Overrides:

getDiscriminatorValue in class ClassAccessor

getDocumentName

public java.lang.String getDocumentName()

INTERNAL:

Specified by:

getDocumentName in interface XMLAccessor

getEntityName

public java.lang.String getEntityName()

INTERNAL: (OVERRIDE) Return the name of this entity class. If it is not defined call the parent to check for an annotation.

Overrides:

getEntityName in class ClassAccessor

getHelper

public XMLHelper getHelper()

INTERNAL:

Specified by:

getHelper in interface XMLAccessor

getInheritanceStrategy

protected java.lang.String getInheritanceStrategy()

INTERNAL: (OVERRIDE) Return the inheritance strategy. This method should only be called on the root of the inheritance hierarchy.

Overrides:

getInheritanceStrategy in class ClassAccessor

getPrimaryKeyJoinColumns

protected MetadataPrimaryKeyJoinColumns getPrimaryKeyJoinColumns(java.lang.String sourceTableName,
                                                                 java.lang.String targetTableName)

INTERNAL: (OVERRIDE) Process the primary-key-join-column(s) elements.

Overrides:

getPrimaryKeyJoinColumns in class MetadataAccessor

getSchema

public java.lang.String getSchema()

INTERNAL:

Specified by:

getSchema in interface XMLAccessor

hasEntity

protected boolean hasEntity(java.lang.Class cls)

INTERNAL: (Override from ClassAccessor) Return true if this class has an entity node.

Overrides:

hasEntity in class ClassAccessor

hasInheritance

protected boolean hasInheritance(java.lang.Class entityClass)

INTERNAL: (Override from ClassAccessor) Return true if this class has an inheritance node.

Overrides:

hasInheritance in class ClassAccessor

isXMLAccessor

public boolean isXMLAccessor()

INTERNAL: Return true if this is an XML processing accessor.

Overrides:

isXMLAccessor in class MetadataAccessor

process

public void process()

INTERNAL: Process any entity tag specifics then call the parent process.

Overrides:

process in class ClassAccessor

processAccessor

protected ClassAccessor processAccessor(MetadataDescriptor descriptor)

INTERNAL: (OVERRIDE) Fast track processing a ClassAccessor for the given descriptor. Inheritance root classes and embeddables may be fast tracked.

Overrides:

processAccessor in class MetadataAccessor

processAccessors

protected void processAccessors()

INTERNAL: (OVERRIDE) Process the accessors for the given class.

Overrides:

processAccessors in class ClassAccessor

processAssociationOverrides

protected void processAssociationOverrides()

INTERNAL: (OVERRIDE) Process the association overrides for a class that inherits from a mapped superclass. Once the association overrides are processed from XML process the association overrides from annotations.

Overrides:

processAssociationOverrides in class ClassAccessor

processAttributeOverrides

protected void processAttributeOverrides()

INTERNAL: (OVERRIDE) Process the attribute overrides for a class that inherits from a mapped superclass. Once the attribute overrides are processed from XML process the attribute overrides from annotations.

Overrides:

processAttributeOverrides in class ClassAccessor

processDiscriminatorColumn

protected void processDiscriminatorColumn()

INTERNAL: Process an XML discriminator-column metadata. If we don't find a node here, check for an annotation by calling the parent. It will default if no annotation is found.

Overrides:

processDiscriminatorColumn in class ClassAccessor

processEntityEventListener

public MetadataEntityListener processEntityEventListener(java.lang.ClassLoader loader)

INTERNAL: (OVERRIDE) Process the entity class for lifecycle callback event methods.

Overrides:

processEntityEventListener in class ClassAccessor

processEntityListeners

public void processEntityListeners(java.lang.Class entityClass,
                                   java.lang.ClassLoader loader)

INTERNAL: (OVERRIDE) Process the entity listeners for this class accessor. Entity listeners defined in XML will override those specified on the class.

Overrides:

processEntityListeners in class ClassAccessor

processEntityMappings

public void processEntityMappings()

INTERNAL: Process the information contained in the entity-mappings node.

processExcludeDefaultListeners

protected void processExcludeDefaultListeners()

INTERNAL: (OVERRIDE) Process the exclude-default-listeners tag if one is specified, otherwise, ask the parent to look for an annotation.

Overrides:

processExcludeDefaultListeners in class ClassAccessor

processExcludeSuperclassListeners

protected void processExcludeSuperclassListeners()

INTERNAL: (OVERRIDE) Process the exclude-superclass-listeners tag if one is specified, otherwise, ask the parent to look for an annotation.

Overrides:

processExcludeSuperclassListeners in class ClassAccessor

processIdClass

protected void processIdClass()

INTERNAL: (OVERRIDE) Process an id-class element

Overrides:

processIdClass in class ClassAccessor

processMappedSuperclassEventListener

public void processMappedSuperclassEventListener(MetadataEntityListener listener,
                                                 java.lang.Class entityClass,
                                                 java.lang.ClassLoader loader)

INTERNAL: (OVERRIDE) Process the mapped superclass class for lifecycle callback event methods.

Overrides:

processMappedSuperclassEventListener in class ClassAccessor

processNamedNativeQueries

protected void processNamedNativeQueries()

INTERNAL: (OVERRIDE) Process the named native queries for the given class which could be an entity or a mapped superclass.

Overrides:

processNamedNativeQueries in class ClassAccessor

processNamedNativeQueries

protected void processNamedNativeQueries(org.w3c.dom.NodeList queryNodes)

INTERNAL: Process named-queries at either the entity-mappings or entity level. The queries will be stored in a hashmap - EntityManagerSetupImpl will call 'addNamedQueriesToSession()' after processing; this is when the queries will be added to the session.

processNamedQueries

protected void processNamedQueries()

INTERNAL: (OVERRIDE) Process the named queries for the given class which could be an entity or a mapped superclass.

Overrides:

processNamedQueries in class ClassAccessor

processNamedQueries

protected void processNamedQueries(org.w3c.dom.NodeList queryNodes)

INTERNAL: Process named queries at either the entity-mapping or entity level. The queries will be stored in a hashmap - EntityManagerSetupImpl will call 'addNamedQueriesToSession()' after processing; this is when the queries will be added to the session.

processSecondaryTables

protected void processSecondaryTables()

INTERNAL: (OVERRIDE) Process secondary-table(s) for a given entity.

Overrides:

processSecondaryTables in class ClassAccessor

processSequenceGenerator

protected void processSequenceGenerator()

INTERNAL: (OVERRIDE) Process this accessor's sequence-generator node into a common metadata sequence generator.

Overrides:

processSequenceGenerator in class NonRelationshipAccessor

processSequenceGenerator

protected void processSequenceGenerator(org.w3c.dom.Node node)

INTERNAL: Process a sequence-generator node into a common metadata sequence generator.

processSqlResultSetMappings

protected void processSqlResultSetMappings()

INTERNAL: (OVERRIDE) Process the sql result set mappings for the given class which could be an entity or a mapped superclass.

Overrides:

processSqlResultSetMappings in class ClassAccessor

processSqlResultSetMappings

protected void processSqlResultSetMappings(org.w3c.dom.NodeList sqlResultSetNodes)

INTERNAL: Process sql-result-set-mappings and store them on the session.

processTable

protected void processTable()

INTERNAL: (OVERRIDE) Process table information for the given metadata descriptor.

Overrides:

processTable in class ClassAccessor

processTableGenerator

protected void processTableGenerator()

INTERNAL: (OVERRIDE) Process the table generator for the given class which could be an entity or a mapped superclass.

Overrides:

processTableGenerator in class NonRelationshipAccessor

processTableGenerator

protected void processTableGenerator(org.w3c.dom.Node node)

INTERNAL: Process a table-generator node into a common metadata table generator.