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

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, JpaStructureNode, Model, ReadOnlyAccessHolder, ReadOnlyPersistentAttribute, XmlContextNode

All Known Subinterfaces:

OrmPersistentAttribute, OrmPersistentAttribute2_0, OrmReadOnlyPersistentAttribute2_0

public interface OrmReadOnlyPersistentAttribute
extends ReadOnlyPersistentAttribute, XmlContextNode

Read-only context orm.xml 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.

Field Summary

static java.lang.String

JAVA_PERSISTENT_ATTRIBUTE_PROPERTY

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

DEFAULT_MAPPING_KEY_PROPERTY, MAPPING_PROPERTY, NAME_PROPERTY

Method Summary

boolean	contains(int textOffset)
OrmPersistentAttribute	convertToSpecified() Convert the (currently virtual) attribute to a specified attribute.
OrmPersistentAttribute	convertToSpecified(java.lang.String mappingKey) Convert the (currently virtual) persistent attribute to a specified attribute.
JavaPersistentAttribute	getJavaPersistentAttribute() If the orm.xml attribute is virtual, the returned Java attribute is also virtual; i.e.
JavaResourcePersistentAttribute	getJavaResourcePersistentAttribute()
AttributeMapping	getMapping() A specified orm.xml attribute will return an orm.xml mapping, while a virtual attribute will return a Java mapping.
OrmPersistentType	getOwningPersistentType() Return the persistent type that owns (declares) the attribute.
OrmTypeMapping	getOwningTypeMapping() Return the attribute's owning persistent type's mapping (as opposed to the attribute's target type's mapping).
JavaPersistentAttribute	resolveJavaPersistentAttribute() Return the orm.xml attribute's Java attribute; which, in the case of virtual attributes, is not the same Java attribute as returned by getJavaPersistentAttribute().

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

getDefaultMappingKey, getMappingKey, getName, getPrimaryKeyColumnName, getTypeName, isVirtual

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

dispose, getId, getResourceType, getSelectionTextRange, getStructureNode

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

getAccess

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

getValidationTextRange, validate

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

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

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

getJpaProject, getParent, stateChanged

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

getAdapter

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

getResource

Field Detail

JAVA_PERSISTENT_ATTRIBUTE_PROPERTY

static final java.lang.String JAVA_PERSISTENT_ATTRIBUTE_PROPERTY

See Also:

Constant Field Values

Method Detail

getMapping

AttributeMapping getMapping()

A specified orm.xml attribute will return an orm.xml mapping, while a virtual attribute will return a Java mapping. If the attribute is virtual, the returned (Java) mapping is also virtual; i.e. it is read-only and is not to be modified (nor are any of its parts). The modifiable Java mapping can be retrieved via the modifiable Java attribute: resolveJavaPersistentAttribute().

Specified by:

getMapping in interface ReadOnlyPersistentAttribute

getOwningPersistentType

OrmPersistentType getOwningPersistentType()

Description copied from interface: ReadOnlyPersistentAttribute

Return the persistent type that owns (declares) the attribute.

Specified by:

getOwningPersistentType in interface ReadOnlyPersistentAttribute

getOwningTypeMapping

OrmTypeMapping getOwningTypeMapping()

Description copied from interface: ReadOnlyPersistentAttribute

Return the attribute's owning persistent type's mapping (as opposed to the attribute's target type's mapping).

Specified by:

getOwningTypeMapping in interface ReadOnlyPersistentAttribute

getJavaPersistentAttribute

JavaPersistentAttribute getJavaPersistentAttribute()

If the orm.xml attribute is virtual, the returned Java attribute is also virtual; i.e. it is read-only and is not to be modified (nor are any of its parts [e.g. column]). The modifiable Java attribute can be retrieved via resolveJavaPersistentAttribute().

Specified by:

getJavaPersistentAttribute in interface ReadOnlyPersistentAttribute

resolveJavaPersistentAttribute

JavaPersistentAttribute resolveJavaPersistentAttribute()

Return the orm.xml attribute's Java attribute; which, in the case of virtual attributes, is not the same Java attribute as returned by getJavaPersistentAttribute().

This is probably useful only to tests; since nothing else will want to modify the returned Java attribute.

getJavaResourcePersistentAttribute

JavaResourcePersistentAttribute getJavaResourcePersistentAttribute()

contains

boolean contains(int textOffset)

convertToSpecified

OrmPersistentAttribute convertToSpecified()

Convert the (currently virtual) attribute to a specified attribute. The attribute will be added to the list of specified attributes and added to the orm.xml file. The mapping will remain the same. Return the new attribute.

See Also:

ReadOnlyPersistentAttribute.isVirtual()

convertToSpecified

OrmPersistentAttribute convertToSpecified(java.lang.String mappingKey)

Convert the (currently virtual) persistent attribute to a specified attribute. The attribute will be added to the list of specified attributes and added to the orm.xml file. The mapping will be changed according to the specified mapping key. Return the new attribute.

See Also:

ReadOnlyPersistentAttribute.isVirtual()