Package org.eclipse.persistence.internal.jpa.metadata.xml

Class XMLEntityMappings

  • public class XMLEntityMappings
extends ORMetadata
    Object to hold onto the XML entity mappings metadata.
    Since:
    EclipseLink 1.0
    Author:
    Guy Pelletier

    • Constructor Detail

      • XMLEntityMappings

        public XMLEntityMappings()
        INTERNAL:

    • Method Detail

      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        INTERNAL:
        Specified by:
        equals in class ORMetadata

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getAccess

        public java.lang.String getAccess()
        INTERNAL: Used for OX mapping.

      • getCatalog

        public java.lang.String getCatalog()
        INTERNAL: Used for OX mapping.

      • getConverterAccessors

        public java.util.List<ConverterAccessor> getConverterAccessors()
        INTERNAL:

      • getDefaultCatalog

        protected java.lang.String getDefaultCatalog()
        INTERNAL: Returns the default catalog. Either from entity-mappings or persistence unit defaults. Note, null could be returned.

      • getDefaultSchema

        protected java.lang.String getDefaultSchema()
        INTERNAL: Returns the default schema. Either from entity-mappings or persistence unit defaults. Note, null could be returned.

      • getDescription

        public java.lang.String getDescription()
        INTERNAL: Used for OX mapping.

      • getEmbeddables

        public java.util.List<EmbeddableAccessor> getEmbeddables()
        INTERNAL: Used for OX mapping.

      • getEntities

        public java.util.List<EntityAccessor> getEntities()
        INTERNAL: Used for OX mapping.

      • getPackageQualifiedClassName

        public java.lang.String getPackageQualifiedClassName​(java.lang.String className)
        INTERNAL: This convenience method will attempt to fully qualify a class name if required. This assumes that the className value is non-null, and a "qualified" class name contains at least one '.' Future: What about Enum support? Employee.Enum currently would not qualify with the package since there is a dot.

      • getHashPartitioning

        public java.util.List<HashPartitioningMetadata> getHashPartitioning()
        INTERNAL: Used for OX mapping.

      • getMappedSuperclasses

        public java.util.List<MappedSuperclassAccessor> getMappedSuperclasses()
        INTERNAL: Used for OX mapping.

      • getMappingFileOrURL

        public java.lang.String getMappingFileOrURL()
        INTERNAL:

      • getMixedConverters

        public java.util.List<MixedConverterMetadata> getMixedConverters()
        INTERNAL: Used for OX mapping.

      • getNamedNativeQueries

        public java.util.List<NamedNativeQueryMetadata> getNamedNativeQueries()
        INTERNAL: Used for OX mapping.

      • getNamedQueries

        public java.util.List<NamedQueryMetadata> getNamedQueries()
        INTERNAL: Used for OX mapping.

      • getObjectTypeConverters

        public java.util.List<ObjectTypeConverterMetadata> getObjectTypeConverters()
        INTERNAL: Used for OX mapping.

      • getPackage

        public java.lang.String getPackage()
        INTERNAL: Used for OX mapping.

      • getPartitioning

        public java.util.List<PartitioningMetadata> getPartitioning()
        INTERNAL: Used for OX mapping.

      • getPinnedPartitioning

        public java.util.List<PinnedPartitioningMetadata> getPinnedPartitioning()
        INTERNAL: Used for OX mapping.

      • getOracleArrayTypes

        public java.util.List<OracleArrayTypeMetadata> getOracleArrayTypes()
        INTERNAL: Used for OX mapping.

      • getOracleObjectTypes

        public java.util.List<OracleObjectTypeMetadata> getOracleObjectTypes()
        INTERNAL: Used for OX mapping.

      • getPLSQLTables

        public java.util.List<PLSQLTableMetadata> getPLSQLTables()
        INTERNAL: Used for OX mapping.

      • getRangePartitioning

        public java.util.List<RangePartitioningMetadata> getRangePartitioning()
        INTERNAL: Used for OX mapping.

      • getSchema

        public java.lang.String getSchema()
        INTERNAL: Used for OX mapping.

      • getSequenceGenerators

        public java.util.List<SequenceGeneratorMetadata> getSequenceGenerators()
        INTERNAL: Used for OX mapping.

      • getSqlResultSetMappings

        public java.util.List<SQLResultSetMappingMetadata> getSqlResultSetMappings()
        INTERNAL: Used for OX mapping.

      • getStructConverters

        public java.util.List<StructConverterMetadata> getStructConverters()
        INTERNAL: Used for OX mapping.

      • getTableGenerators

        public java.util.List<TableGeneratorMetadata> getTableGenerators()
        INTERNAL: Used for OX mapping.

      • getTypeConverters

        public java.util.List<TypeConverterMetadata> getTypeConverters()
        INTERNAL: Used for OX mapping.

      • getSerializedConverters

        public java.util.List<SerializedConverterMetadata> getSerializedConverters()
        INTERNAL: Used for OX mapping.

      • getUnionPartitioning

        public java.util.List<UnionPartitioningMetadata> getUnionPartitioning()
        INTERNAL: Used for OX mapping.

      • getUuidGenerators

        public java.util.List<UuidGeneratorMetadata> getUuidGenerators()
        INTERNAL: Used for OX mapping.

      • getValuePartitioning

        public java.util.List<ValuePartitioningMetadata> getValuePartitioning()
        INTERNAL: Used for OX mapping.

      • getVersion

        public java.lang.String getVersion()
        INTERNAL: Used for OX mapping.

      • initPersistenceUnitClasses

        public void initPersistenceUnitClasses​(java.util.HashMap<java.lang.String,​EntityAccessor> allEntities,
                                       java.util.HashMap<java.lang.String,​EmbeddableAccessor> allEmbeddables)
        INTERNAL: Assumes the correct class loader has been set before calling this method.

      • isEclipseLinkORMFile

        public boolean isEclipseLinkORMFile()
        INTERNAL:

      • loadedForCanonicalModel

        public boolean loadedForCanonicalModel()
        INTERNAL:

      • newXMLEntityMappingsObject

        protected XMLEntityMappings newXMLEntityMappingsObject()
        INTERNAL: Return a new XMLEntityMappings instance. Used for reloading entities and mapped superclasses.

      • process

        public void process()
        INTERNAL: Process the metadata from the <entity-mappings> level except for the classes themselves. They will be processed afterwards and controlled by the MetadataProcessor. Note: this method does a few things of interest. It not only adds metadata to the project but it will also override (that is EclipseLink-ORM-XML-->JPA-XML && JPA-XML-->Annotation) the necessary metadata and log messages to the user. A validation exception could also be thrown. See the related processing methods for more details. Any XML metadata of the types processed below should call these methods. That is, as an example, a converter can be found at the entity-mappings and entity level. Therefore you must ensure that those from levels other than the entity-mappings call these methods as well to ensure consistent metadata processing (and behavior).

      • processEntityMappingsDefaults

        public void processEntityMappingsDefaults​(ClassAccessor accessor)
        INTERNAL: Set any entity-mappings defaults if specified. Do not blindly set them since a global setting from the persistence-unit-metadata/defaults may have been set and you do not want to risk removing the global value.

      • processPersistenceUnitMetadata

        public void processPersistenceUnitMetadata()
        INTERNAL: Process the persistence metadata if specified. Any conflicts in elements defined in multiple documents will cause an exception to be thrown (unless an override needs to occur from an eclipselink-orm.xml file). The one exception to this rule is default listeners: all default listeners found will be added to a list in the order that they are read from the instance document(s).

      • setAccess

        public void setAccess​(java.lang.String access)
        INTERNAL: Used for OX mapping.

      • setAccessMethods

        public void setAccessMethods​(AccessMethodsMetadata accessMethods)
        INTERNAL: Used for OX mapping.

      • setCatalog

        public void setCatalog​(java.lang.String catalog)
        INTERNAL: Used for OX mapping.

      • setConverterAccessors

        public void setConverterAccessors​(java.util.List<ConverterAccessor> converterAccessors)
        INTERNAL:

      • setConverters

        public void setConverters​(java.util.List<ConverterMetadata> converters)
        INTERNAL:

      • setDescription

        public void setDescription​(java.lang.String description)
        INTERNAL: Used for OX mapping.

      • setEmbeddables

        public void setEmbeddables​(java.util.List<EmbeddableAccessor> embeddables)
        INTERNAL: Used for OX mapping.

      • setEntities

        public void setEntities​(java.util.List<EntityAccessor> entities)
        INTERNAL: Used for OX mapping.

      • setHashPartitioning

        public void setHashPartitioning​(java.util.List<HashPartitioningMetadata> hashPartitioning)
        INTERNAL: Used for OX mapping.

      • setIsEclipseLinkORMFile

        public void setIsEclipseLinkORMFile​(boolean isEclipseLinkORMFile)
        INTERNAL:

      • setLoadedForCanonicalModel

        public void setLoadedForCanonicalModel​(boolean loadedForCanonicalModel)
        INTERNAL:

      • setLoader

        public void setLoader​(java.lang.ClassLoader loader)
        INTERNAL:

      • setMappedSuperclasses

        public void setMappedSuperclasses​(java.util.List<MappedSuperclassAccessor> mappedSuperclasses)
        INTERNAL: Used for OX mapping.

      • setMappingFile

        public void setMappingFile​(java.lang.String mappingFileNameOrURL)
        INTERNAL:

      • setMetadataFactory

        public void setMetadataFactory​(MetadataFactory factory)
        INTERNAL:

      • setMixedConverters

        public void setMixedConverters​(java.util.List<MixedConverterMetadata> mixedConverters)
        INTERNAL: Used for OX mapping.

      • setNamedNativeQueries

        public void setNamedNativeQueries​(java.util.List<NamedNativeQueryMetadata> namedNativeQueries)
        INTERNAL: Used for OX mapping.

      • setNamedPLSQLStoredFunctionQueries

        public void setNamedPLSQLStoredFunctionQueries​(java.util.List<NamedPLSQLStoredFunctionQueryMetadata> namedPLSQLStoredFunctionQueries)
        INTERNAL: Used for OX mapping.

      • setNamedPLSQLStoredProcedureQueries

        public void setNamedPLSQLStoredProcedureQueries​(java.util.List<NamedPLSQLStoredProcedureQueryMetadata> namedPLSQLStoredProcedureQueries)
        INTERNAL: Used for OX mapping.

      • setNamedQueries

        public void setNamedQueries​(java.util.List<NamedQueryMetadata> namedQueries)
        INTERNAL: Used for OX mapping.

      • setNamedStoredFunctionQueries

        public void setNamedStoredFunctionQueries​(java.util.List<NamedStoredFunctionQueryMetadata> namedStoredFunctionQueries)
        INTERNAL: Used for OX mapping.

      • setNamedStoredProcedureQueries

        public void setNamedStoredProcedureQueries​(java.util.List<NamedStoredProcedureQueryMetadata> namedStoredProcedureQueries)
        INTERNAL: Used for OX mapping.

      • setObjectTypeConverters

        public void setObjectTypeConverters​(java.util.List<ObjectTypeConverterMetadata> objectTypeConverters)
        INTERNAL: Used for OX mapping.

      • setPackage

        public void setPackage​(java.lang.String pkg)
        INTERNAL: Used for OX mapping.

      • setPartitioning

        public void setPartitioning​(java.util.List<PartitioningMetadata> partitioning)
        INTERNAL: Used for OX mapping.

      • setPersistenceUnitMetadata

        public void setPersistenceUnitMetadata​(XMLPersistenceUnitMetadata persistenceUnitMetadata)
        INTERNAL: Used for OX mapping.

      • setPinnedPartitioning

        public void setPinnedPartitioning​(java.util.List<PinnedPartitioningMetadata> pinnedPartitioning)
        INTERNAL: Used for OX mapping.

      • setOracleArrayTypes

        public void setOracleArrayTypes​(java.util.List<OracleArrayTypeMetadata> arrayTypes)
        INTERNAL: Used for OX mapping.

      • setOracleObjectTypes

        public void setOracleObjectTypes​(java.util.List<OracleObjectTypeMetadata> objectTypes)
        INTERNAL: Used for OX mapping.

      • setPLSQLRecords

        public void setPLSQLRecords​(java.util.List<PLSQLRecordMetadata> records)
        INTERNAL: Used for OX mapping.

      • setPLSQLTables

        public void setPLSQLTables​(java.util.List<PLSQLTableMetadata> tables)
        INTERNAL: Used for OX mapping.

      • setProject

        public void setProject​(MetadataProject project)
        INTERNAL: Set the project reference for this EntityMappings object.
        Overrides:
        setProject in class ORMetadata

      • setRangePartitioning

        public void setRangePartitioning​(java.util.List<RangePartitioningMetadata> rangePartitioning)
        INTERNAL: Used for OX mapping.

      • setReplicationPartitioning

        public void setReplicationPartitioning​(java.util.List<ReplicationPartitioningMetadata> replicationPartitioning)
        INTERNAL: Used for OX mapping.

      • setRoundRobinPartitioning

        public void setRoundRobinPartitioning​(java.util.List<RoundRobinPartitioningMetadata> roundRobinPartitioning)
        INTERNAL: Used for OX mapping.

      • setSchema

        public void setSchema​(java.lang.String schema)
        INTERNAL: Used for OX mapping.

      • setSequenceGenerators

        public void setSequenceGenerators​(java.util.List<SequenceGeneratorMetadata> sequenceGenerators)
        INTERNAL: Used for OX mapping.

      • setSqlResultSetMappings

        public void setSqlResultSetMappings​(java.util.List<SQLResultSetMappingMetadata> sqlResultSetMappings)
        INTERNAL: Used for OX mapping.

      • setStructConverters

        public void setStructConverters​(java.util.List<StructConverterMetadata> structConverters)
        INTERNAL: Used for OX mapping.

      • setTableGenerators

        public void setTableGenerators​(java.util.List<TableGeneratorMetadata> tableGenerators)
        INTERNAL: Used for OX mapping.

      • setTenantDiscriminatorColumns

        public void setTenantDiscriminatorColumns​(java.util.List<TenantDiscriminatorColumnMetadata> tenantDiscriminatorColumns)
        INTERNAL: Used for OX mapping.

      • setTypeConverters

        public void setTypeConverters​(java.util.List<TypeConverterMetadata> typeConverters)
        INTERNAL: Used for OX mapping.

      • setSerializedConverters

        public void setSerializedConverters​(java.util.List<SerializedConverterMetadata> serializedConverters)
        INTERNAL: Used for OX mapping.

      • setUnionPartitioning

        public void setUnionPartitioning​(java.util.List<UnionPartitioningMetadata> unionPartitioning)
        INTERNAL: Used for OX mapping.

      • setUuidGenerators

        public void setUuidGenerators​(java.util.List<UuidGeneratorMetadata> uuidGenerators)
        INTERNAL: Used for OX mapping.

      • setValuePartitioning

        public void setValuePartitioning​(java.util.List<ValuePartitioningMetadata> valuePartitioning)
        INTERNAL: Used for OX mapping.

      • setVersion

        public void setVersion​(java.lang.String version)
        INTERNAL: Used for OX mapping.