org.eclipse.jpt.jpa.core.context
Interface IdTypeMapping

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, TypeMapping

All Known Subinterfaces:

EclipseLinkEntity, EclipseLinkJavaEntity, EclipseLinkJavaMappedSuperclass, EclipseLinkJavaNonEmbeddableTypeMapping, EclipseLinkMappedSuperclass, EclipseLinkNonEmbeddableTypeMapping, EclipseLinkOrmEntity, EclipseLinkOrmMappedSuperclass, EclipseLinkOrmNonEmbeddableTypeMapping, Entity, JavaEntity, JavaEntity2_0, JavaIdTypeMapping, JavaMappedSuperclass, MappedSuperclass, OrmEntity, OrmEntity2_0, OrmIdTypeMapping, OrmMappedSuperclass

public interface IdTypeMapping
extends TypeMapping

ID type mapping:

• entity
• mapped superclass

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:

3.5

Nested Class Summary

static class

IdTypeMapping.SuperTypeMappingTransformer Transformer that returns the super type mapping of the input, except if result would be the leaf type mapping.

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

TypeMapping.GeneratorsTransformer, TypeMapping.MappingIsIdMapping, TypeMapping.PersistentTypeTransformer, 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

Field Summary

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

GENERATORS_TRANSFORMER, ID_ATTRIBUTE_MAPPING_KEYS, PERSISTENT_TYPE_TRANSFORMER, QUERIES_TRANSFORMER, SUPER_TYPE_MAPPING_PROPERTY

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

TRANSFORMER

Method Summary

IdClassReference	getIdClassReference() Return the (aggregate) class reference for configuring and validating the type mapping's ID class.
Iterable<IdTypeMapping>	getInheritanceHierarchy() Return the type mapping's "persistence" inheritance hierarchy, including the type mapping itself.
InheritanceType	getInheritanceStrategy() Return the inheritance strategy or null
String	getPrimaryKeyClassName() Return the fully qualified name of the type used as the primary key class (e.g. the id class name, or the type of the id mapping, etc.)
Entity	getRootEntity() Return the root entity of the inheritance hierarchy or null.
boolean	isRootEntity() Return whether this type mapping is a root entity in an inheritance hierarchy.

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

attributeIsDerivedId, attributeMappingKeyAllowed, getAllAssociatedTableNames, getAllAssociatedTables, getAllAttributeMappings, getAllAttributeMappings, getAllOverridableAssociationNames, getAllOverridableAttributeNames, getAncestors, getAssociatedTables, getAttributeMappings, getAttributeMappings, getDbSchema, getGenerators, getIdAttributeMapping, getIdAttributeMappings, getJavaResourceType, getKey, getName, getNonTransientAttributeMappings, getOverridableAssociationNames, getOverridableAttributeNames, getPersistentType, getPrimaryDbTable, getPrimaryTableName, getQueries, getSuperTypeMapping, isMapped, 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

getIdClassReference

IdClassReference getIdClassReference()

Return the (aggregate) class reference for configuring and validating the type mapping's ID class.

getPrimaryKeyClassName

String getPrimaryKeyClassName()

Return the fully qualified name of the type used as the primary key class (e.g. the id class name, or the type of the id mapping, etc.)

getInheritanceHierarchy

Iterable<IdTypeMapping> getInheritanceHierarchy()

Return the type mapping's "persistence" inheritance hierarchy, including the type mapping itself. If there is an inheritance loop, the iterable will terminate before including this type mapping a second time.

Specified by:

getInheritanceHierarchy in interface TypeMapping

See Also:

TypeMapping.getAncestors()

isRootEntity

boolean isRootEntity()

Return whether this type mapping is a root entity in an inheritance hierarchy.

getRootEntity

Entity getRootEntity()

Return the root entity of the inheritance hierarchy or null.

getInheritanceStrategy

InheritanceType getInheritanceStrategy()

Return the inheritance strategy or null