org.eclipse.jpt.jpa.eclipselink.core.context.orm
Interface EclipseLinkOrmEntity

All Superinterfaces:

EclipseLinkConvertibleMapping, EclipseLinkEntity, EclipseLinkNonEmbeddableTypeMapping, EclipseLinkOrmNonEmbeddableTypeMapping, EclipseLinkOrmTypeMapping, EclipseLinkTypeMapping, Entity, IAdaptable, IdTypeMapping, JpaContextModel, JpaModel, JptResourceTypeReference, Model, OrmEntity, OrmIdTypeMapping, OrmTypeMapping, TypeMapping, TypeRefactoringParticipant

public interface EclipseLinkOrmEntity
extends OrmEntity, EclipseLinkEntity, EclipseLinkOrmNonEmbeddableTypeMapping

EclipseLink orm.xml entity

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:

2.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.Entity

Entity.IsDescendant

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.TypeRefactoringParticipant

TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkTypeMapping

EclipseLinkTypeMapping.ConvertersTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.TypeMapping

TypeMapping.GeneratorsTransformer, TypeMapping.QueriesTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkConvertibleMapping

EclipseLinkConvertibleMapping.AttributeMappingConvertersTransformer

Field Summary

Fields inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmEntity

DEFAULT_PRIMARY_KEY_JOIN_COLUMNS_LIST, VIRTUAL_SECONDARY_TABLES_LIST

Fields inherited from interface org.eclipse.jpt.jpa.core.context.Entity

DEFAULT_DISCRIMINATOR_VALUE_PROPERTY, DEFAULT_INHERITANCE_STRATEGY_PROPERTY, DEFAULT_NAME_PROPERTY, DESCENDANTS_COLLECTION, DISCRIMINATOR_COLUMN_IS_UNDEFINED_PROPERTY, DISCRIMINATOR_VALUE_IS_UNDEFINED_PROPERTY, ROOT_ENTITY_PROPERTY, SPECIFIED_DISCRIMINATOR_COLUMN_IS_ALLOWED_PROPERTY, SPECIFIED_DISCRIMINATOR_VALUE_IS_ALLOWED_PROPERTY, SPECIFIED_DISCRIMINATOR_VALUE_PROPERTY, SPECIFIED_INHERITANCE_STRATEGY_PROPERTY, SPECIFIED_NAME_PROPERTY, SPECIFIED_PRIMARY_KEY_JOIN_COLUMNS_LIST, SPECIFIED_SECONDARY_TABLES_LIST, SPECIFIED_TABLE_IS_ALLOWED_PROPERTY, TABLE_IS_UNDEFINED_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmTypeMapping

DEFAULT_PARENT_CLASS_PROPERTY, FULLY_QUALIFIED_PARENT_CLASS_PROPERTY, OVERRIDE_METADATA_COMPLETE_PROPERTY, SPECIFIED_METADATA_COMPLETE_PROPERTY, SPECIFIED_PARENT_CLASS_PROPERTY

Fields inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkTypeMapping

CONVERTERS_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.jpa.core.context.TypeMapping

GENERATORS_TRANSFORMER, QUERIES_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

TRANSFORMER

Fields inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkConvertibleMapping

ATTRIBUTE_MAPPING_CONVERTERS_TRANSFORMER

Method Summary

EclipseLinkJavaEntity	getJavaTypeMapping() Return the Java type mapping corresponding to the orm.xml type mapping.
EclipseLinkJavaEntity	getJavaTypeMappingForDefaults() Check "metadata complete" before returning the Java type mapping.
org.eclipse.jpt.jpa.eclipselink.core.resource.orm.XmlEntity	getXmlTypeMapping()

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmEntity

addSpecifiedPrimaryKeyJoinColumn, addSpecifiedPrimaryKeyJoinColumn, addSpecifiedSecondaryTable, addSpecifiedSecondaryTable, getAssociationOverrideContainer, getAttributeOverrideContainer, getDefaultPrimaryKeyJoinColumns, getDefaultPrimaryKeyJoinColumnsSize, getDiscriminatorColumn, getGeneratorContainer, getPrimaryKeyJoinColumns, getQueryContainer, getSecondaryTables, getSpecifiedPrimaryKeyJoinColumns, getSpecifiedSecondaryTables, getTable, getVirtualSecondaryTables, getVirtualSecondaryTablesSize, secondaryTablesAreDefinedInXml, setSecondaryTablesAreDefinedInXml

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmIdTypeMapping

getIdClassReference, getJavaIdClassReferenceForDefaults, getXmlIdClassContainer

Methods inherited from interface org.eclipse.jpt.jpa.core.context.Entity

