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

public Class MappedSuperclassAccessor

extends ClassAccessor
Class Inheritance
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.metadata.accessors.classes.EntityAccessor
Static Imports
org.eclipse.persistence.internal.jpa.metadata.MetadataConstants.JPA_ACCESS_FIELD, .MetadataConstants.JPA_ACCESS_PROPERTY, .MetadataConstants.JPA_CACHEABLE, .MetadataConstants.JPA_ENTITY_LISTENERS, .MetadataConstants.JPA_EXCLUDE_DEFAULT_LISTENERS, .MetadataConstants.JPA_EXCLUDE_SUPERCLASS_LISTENERS, .MetadataConstants.JPA_ID_CLASS, .MetadataConstants.JPA_NAMED_NATIVE_QUERIES, .MetadataConstants.JPA_NAMED_NATIVE_QUERY, .MetadataConstants.JPA_NAMED_QUERIES, .MetadataConstants.JPA_NAMED_QUERY, .MetadataConstants.JPA_NAMED_STORED_PROCEDURE_QUERIES, .MetadataConstants.JPA_NAMED_STORED_PROCEDURE_QUERY, .MetadataConstants.JPA_SEQUENCE_GENERATOR, .MetadataConstants.JPA_SEQUENCE_GENERATORS, .MetadataConstants.JPA_SQL_RESULT_SET_MAPPING, .MetadataConstants.JPA_SQL_RESULT_SET_MAPPINGS, .MetadataConstants.JPA_TABLE_GENERATOR, .MetadataConstants.JPA_TABLE_GENERATORS, .MetadataConstants.JPA_TRANSIENT
INTERNAL: A mapped superclass accessor. When adding new metadata objects, be sure to include their initialization in initXMLObject. This sets the accessible object and the location of the ORMetadata which is used when merging. Also new member metadata variables need to be added to the merge method. 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 AdditionalCriteriaMetadata
m_additionalCriteria

private CacheMetadata
m_cache

private Boolean
m_cacheable

private List<CacheIndexMetadata>
m_cacheIndexes

private CacheInterceptorMetadata
m_cacheInterceptor

private List<EntityListenerMetadata>
m_entityListeners

private Boolean
m_excludeDefaultListeners

private Boolean
m_excludeSuperclassListeners

private String
m_existenceChecking

private List<FetchGroupMetadata>
m_fetchGroups

private MetadataClass
m_idClass

private String
m_idClassName

private MultitenantMetadata
m_multitenant

private List<NamedNativeQueryMetadata>
m_namedNativeQueries

private List<NamedPLSQLStoredFunctionQueryMetadata>
m_namedPLSQLStoredFunctionQueries

private List<NamedPLSQLStoredProcedureQueryMetadata>
m_namedPLSQLStoredProcedureQueries

private List<NamedQueryMetadata>
m_namedQueries

private List<NamedStoredFunctionQueryMetadata>
m_namedStoredFunctionQueries

private List<NamedStoredProcedureQueryMetadata>
m_namedStoredProcedureQueries

private OptimisticLockingMetadata
m_optimisticLocking

private String
m_postLoad

private String
m_postPersist

private String
m_postRemove

private String
m_postUpdate

private String
m_prePersist

private String
m_preRemove

private String
m_preUpdate

private PrimaryKeyMetadata
m_primaryKey

private QueryRedirectorsMetadata
m_queryRedirectors

private Boolean
m_readOnly

private SequenceGeneratorMetadata
m_sequenceGenerator

private SerializedObjectPolicyMetadata
m_serializedObjectPolicy

private List<SQLResultSetMappingMetadata>
m_sqlResultSetMappings

private TableGeneratorMetadata
m_tableGenerator

private UuidGeneratorMetadata
m_uuidGenerator

Constructor Summary

AccessConstructor and Description
public
MappedSuperclassAccessor()

INTERNAL: Used for OX mapping.

public
MappedSuperclassAccessor(String xmlElement)

INTERNAL: Used for OX mapping.

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

INTERNAL:

