org.eclipse.jpt.jpa.core.context.orm
Interface OrmTypeMapping

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, TypeMapping, TypeRefactoringParticipant

All Known Subinterfaces:

EclipseLinkOrmEmbeddable, EclipseLinkOrmEntity, EclipseLinkOrmMappedSuperclass, EclipseLinkOrmNonEmbeddableTypeMapping, EclipseLinkOrmTypeMapping, OrmEmbeddable, OrmEntity, OrmEntity2_0, OrmIdTypeMapping, OrmMappedSuperclass

public interface OrmTypeMapping
extends TypeMapping, TypeRefactoringParticipant

orm.xml type mapping

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.0

Nested Class Summary

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.core.context.TypeRefactoringParticipant

TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer

Field Summary

static String	DEFAULT_PARENT_CLASS_PROPERTY
static String	FULLY_QUALIFIED_PARENT_CLASS_PROPERTY
static String	OVERRIDE_METADATA_COMPLETE_PROPERTY
static String	SPECIFIED_METADATA_COMPLETE_PROPERTY
static String	SPECIFIED_PARENT_CLASS_PROPERTY

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

Method Summary

void	addXmlTypeMappingTo(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings) Add the type mapping's XML type mapping to the appropriate list in the specified XML entity mappings.
TextRange	getAttributesTextRange()
String	getDefaultParentClass()
String	getFullyQualifiedParentClass()
JavaTypeMapping	getJavaTypeMapping() Return the Java type mapping corresponding to the orm.xml type mapping.
JavaTypeMapping	getJavaTypeMappingForDefaults() Check "metadata complete" before returning the Java type mapping.
String	getParentClass() NB: This may be an unqualified name to be prefixed by the entity mappings's package value.
OrmPersistentType	getPersistentType()
TextRange	getSelectionTextRange()
Boolean	getSpecifiedMetadataComplete()
String	getSpecifiedParentClass()
int	getXmlSequence() Type mappings are a sequence in the orm schema.
org.eclipse.jpt.jpa.core.resource.orm.XmlTypeMapping	getXmlTypeMapping()
void	initializeFrom(OrmTypeMapping oldMapping)
boolean	isMetadataComplete()
boolean	isOverrideMetadataComplete() Override metadata complete is true if the type mapping's persistence unit is marked "XML mapping metadata complete".
void	removeXmlTypeMappingFrom(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings) Remove the type mapping's XML type mapping from the appropriate list in the specified XML entity mappings.
void	setSpecifiedMetadataComplete(Boolean metadataComplete)
void	setSpecifiedParentClass(String parentClass)

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, getInheritanceStrategy, getJavaResourceType, getKey, getName, getNonTransientAttributeMappings, getOverridableAssociationNames, getOverridableAttributeNames, getPrimaryDbTable, getPrimaryTableName, getQueries, getRootEntity, 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

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

createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits

Field Detail

SPECIFIED_METADATA_COMPLETE_PROPERTY

static final String SPECIFIED_METADATA_COMPLETE_PROPERTY

See Also:

Constant Field Values

OVERRIDE_METADATA_COMPLETE_PROPERTY

static final String OVERRIDE_METADATA_COMPLETE_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_PARENT_CLASS_PROPERTY

static final String FULLY_QUALIFIED_PARENT_CLASS_PROPERTY

See Also:

Constant Field Values

SPECIFIED_PARENT_CLASS_PROPERTY

static final String SPECIFIED_PARENT_CLASS_PROPERTY

See Also:

Constant Field Values

DEFAULT_PARENT_CLASS_PROPERTY

static final String DEFAULT_PARENT_CLASS_PROPERTY

See Also:

Constant Field Values

Method Detail

isMetadataComplete

boolean isMetadataComplete()

getSpecifiedMetadataComplete

Boolean getSpecifiedMetadataComplete()

setSpecifiedMetadataComplete

void setSpecifiedMetadataComplete(Boolean metadataComplete)

isOverrideMetadataComplete

boolean isOverrideMetadataComplete()

Override metadata complete is true if the type mapping's persistence unit is marked "XML mapping metadata complete".

getParentClass

String getParentClass()

NB: This may be an unqualified name to be prefixed by the entity mappings's package value.

See Also:

EntityMappings.getPackage()

getFullyQualifiedParentClass

String getFullyQualifiedParentClass()

getSpecifiedParentClass

String getSpecifiedParentClass()

setSpecifiedParentClass

void setSpecifiedParentClass(String parentClass)

See Also:

getParentClass()

getDefaultParentClass

String getDefaultParentClass()

getXmlSequence

int getXmlSequence()

Type mappings are a sequence in the orm schema. We must keep the list of type mappings in the appropriate order so the wtp xml translators will write them to the xml in that order and they will adhere to the schema.

Each concrete implementation must implement this method and return an int that matches its order in the schema.

See Also:

OrmManagedType.getXmlSequence()

addXmlTypeMappingTo

void addXmlTypeMappingTo(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings)

Add the type mapping's XML type mapping to the appropriate list in the specified XML entity mappings.

removeXmlTypeMappingFrom

void removeXmlTypeMappingFrom(org.eclipse.jpt.jpa.core.resource.orm.XmlEntityMappings entityMappings)

Remove the type mapping's XML type mapping from the appropriate list in the specified XML entity mappings.

getXmlTypeMapping

org.eclipse.jpt.jpa.core.resource.orm.XmlTypeMapping getXmlTypeMapping()

getSelectionTextRange

TextRange getSelectionTextRange()

getAttributesTextRange

TextRange getAttributesTextRange()

getJavaTypeMapping

JavaTypeMapping getJavaTypeMapping()

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).

See Also:

getJavaTypeMappingForDefaults()

getJavaTypeMappingForDefaults

JavaTypeMapping getJavaTypeMappingForDefaults()

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

See Also:

getJavaTypeMapping()

getPersistentType

OrmPersistentType getPersistentType()

Specified by:

getPersistentType in interface TypeMapping

initializeFrom

void initializeFrom(OrmTypeMapping oldMapping)