clearSpecifiedPrimaryKeyJoinColumns, convertDefaultPrimaryKeyJoinColumnsToSpecified, discriminatorColumnIsUndefined, discriminatorValueIsUndefined, getDefaultCatalog, getDefaultDiscriminatorValue, getDefaultInheritanceStrategy, getDefaultName, getDefaultSchema, getDefaultTableName, getDescendants, getDiscriminatorValue, getIdAttribute, getInheritanceStrategy, getNameTextRange, getParentEntity, getPrimaryKeyColumnName, getPrimaryKeyJoinColumnsSize, getRootEntity, getSecondaryTablesSize, getSpecifiedDiscriminatorValue, getSpecifiedInheritanceStrategy, getSpecifiedName, getSpecifiedPrimaryKeyJoinColumn, getSpecifiedPrimaryKeyJoinColumnsSize, getSpecifiedSecondaryTablesSize, moveSpecifiedPrimaryKeyJoinColumn, moveSpecifiedSecondaryTable, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedPrimaryKeyJoinColumn, removeSpecifiedSecondaryTable, removeSpecifiedSecondaryTable, resolveAttributeMapping, setSpecifiedDiscriminatorValue, setSpecifiedInheritanceStrategy, setSpecifiedName, specifiedDiscriminatorColumnIsAllowed, specifiedDiscriminatorValueIsAllowed, specifiedTableIsAllowed, supportsValidationMessages, tableIsUndefined

Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.orm.EclipseLinkOrmNonEmbeddableTypeMapping

getGeneratorContainer, getMultitenancy

Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkNonEmbeddableTypeMapping

getCaching, getReadOnly, isMultitenantMetadataAllowed

Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.orm.EclipseLinkOrmTypeMapping

getConverterContainer

Methods inherited from interface org.eclipse.jpt.jpa.core.context.orm.OrmTypeMapping

addXmlTypeMappingTo, getAttributesTextRange, getDefaultParentClass, getFullyQualifiedParentClass, getParentClass, getPersistentType, getSelectionTextRange, getSpecifiedMetadataComplete, getSpecifiedParentClass, getXmlSequence, initializeFrom, isMetadataComplete, isOverrideMetadataComplete, removeXmlTypeMappingFrom, setSpecifiedMetadataComplete, setSpecifiedParentClass

Methods inherited from interface org.eclipse.jpt.jpa.core.context.TypeRefactoringParticipant

createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits

Methods inherited from interface org.eclipse.jpt.jpa.eclipselink.core.context.EclipseLinkTypeMapping

getChangeTracking, getConverters, getCustomizer, usesPrimaryKeyColumns, usesPrimaryKeyTenantDiscriminatorColumns

Methods inherited from interface org.eclipse.jpt.jpa.core.context.TypeMapping

attributeIsDerivedId, attributeMappingKeyAllowed, getAllAssociatedTableNames, getAllAssociatedTables, getAllAttributeMappings, getAllAttributeMappings, getAllOverridableAssociationNames, getAllOverridableAttributeNames, getAssociatedTables, getAttributeMappings, getAttributeMappings, getDbSchema, getGenerators, getIdClass, getInheritanceHierarchy, getJavaResourceType, getKey, getName, getNonTransientAttributeMappings, getOverridableAssociationNames, getOverridableAttributeNames, getPrimaryDbTable, getPrimaryTableName, getQueries, getSuperTypeMapping, isMapped, isRootEntity, resolveDbTable, resolveOverriddenColumn, resolveOverriddenRelationship, tableNameIsInvalid, validatesAgainstDatabase

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Method Detail

getXmlTypeMapping

org.eclipse.jpt.jpa.eclipselink.core.resource.orm.XmlEntity getXmlTypeMapping()

Specified by:

getXmlTypeMapping in interface OrmEntity

Specified by:

getXmlTypeMapping in interface OrmTypeMapping

getJavaTypeMapping

EclipseLinkJavaEntity getJavaTypeMapping()

Description copied from interface: OrmTypeMapping

Return the Java type mapping corresponding to the orm.xml type mapping. Return null if there is no such Java type mapping; i.e. it does not exist or it is not the same type of type mapping (entity, mapped superclass, embeddable).

Specified by:

getJavaTypeMapping in interface EclipseLinkOrmNonEmbeddableTypeMapping

Specified by:

getJavaTypeMapping in interface EclipseLinkOrmTypeMapping

Specified by:

getJavaTypeMapping in interface OrmEntity

Specified by:

getJavaTypeMapping in interface OrmTypeMapping

See Also:

OrmTypeMapping.getJavaTypeMappingForDefaults()

getJavaTypeMappingForDefaults

EclipseLinkJavaEntity getJavaTypeMappingForDefaults()

Description copied from interface: OrmTypeMapping

Check "metadata complete" before returning the Java type mapping. For orm.xml defaults, if "metadata complete" is true, return null.

Specified by:

getJavaTypeMappingForDefaults in interface EclipseLinkOrmNonEmbeddableTypeMapping

Specified by:

getJavaTypeMappingForDefaults in interface EclipseLinkOrmTypeMapping

Specified by:

getJavaTypeMappingForDefaults in interface OrmEntity

Specified by:

getJavaTypeMappingForDefaults in interface OrmTypeMapping

See Also:

OrmTypeMapping.getJavaTypeMapping()