public
MappedSuperclassAccessor(MetadataAnnotation annotation, MetadataClass cls, MetadataDescriptor descriptor)

INTERNAL:

Method Summary

Modifier and TypeMethod and Description
public boolean
excludeDefaultListeners()

INTERNAL: Used for OX mapping.

public boolean
excludeSuperclassListeners()

INTERNAL: Used for OX mapping.

public AdditionalCriteriaMetadata
getAdditionalCriteria()

INTERNAL: Used for OX mapping.

public CacheMetadata
getCache()

INTERNAL: Used for OX mapping.

public Boolean
getCacheable()

INTERNAL: Used for OX mapping.

public List<CacheIndexMetadata>
getCacheIndexes()

INTERNAL: Used for OX mapping.

public CacheInterceptorMetadata
getCacheInterceptor()

INTERNAL: Used for OX mapping.

public List<EntityListenerMetadata>
getEntityListeners()

INTERNAL: Used for OX mapping.

public Boolean
getExcludeDefaultListeners()

INTERNAL: Used for OX mapping.

public Boolean
getExcludeSuperclassListeners()

INTERNAL: Used for OX mapping.

public String
getExistenceChecking()

INTERNAL: Used for OX mapping.

public List<FetchGroupMetadata>
getFetchGroups()

INTERNAL: Used for OX mapping.

protected MetadataClass
getIdClass()

INTERNAL:

public String
getIdClassName()

INTERNAL: Used for OX mapping.

public MultitenantMetadata
getMultitenant()

INTERNAL: Used for OX mapping.

public List<NamedNativeQueryMetadata>
getNamedNativeQueries()

INTERNAL: Used for OX mapping.

public List<NamedPLSQLStoredFunctionQueryMetadata>
getNamedPLSQLStoredFunctionQueries()

INTERNAL: Used for OX mapping.

public List<NamedPLSQLStoredProcedureQueryMetadata>
getNamedPLSQLStoredProcedureQueries()

INTERNAL: Used for OX mapping.

public List<NamedQueryMetadata>
getNamedQueries()

INTERNAL: Used for OX mapping.

public List<NamedStoredFunctionQueryMetadata>
getNamedStoredFunctionQueries()

INTERNAL: Used for OX mapping.

public List<NamedStoredProcedureQueryMetadata>
getNamedStoredProcedureQueries()

INTERNAL: Used for OX mapping.

public OptimisticLockingMetadata
getOptimisticLocking()

INTERNAL: Used for OX mapping.

public String
getPostLoad()

INTERNAL: Used for OX mapping.

public String
getPostPersist()

INTERNAL: Used for OX mapping.

public String
getPostRemove()

INTERNAL: Used for OX mapping.

public String
getPostUpdate()

INTERNAL: Used for OX mapping.

public String
getPrePersist()

INTERNAL: Used for OX mapping.

public String
getPreRemove()

INTERNAL: Used for OX mapping.

public String
getPreUpdate()

INTERNAL: Used for OX mapping.

public PrimaryKeyMetadata
getPrimaryKey()

INTERNAL: Used for OX mapping.

public QueryRedirectorsMetadata
getQueryRedirectors()

INTERNAL: Used for OX mapping.

public Boolean
getReadOnly()

INTERNAL: Used for OX mapping.

public SequenceGeneratorMetadata
getSequenceGenerator()

INTERNAL: Used for OX mapping.

public SerializedObjectPolicyMetadata
getSerializedObjectPolicy()

INTERNAL: Used for OX mapping.

public List<SQLResultSetMappingMetadata>
getSqlResultSetMappings()

INTERNAL: Used for OX mapping.

public TableGeneratorMetadata
getTableGenerator()

INTERNAL: Used for OX mapping.

public UuidGeneratorMetadata
getUuidGenerator()

INTERNAL: Used for OX mapping.

protected boolean
hasObjectRelationalFieldMappingAnnotationsDefined()

INTERNAL: Return true if any given field defines object relational persistence mapping annotations.

protected boolean
hasObjectRelationalMethodMappingAnnotationsDefined()

INTERNAL: Return true if any given method defines object relational persistence mapping annotations.

