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

All Superinterfaces:

AccessReference, IAdaptable, JpaContextModel, JpaModel, JpaStructureNode, JptResourceTypeReference, Model, OrmPersistentAttribute, PersistentAttribute, SpecifiedAccessReference, SpecifiedPersistentAttribute, TypeRefactoringParticipant

public interface OrmSpecifiedPersistentAttribute
extends SpecifiedPersistentAttribute, OrmPersistentAttribute, TypeRefactoringParticipant

orm.xml specified persistent attribute (field or property).

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.orm.OrmPersistentAttribute

OrmPersistentAttribute.MappingTransformer

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

PersistentAttribute.NameEquals, PersistentAttribute.NameTransformer

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

JpaStructureNode.ContextType

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

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

DEFAULT_ACCESS_PROPERTY, SPECIFIED_ACCESS_PROPERTY

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

JAVA_PERSISTENT_ATTRIBUTE_PROPERTY, MAPPING_TRANSFORMER

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

DEFAULT_MAPPING_KEY_PROPERTY, MAPPING_PROPERTY, NAME_PROPERTY, NAME_TRANSFORMER

Fields inherited from interface org.eclipse.jpt.jpa.core.JpaStructureNode

STRUCTURE_CHILDREN_COLLECTION

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

TRANSFORMER

Method Summary

OrmAttributeMapping	getMapping() Return an orm.xml mapping since the attribute is specified.
void	nameChanged(String oldName, String newName) Called by the attribute's mapping when it's name changes, effectively changing the attribute's name.
OrmPersistentAttribute	removeFromXml() Remove the attribute from the orm.xml file and the list of specified attributes.
OrmAttributeMapping	setMappingKey(String key) Set the attribute's mapping.

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

getDefaultAccess, getSpecifiedAccess, setSpecifiedAccess

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

addToXml, addToXml, dispose, getDeclaringPersistentType, getDeclaringTypeMapping, getJavaPersistentAttribute, getJavaResourceAttribute, getStructureType, isFor, isFor, resolveJavaPersistentAttribute

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

getDefaultMappingKey, getMappingKey, getName, getPrimaryKeyColumnName, getTypeName, getTypeName, isVirtual

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

addRootStructureNodesTo, containsOffset, getContextType, getFullTextRange, getSelectionTextRange, getStructureChildren, getStructureChildrenSize, getStructureNode

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

getAccess

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

Method Detail

getMapping

OrmAttributeMapping getMapping()

Return an orm.xml mapping since the attribute is specified.

Specified by:

getMapping in interface OrmPersistentAttribute

Specified by:

getMapping in interface PersistentAttribute

removeFromXml

OrmPersistentAttribute removeFromXml()

Remove the attribute from the orm.xml file and the list of specified attributes. The attribute must currently be specified (return false from isVirtual()). Return the new virtual attribute, if it exists. Return null if the attribute does not correspond to an attribute in the Java persistent type.

See Also:

PersistentAttribute.isVirtual(), setMappingKey(String)

setMappingKey

OrmAttributeMapping setMappingKey(String key)

Description copied from interface: SpecifiedPersistentAttribute

Set the attribute's mapping. If the specified key is null, clear the specified mapping, allowing the attribute's mapping to default (if appropriate). Return the new mapping (which may be a null mapping).

Specified by:

setMappingKey in interface SpecifiedPersistentAttribute

nameChanged

void nameChanged(String oldName,
                 String newName)

Called by the attribute's mapping when it's name changes, effectively changing the attribute's name.