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

All Superinterfaces:

AttributeMapping, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model, TypeRefactoringParticipant

All Known Subinterfaces:

OrmBaseEmbeddedMapping, OrmBasicMapping, OrmCollectionMapping2_0, OrmColumnMapping, OrmConvertibleKeyMapping2_0, OrmConvertibleMapping, OrmElementCollectionMapping2_0, OrmEmbeddedIdMapping, OrmEmbeddedMapping, OrmEmbeddedMapping2_0, OrmGeneratedValueMapping, OrmIdMapping, OrmManyToManyMapping, OrmManyToOneMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToOneMapping, OrmRelationshipMapping, OrmSingleRelationshipMapping, OrmSingleRelationshipMapping2_0, OrmTransientMapping, OrmVersionMapping

public interface OrmAttributeMapping
extends AttributeMapping, TypeRefactoringParticipant

orm.xml attribute 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.3

Nested Class Summary

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

AttributeMapping.AllMappingNamesTransformer, AttributeMapping.AllOverridableAssociationMappingNamesTransformer, AttributeMapping.AllOverridableAttributeMappingNamesTransformer, AttributeMapping.GeneratorsTransformer, AttributeMapping.IsNotTransient, AttributeMapping.IsOverridableAssociationMapping, AttributeMapping.KeyEquals, AttributeMapping.NameTransformer

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_ATTRIBUTE_TYPE_PROPERTY
static String	FULLY_QUALIFIED_ATTRIBUTE_TYPE_PROPERTY
static String	NAME_PROPERTY
static String	SPECIFIED_ATTRIBUTE_TYPE_PROPERTY

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

ALL_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ASSOCIATION_MAPPING_NAMES_TRANSFORMER, ALL_OVERRIDABLE_ATTRIBUTE_MAPPING_NAMES_TRANSFORMER, DEFAULT_PROPERTY, GENERATORS_TRANSFORMER, IS_NOT_TRANSIENT, IS_OVERRIDABLE_ASSOCIATION_MAPPING, NAME_TRANSFORMER

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

TRANSFORMER

Method Summary

void	addXmlAttributeMappingTo(org.eclipse.jpt.jpa.core.resource.orm.Attributes resourceAttributes)
String	getAttributeType() Return either the (possibly unqualified) type specified here or, if unspecified, the (qualified) default type.
String	getDefaultAttributeType()
String	getFullyQualifiedAttributeType()
TextRange	getNameTextRange()
OrmSpecifiedPersistentAttribute	getParent() Return the JPA node's parent.
OrmSpecifiedPersistentAttribute	getPersistentAttribute() Return the mapping's attribute (typically its parent node in the containment hierarchy).
TextRange	getSelectionTextRange()
String	getSpecifiedAttributeType()
OrmTypeMapping	getTypeMapping() Return the mapping for the type that contains the mapping's attribute.
org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping	getXmlAttributeMapping()
int	getXmlSequence() Attributes are a sequence in the orm.xml schema.
void	initializeFromOrmAttributeMapping(OrmAttributeMapping oldMapping)
void	initializeFromOrmBasicMapping(OrmBasicMapping oldMapping)
void	initializeFromOrmEmbeddedIdMapping(OrmEmbeddedIdMapping oldMapping)
void	initializeFromOrmEmbeddedMapping(OrmEmbeddedMapping oldMapping)
void	initializeFromOrmIdMapping(OrmIdMapping oldMapping)
void	initializeFromOrmManyToManyMapping(OrmManyToManyMapping oldMapping)
void	initializeFromOrmManyToOneMapping(OrmManyToOneMapping oldMapping)
void	initializeFromOrmOneToManyMapping(OrmOneToManyMapping oldMapping)
void	initializeFromOrmOneToOneMapping(OrmOneToOneMapping oldMapping)
void	initializeFromOrmTransientMapping(OrmTransientMapping oldMapping)
void	initializeFromOrmVersionMapping(OrmVersionMapping oldMapping)
void	initializeOn(OrmAttributeMapping newMapping) Called (on the old mapping) when converting one orm.xml mapping to another; so we can use double-dispatching.
void	removeXmlAttributeMappingFrom(org.eclipse.jpt.jpa.core.resource.orm.Attributes resourceAttributes)
void	setName(String name)
void	setSpecifiedAttributeType(String attributeType)

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

getAllMappingNames, getAllOverridableAssociationMappingNames, getAllOverridableAttributeMappingNames, getGenerators, getKey, getName, getPrimaryKeyColumnName, isDefault, isOverridableAssociationMapping, isOverridableAttributeMapping, isOwnedBy, isRelationshipOwner, resolveAttributeMapping, resolveOverriddenColumn, resolveOverriddenRelationship, validatesAgainstDatabase

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, 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