protected void
initIdClass()

INTERNAL: This method is called in the pre-processing stage since we want to gather a list of id classes used throughout the persistence unit.

public void
initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.initXMLObject.

INTERNAL:
public boolean
isMappedSuperclass()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.isMappedSuperclass.

INTERNAL: Return whether this accessor represents a MappedSuperclass
public void
merge(ORMetadata metadata)

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.merge.

INTERNAL: Mapped-superclass level merging details.
public void
preProcess()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.preProcess.

INTERNAL: The pre-process method is called during regular deployment and metadata processing.
public void
process()

Overrides org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.process.

INTERNAL: Process the items of interest on a mapped superclass.
public void
processAccessType()

Implements abstract org.eclipse.persistence.internal.jpa.metadata.accessors.classes.ClassAccessor.processAccessType.

INTERNAL: Process the accessType for a MappedSuperclass.
protected void
processAdditionalCriteria()

INTERNAL: Process the additional criteria metadata specified on an entity or mapped superclass.

protected void
processCache()

INTERNAL: Process a cache metadata.

protected void
processCacheable()

INTERNAL: Called in pre-process.

protected void
processCacheIndexes()

INTERNAL: Process cache index information for the given metadata descriptor.

protected void
processCacheInterceptor()

INTERNAL: Process a cache interceptor metadata.

protected void
processCaching()

INTERNAL: Process a caching metadata.

protected void
processCachingMetadata()

INTERNAL: Process a caching metadata.

protected void
processDefaultRedirectors()

INTERNAL: Process a default redirector metadata.

public void
processEntityListeners(ClassLoader loader)

INTERNAL: Process the entity listeners for this class accessor.

protected void
processExcludeDefaultListeners()

INTERNAL: Process the exclude-default-listeners value.

protected void
processExcludeSuperclassListeners()

INTERNAL: Process the ExcludeSuperclassListeners value if one is specified (taking metadata-complete into consideration).

protected void
processExistenceChecking()

INTERNAL: Process the ExistenceChecking value if one is specified (taking metadata-complete into consideration).

protected void
processFetchGroup(FetchGroupMetadata fetchGroup, Map<String, FetchGroupMetadata> fetchGroups)

INTERNAL:

protected void
processFetchGroups()

INTERNAL: Process the fetch groups for this class.

protected void
processIdClass()

INTERNAL: Process an IdClass metadata.

public void
processMetamodelDescriptor()

INTERNAL: Used to process mapped superclasses when creating descriptors for a metamodel.

protected void
processMultitenant()

INTERNAL: Process the multitenant metadata specified on a mapped superclass and apply it to a sub-entity that has no multitenant metadata specified.

protected void
processNamedNativeQueries()

INTERNAL: Process/collect the named native queries on this accessor and add them to the project for later processing.

protected void
processNamedPLSQLStoredFunctionQueries()

INTERNAL: Process/collect the named PLSQL stored function queries on this accessor and add them to the project for later processing.

protected void
processNamedPLSQLStoredProcedureQueries()

INTERNAL: Process/collect the named PLSQL stored procedure queries on this accessor and add them to the project for later processing.

protected void
processNamedQueries()

INTERNAL: Process/collect the named queries on this accessor and add them to the project for later processing.

protected void
processNamedStoredFunctionQueries()

INTERNAL: Process/collect the named stored procedure queries on this accessor and add them to the project for later processing.

protected void
processNamedStoredProcedureQueries()

INTERNAL: Process/collect the named stored function queries on this accessor and add them to the project for later processing.

protected void
processOptimisticLocking()

INTERNAL: Process an OptimisticLockingMetadata.

protected void
processPrimaryKey()

INTERNAL: Process the primary key annotation.

protected void
processReadOnly()

INTERNAL: Process a read only setting.

protected void
processSequenceGenerator()

INTERNAL: Process a SequenceGenerator annotation into a common metadata sequence generator and add it to the project.

protected void
processSerializedObjectPolicy()

INTERNAL: Process a SerializedObjectPolicyMetadata.

