| Modifier and Type | Field and Description |
|---|---|
| private Boolean | |
| private MetadataClass | |
| private String | |
| private List | |
| private DiscriminatorColumnMetadata | |
| private String | |
| private String | |
| private List | |
| private InheritanceMetadata | |
| private List | |
| private PrimaryKeyForeignKeyMetadata | |
| private List | |
| private List | |
| private TableMetadata |
| Access | Constructor and Description |
|---|---|
| public | |
| public |
| Modifier and Type | Method and Description |
|---|---|
| protected void | addMultipleTableKeyFields(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns, DatabaseTable targetTable, String PK_CTX, String FK_CTX)
INTERNAL: Add multiple fields to the descriptor. |
| protected void | discoverMappedSuperclassesAndInheritanceParents(boolean addMappedSuperclassAccessors)
INTERNAL: Build a list of classes that are decorated with a MappedSuperclass annotation or that are tagged as a mapped-superclass in an XML document. |
| public Boolean | |
| public String | |
| public List | |
| public DiscriminatorColumnMetadata | |
| public String | |
| public String | |
| public List | |
| public InheritanceMetadata | |
| public List | |
| public PrimaryKeyForeignKeyMetadata | |
| public List | |
| public List | |
| public TableMetadata | |
| public boolean | hasClassExtractor()
INTERNAL: This method is a little involved since a class extractor is mutually exclusive with a discriminator column. |
| public boolean | |
| public void | initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings)
INTERNAL:
|
| public boolean | |
| public boolean | isEntityAccessor()
Overrides org. |
| public boolean | |
| public void | merge(ORMetadata metadata)
Overrides org. |
| public void | preProcess()
Overrides org. |
| public void | preProcessForCanonicalModel()
INTERNAL:
The pre-process for canonical model method is called (and only called)
during the canonical model generation.
|
| public void | process()
Overrides org. |
| public void | processAccessMethods()
INTERNAL: For VIRTUAL access we need to look for default access methods that we need to use with our mapping attributes. |
| public void | processAccessType()
INTERNAL:
Figure out the access type for this entity.
|
| protected void | processCaching()
INTERNAL:
Process a caching metadata for this entity accessor logging ignore
warnings where necessary.
|
| protected void | |
| public String | |
| public void | processConvert(ConvertMetadata convert)
INTERNAL: Add a convert metadata to the descriptor convert map. |
| public void | processConverts()
INTERNAL: Process the convert metadata for this entity accessor logging ignore warnings where necessary. |
| public void | processDerivedId(HashSet<ClassAccessor> processing, HashSet<ClassAccessor> processed)
Overrides org. |
| public DatabaseField | processDiscriminatorColumn()
INTERNAL: Process the discriminator column metadata (defaulting if necessary), and return the EclipseLink database field. |
| public String | processDiscriminatorValue()
INTERNAL: Process a discriminator value to set the class indicator on the root descriptor of the inheritance hierarchy. |
| protected void | |
| protected void | |
| protected void | |
| protected void | processInheritance()
INTERNAL: Process the Inheritance metadata for a root of an inheritance hierarchy. |
| public void | processInheritancePrimaryKeyJoinColumns()
INTERNAL: Process the inheritance metadata for an inheritance subclass. |
| public void | |
| public void | processMappingAccessors()
INTERNAL:
Process the accessors for the given class.
|
| protected void | processSecondaryTable(SecondaryTableMetadata secondaryTable)
INTERNAL: Process a MetadataSecondaryTable. |
| protected void | |
| protected void | |
| protected void | |
| protected void | |
| public void | |
| public void | |
| public void | |
| public void | setDiscriminatorColumn(DiscriminatorColumnMetadata discriminatorColumn)
INTERNAL: Used for OX mapping. |
| public void | |
| public void | |
| public void | |
| public void | |
| public void | setNamedEntityGraphs(List<NamedEntityGraphMetadata> namedEntityGraphs)
INTERNAL: Used for OX mapping. |
| public void | setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey)
INTERNAL: Used for OX mapping. |
| public void | setPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns)
INTERNAL: Used for OX mapping. |
| public void | |
| public void | |
| protected void | |
| protected void |
| m_cascadeOnDelete | back to summary |
|---|---|
| private Boolean m_cascadeOnDelete | |
| m_classExtractor | back to summary |
|---|---|
| private MetadataClass m_classExtractor | |
| m_classExtractorName | back to summary |
|---|---|
| private String m_classExtractorName | |
| m_converts | back to summary |
|---|---|
| private List<ConvertMetadata> m_converts | |
| m_discriminatorColumn | back to summary |
|---|---|
| private DiscriminatorColumnMetadata m_discriminatorColumn | |
| m_discriminatorValue | back to summary |
|---|---|
| private String m_discriminatorValue | |
| m_entityName | back to summary |
|---|---|
| private String m_entityName | |
| m_indexes | back to summary |
|---|---|
| private List<IndexMetadata> m_indexes | |
| m_inheritance | back to summary |
|---|---|
| private InheritanceMetadata m_inheritance | |
| m_namedEntityGraphs | back to summary |
|---|---|
| private List<NamedEntityGraphMetadata> m_namedEntityGraphs | |
| m_primaryKeyForeignKey | back to summary |
|---|---|
| private PrimaryKeyForeignKeyMetadata m_primaryKeyForeignKey | |
| m_primaryKeyJoinColumns | back to summary |
|---|---|
| private List<PrimaryKeyJoinColumnMetadata> m_primaryKeyJoinColumns | |
| m_secondaryTables | back to summary |
|---|---|
| private List<SecondaryTableMetadata> m_secondaryTables | |
| m_table | back to summary |
|---|---|
| private TableMetadata m_table | |
| EntityAccessor | back to summary |
|---|---|
| public EntityAccessor() INTERNAL: | |
| EntityAccessor | back to summary |
|---|---|
| public EntityAccessor(MetadataAnnotation annotation, MetadataClass cls, MetadataProject project) INTERNAL: | |
| addMultipleTableKeyFields | back to summary |
|---|---|
| protected void addMultipleTableKeyFields(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns, DatabaseTable targetTable, String PK_CTX, String FK_CTX) INTERNAL: Add multiple fields to the descriptor. Called from either Inheritance or SecondaryTable context. | |
| discoverMappedSuperclassesAndInheritanceParents | back to summary |
|---|---|
| protected void discoverMappedSuperclassesAndInheritanceParents(boolean addMappedSuperclassAccessors) INTERNAL: Build a list of classes that are decorated with a MappedSuperclass annotation or that are tagged as a mapped-superclass in an XML document. This method will also do a couple other things as well since we are traversing the parent classes: - Build a map of generic types specified and will be used to resolve actual class types for mappings. - Will discover and set the inheritance parent and root descriptors if this entity is part of an inheritance hierarchy. - save mapped-superclass descriptors on the project for later use by the Metamodel API Note: The list is rebuilt every time this method is called since it is called both during pre-deploy and deploy where the class loader dependencies change. | |
| getCascadeOnDelete | back to summary |
|---|---|
| public Boolean getCascadeOnDelete() INTERNAL: Used for OX mapping. | |
| getClassExtractorName | back to summary |
|---|---|
| public String getClassExtractorName() INTERNAL: Used for OX mapping. | |
| getConverts | back to summary |
|---|---|
| public List INTERNAL: Used for OX mapping. | |
| getDiscriminatorColumn | back to summary |
|---|---|
| public DiscriminatorColumnMetadata getDiscriminatorColumn() INTERNAL: Used for OX mapping. | |
| getDiscriminatorValue | back to summary |
|---|---|
| public String getDiscriminatorValue() INTERNAL: Used for OX mapping. | |
| getEntityName | back to summary |
|---|---|
| public String getEntityName() INTERNAL: Used for OX mapping. | |
| getIndexes | back to summary |
|---|---|
| public List INTERNAL: Used for OX mapping. | |
| getInheritance | back to summary |
|---|---|
| public InheritanceMetadata getInheritance() INTERNAL: Used for OX mapping. | |
| getNamedEntityGraphs | back to summary |
|---|---|
| public List INTERNAL: Used for OX mapping. | |
| getPrimaryKeyForeignKey | back to summary |
|---|---|
| public PrimaryKeyForeignKeyMetadata getPrimaryKeyForeignKey() INTERNAL: Used for OX mapping. | |
| getPrimaryKeyJoinColumns | back to summary |
|---|---|
| public List INTERNAL: Used for OX mapping. | |
| getSecondaryTables | back to summary |
|---|---|
| public List INTERNAL: Used for OX mapping. | |
| getTable | back to summary |
|---|---|
| public TableMetadata getTable() INTERNAL: Used for OX mapping. | |
| hasClassExtractor | back to summary |
|---|---|
| public boolean hasClassExtractor() INTERNAL: This method is a little involved since a class extractor is mutually exclusive with a discriminator column. Within one xml file it is impossible to have both specified since they are within a choice tag. However, if one is specified in the orm.xml and the other in the eclipselink-orm.xml, after the merge both will be set on this accessor, so we need to check which came from the eclipselink-orm.xml because it is the one we need to use. | |
| hasInheritance | back to summary |
|---|---|
| public boolean hasInheritance() INTERNAL: Return true if this class has an inheritance specifications. | |
| initXMLObject | back to summary |
|---|---|
| public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) INTERNAL:
| |
| isCascadeOnDelete | back to summary |
|---|---|
| public boolean isCascadeOnDelete() INTERNAL: | |
| isEntityAccessor | back to summary |
|---|---|
| public boolean isEntityAccessor() Overrides org. INTERNAL: Return true if this accessor represents an entity class.
| |
| isMappedSuperclass | back to summary |
|---|---|
| public boolean isMappedSuperclass() INTERNAL:
| |
| merge | back to summary |
|---|---|
| public void merge(ORMetadata metadata) Overrides org. INTERNAL: Entity level merging details.
| |
| preProcess | back to summary |
|---|---|
| public void preProcess() Overrides org. INTERNAL: The pre-process method is called during regular deployment and metadata processing and will pre-process the items of interest on an entity class. The order of processing is important, care must be taken if changes must be made.
| |
| preProcessForCanonicalModel | back to summary |
|---|---|
| public void preProcessForCanonicalModel() INTERNAL: The pre-process for canonical model method is called (and only called) during the canonical model generation. The use of this pre-process allows us to remove some items from the regular pre-process that do not apply to the canonical model generation. The order of processing is important, care must be taken if changes must be made.
| |
| process | back to summary |
|---|---|
| public void process() Overrides org. INTERNAL: Process the items of interest on an entity class. The order of processing is important, care must be taken if changes must be made.
| |
| processAccessMethods | back to summary |
|---|---|
| public void processAccessMethods() INTERNAL: For VIRTUAL access we need to look for default access methods that we need to use with our mapping attributes. | |
| processAccessType | back to summary |
|---|---|
| public void processAccessType() INTERNAL: Figure out the access type for this entity. It works as follows: 1 - check for an explicit access type specification 2 - check our inheritance parents (ignoring explicit specifications) 3 - check our mapped superclasses (ignoring explicit specifications) for the location of annotations 4 - check the entity itself for the location of annotations 5 - check for an xml default from a persistence-unit-metadata-defaults or entity-mappings setting. 6 - we have exhausted our search, default to FIELD.
| |
| processCaching | back to summary |
|---|---|
| protected void processCaching() INTERNAL: Process a caching metadata for this entity accessor logging ignore warnings where necessary.
| |
| processCascadeOnDelete | back to summary |
|---|---|
| protected void processCascadeOnDelete() INTERNAL: Check if CascadeOnDelete was set on the Entity. | |
| processClassExtractor | back to summary |
|---|---|
| public String processClassExtractor() INTERNAL: Return the user defined class extractor class for this entity. Assumes hasClassExtractor has been called beforehand (meaning we either have an annotation or XML definition. | |
| processConvert | back to summary |
|---|---|
| public void processConvert(ConvertMetadata convert) INTERNAL: Add a convert metadata to the descriptor convert map. | |
| processConverts | back to summary |
|---|---|
| public void processConverts() INTERNAL: Process the convert metadata for this entity accessor logging ignore warnings where necessary. | |
| processDerivedId | back to summary |
|---|---|
| public void processDerivedId(HashSet<ClassAccessor> processing, HashSet<ClassAccessor> processed) Overrides org. INTERNAL: Allows for processing DerivedIds. All referenced accessors are processed first to ensure the necessary fields are set before this derivedId is processed
| |
| processDiscriminatorColumn | back to summary |
|---|---|
| public DatabaseField processDiscriminatorColumn() INTERNAL: Process the discriminator column metadata (defaulting if necessary), and return the EclipseLink database field. | |
| processDiscriminatorValue | back to summary |
|---|---|
| public String processDiscriminatorValue() INTERNAL: Process a discriminator value to set the class indicator on the root descriptor of the inheritance hierarchy. If there is no discriminator value, the class indicator defaults to the class name. | |
| processEntity | back to summary |
|---|---|
| protected void processEntity() INTERNAL: Process the entity metadata. | |
| processEntityGraphs | back to summary |
|---|---|
| protected void processEntityGraphs() INTERNAL: Process the entity graph metadata on this entity accessor. | |
| processIndexes | back to summary |
|---|---|
| protected void processIndexes() INTERNAL: Process index information for the given metadata descriptor. | |
| processInheritance | back to summary |
|---|---|
| protected void processInheritance() INTERNAL: Process the Inheritance metadata for a root of an inheritance hierarchy. One may or may not be specified for the entity class that is the root of the entity class hierarchy, so we need to default in this case. This method should only be called on the root of the inheritance hierarchy. | |
| processInheritancePrimaryKeyJoinColumns | back to summary |
|---|---|
| public void processInheritancePrimaryKeyJoinColumns() INTERNAL: Process the inheritance metadata for an inheritance subclass. The parent descriptor must be provided. | |
| processListeners | back to summary |
|---|---|
| public void processListeners(ClassLoader loader) INTERNAL: Process the listeners for this entity. | |
| processMappingAccessors | back to summary |
|---|---|
| public void processMappingAccessors() INTERNAL: Process the accessors for the given class. If we are within a TABLE_PER_CLASS inheritance hierarchy, our parent accessors will already have been added at this point. | |
| processSecondaryTable | back to summary |
|---|---|
| protected void processSecondaryTable(SecondaryTableMetadata secondaryTable) INTERNAL: Process a MetadataSecondaryTable. Do all the table name defaulting and set the correct, fully qualified name on the TopLink DatabaseTable. | |
| processSecondaryTables | back to summary |
|---|---|
| protected void processSecondaryTables() INTERNAL: Process secondary-table(s) for a given entity. | |
| processTable | back to summary |
|---|---|
| protected void processTable() INTERNAL: Process table information for the given metadata descriptor. | |
| processTable | back to summary |
|---|---|
| protected void processTable(TableMetadata table) INTERNAL: Process a MetadataTable. Do all the table name defaulting and set the correct, fully qualified name on the TopLink DatabaseTable. | |
| processTableAndInheritance | back to summary |
|---|---|
| protected void processTableAndInheritance() INTERNAL: Process any inheritance specifics. Note Inheritance hierarchies are always processed from the top down so it is safe to assume that all our parents have already been processed fully. The only exception being when a root accessor doesn't know they are a root (defaulting case). In this case we'll tell the root accessor to process the inheritance metadata before continuing with our own processing. | |
| setCascadeOnDelete | back to summary |
|---|---|
| public void setCascadeOnDelete(Boolean cascadeOnDelete) INTERNAL: Used for OX mapping. | |
| setClassExtractorName | back to summary |
|---|---|
| public void setClassExtractorName(String classExtractorName) INTERNAL: Used for OX mapping. | |
| setConverts | back to summary |
|---|---|
| public void setConverts(List<ConvertMetadata> converts) INTERNAL: Used for OX mapping. | |
| setDiscriminatorColumn | back to summary |
|---|---|
| public void setDiscriminatorColumn(DiscriminatorColumnMetadata discriminatorColumn) INTERNAL: Used for OX mapping. | |
| setDiscriminatorValue | back to summary |
|---|---|
| public void setDiscriminatorValue(String discriminatorValue) INTERNAL: Used for OX mapping. | |
| setEntityName | back to summary |
|---|---|
| public void setEntityName(String entityName) INTERNAL: Used for OX mapping. | |
| setIndexes | back to summary |
|---|---|
| public void setIndexes(List<IndexMetadata> indexes) INTERNAL: Used for OX mapping. | |
| setInheritance | back to summary |
|---|---|
| public void setInheritance(InheritanceMetadata inheritance) INTERNAL: Used for OX mapping. | |
| setNamedEntityGraphs | back to summary |
|---|---|
| public void setNamedEntityGraphs(List<NamedEntityGraphMetadata> namedEntityGraphs) INTERNAL: Used for OX mapping. | |
| setPrimaryKeyForeignKey | back to summary |
|---|---|
| public void setPrimaryKeyForeignKey(PrimaryKeyForeignKeyMetadata primaryKeyForeignKey) INTERNAL: Used for OX mapping. | |
| setPrimaryKeyJoinColumns | back to summary |
|---|---|
| public void setPrimaryKeyJoinColumns(List<PrimaryKeyJoinColumnMetadata> primaryKeyJoinColumns) INTERNAL: Used for OX mapping. | |
| setSecondaryTables | back to summary |
|---|---|
| public void setSecondaryTables(List<SecondaryTableMetadata> secondaryTables) INTERNAL: Used for OX mapping. | |
| setTable | back to summary |
|---|---|
| public void setTable(TableMetadata table) INTERNAL: Used for OX mapping. | |
| validateOptimisticLocking | back to summary |
|---|---|
| protected void validateOptimisticLocking() INTERNAL: Validate a OptimisticLocking(type=VERSION_COLUMN) setting. That is, validate that we found a version field. If not, throw an exception. | |
| validatePrimaryKey | back to summary |
|---|---|
| protected void validatePrimaryKey() INTERNAL: Call this method after a primary key should have been found. | |