NAME_PROPERTY

static final String NAME_PROPERTY

See Also:

Constant Field Values

FULLY_QUALIFIED_ATTRIBUTE_TYPE_PROPERTY

static final String FULLY_QUALIFIED_ATTRIBUTE_TYPE_PROPERTY

See Also:

Constant Field Values

SPECIFIED_ATTRIBUTE_TYPE_PROPERTY

static final String SPECIFIED_ATTRIBUTE_TYPE_PROPERTY

See Also:

Constant Field Values

DEFAULT_ATTRIBUTE_TYPE_PROPERTY

static final String DEFAULT_ATTRIBUTE_TYPE_PROPERTY

See Also:

Constant Field Values

Method Detail

getParent

OrmSpecifiedPersistentAttribute getParent()

Description copied from interface: JpaModel

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JpaContextModel

Specified by:

getParent in interface JpaModel

getPersistentAttribute

OrmSpecifiedPersistentAttribute getPersistentAttribute()

Description copied from interface: AttributeMapping

Return the mapping's attribute (typically its parent node in the containment hierarchy).

Specified by:

getPersistentAttribute in interface AttributeMapping

getXmlAttributeMapping

org.eclipse.jpt.jpa.core.resource.orm.XmlAttributeMapping getXmlAttributeMapping()

getTypeMapping

OrmTypeMapping getTypeMapping()

Description copied from interface: AttributeMapping

Return the mapping for the type that contains the mapping's attribute.

Specified by:

getTypeMapping in interface AttributeMapping

setName

void setName(String name)

getAttributeType

String getAttributeType()

Return either the (possibly unqualified) type specified here or, if unspecified, the (qualified) default type.

getFullyQualifiedAttributeType

String getFullyQualifiedAttributeType()

getSpecifiedAttributeType

String getSpecifiedAttributeType()

setSpecifiedAttributeType

void setSpecifiedAttributeType(String attributeType)

getDefaultAttributeType

String getDefaultAttributeType()

getXmlSequence

int getXmlSequence()

Attributes are a sequence in the orm.xml schema. We must keep the list of attributes in the appropriate order so the WTP XML translators will write them to the XML document in that order and they will adhere to the schema.

Each implementation must implement this method and return a number that matches its order in the schema.

addXmlAttributeMappingTo

void addXmlAttributeMappingTo(org.eclipse.jpt.jpa.core.resource.orm.Attributes resourceAttributes)

removeXmlAttributeMappingFrom

void removeXmlAttributeMappingFrom(org.eclipse.jpt.jpa.core.resource.orm.Attributes resourceAttributes)

getSelectionTextRange

TextRange getSelectionTextRange()

getNameTextRange

TextRange getNameTextRange()

initializeOn

void initializeOn(OrmAttributeMapping newMapping)

Called (on the old mapping) when converting one orm.xml mapping to another; so we can use double-dispatching. The old mapping calls the appropriate initializeFrom___(Orm___Mapping) method on the new mapping, passing itself to the new mapping.

See Also:

OrmPersistentType.changeMapping(OrmSpecifiedPersistentAttribute, OrmAttributeMapping, OrmAttributeMapping), OrmSpecifiedPersistentAttribute.setMappingKey(String)

initializeFromOrmAttributeMapping

void initializeFromOrmAttributeMapping(OrmAttributeMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmBasicMapping

void initializeFromOrmBasicMapping(OrmBasicMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmIdMapping

void initializeFromOrmIdMapping(OrmIdMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmTransientMapping

void initializeFromOrmTransientMapping(OrmTransientMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmEmbeddedMapping

void initializeFromOrmEmbeddedMapping(OrmEmbeddedMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmEmbeddedIdMapping

void initializeFromOrmEmbeddedIdMapping(OrmEmbeddedIdMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmVersionMapping

void initializeFromOrmVersionMapping(OrmVersionMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmOneToManyMapping

void initializeFromOrmOneToManyMapping(OrmOneToManyMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmManyToOneMapping

void initializeFromOrmManyToOneMapping(OrmManyToOneMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmOneToOneMapping

void initializeFromOrmOneToOneMapping(OrmOneToOneMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)

initializeFromOrmManyToManyMapping

void initializeFromOrmManyToManyMapping(OrmManyToManyMapping oldMapping)

See Also:

initializeOn(OrmAttributeMapping)