protected void
processSqlResultSetMappings()

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

protected void
processTableGenerator()

INTERNAL: Process a TableGenerator annotation into a common metadata table generator and add it to the project.

protected void
processUuidGenerator()

INTERNAL: Process a TableGenerator annotation into a common metadata table generator and add it to the project.

public void
setAdditionalCriteria(AdditionalCriteriaMetadata additionalCriteria)

INTERNAL: Used for OX mapping.

public void
setCache(CacheMetadata cache)

INTERNAL: Used for OX mapping.

public void
setCacheable(Boolean cacheable)

INTERNAL: Used for OX mapping.

public void
setCacheIndexes(List<CacheIndexMetadata> indexes)

INTERNAL: Used for OX mapping.

public void
setCacheInterceptor(CacheInterceptorMetadata cacheInterceptor)

INTERNAL: Used for OX mapping.

public void
setEntityListeners(List<EntityListenerMetadata> entityListeners)

INTERNAL: Used for OX mapping.

public void
setExcludeDefaultListeners(Boolean excludeDefaultListeners)

INTERNAL: Used for OX mapping.

public void
setExcludeSuperclassListeners(Boolean excludeSuperclassListeners)

INTERNAL: Used for OX mapping

public void
setExistenceChecking(String checking)

INTERNAL: Used for OX mapping.

public void
setFetchGroups(List<FetchGroupMetadata> fetchGroups)

INTERNAL: Used for OX mapping.

protected void
setIdClass(MetadataClass idClass)

INTERNAL:

public void
setIdClassName(String idClassName)

INTERNAL: Used for OX mapping.

public void
setMultitenant(MultitenantMetadata multitenant)

INTERNAL: Used for OX mapping.

public void
setNamedNativeQueries(List<NamedNativeQueryMetadata> namedNativeQueries)

INTERNAL: Used for OX mapping.

public void
setNamedPLSQLStoredFunctionQueries(List<NamedPLSQLStoredFunctionQueryMetadata> namedPLSQLStoredFunctionQueries)

INTERNAL: Used for OX mapping.

public void
setNamedPLSQLStoredProcedureQueries(List<NamedPLSQLStoredProcedureQueryMetadata> namedPLSQLStoredProcedureQueries)

INTERNAL: Used for OX mapping.

public void
setNamedQueries(List<NamedQueryMetadata> namedQueries)

INTERNAL: Used for OX mapping.

public void
setNamedStoredFunctionQueries(List<NamedStoredFunctionQueryMetadata> namedStoredFunctionQueries)

INTERNAL: Used for OX mapping.

public void
setNamedStoredProcedureQueries(List<NamedStoredProcedureQueryMetadata> namedStoredProcedureQueries)

INTERNAL: Used for OX mapping.

public void
setOptimisticLocking(OptimisticLockingMetadata optimisticLocking)

INTERNAL: Used for OX mapping.

public void
setPostLoad(String postLoad)

INTERNAL: Used for OX mapping.

public void
setPostPersist(String postPersist)

INTERNAL:

public void
setPostRemove(String postRemove)

INTERNAL:

public void
setPostUpdate(String postUpdate)

INTERNAL:

public void
setPrePersist(String prePersist)

INTERNAL:

public void
setPreRemove(String preRemove)

INTERNAL:

public void
setPreUpdate(String preUpdate)

INTERNAL:

public void
setPrimaryKey(PrimaryKeyMetadata primaryKey)

INTERNAL: Used for OX mapping.

public void
setQueryRedirectors(QueryRedirectorsMetadata redirectors)

INTERNAL: Used for OX mapping.

public void
setReadOnly(Boolean readOnly)

INTERNAL: Used for OX mapping.

public void
setSequenceGenerator(SequenceGeneratorMetadata sequenceGenerator)

INTERNAL: Used for OX mapping.

public void
setSerializedObjectPolicy(SerializedObjectPolicyMetadata serializedObjectPolicy)

INTERNAL: Used for OX mapping.

public void
setSqlResultSetMappings(List<SQLResultSetMappingMetadata> sqlResultSetMappings)

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