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

All Superinterfaces:

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

All Known Subinterfaces:

JavaPersistentAttribute, JavaPersistentAttribute2_0, OrmPersistentAttribute, OrmPersistentAttribute2_0, OrmReadOnlyPersistentAttribute, OrmReadOnlyPersistentAttribute2_0, PersistentAttribute, PersistentAttribute2_0, ReadOnlyPersistentAttribute2_0

public interface ReadOnlyPersistentAttribute
extends JpaContextNode, JpaStructureNode, ReadOnlyAccessHolder

Read-only context 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	DEFAULT_MAPPING_KEY_PROPERTY
static java.lang.String	MAPPING_PROPERTY
static java.lang.String	NAME_PROPERTY

Method Summary

java.lang.String	getDefaultMappingKey() Return the key for the attribute's default mapping.
JavaPersistentAttribute	getJavaPersistentAttribute()
AttributeMapping	getMapping() Return the attribute's mapping.
java.lang.String	getMappingKey() Return the attribute's mapping key.
java.lang.String	getName()
PersistentType	getOwningPersistentType() Return the persistent type that owns (declares) the attribute.
TypeMapping	getOwningTypeMapping() Return the attribute's owning persistent type's mapping (as opposed to the attribute's target type's mapping).
java.lang.String	getPrimaryKeyColumnName() If the attribute is mapped to a primary key column, return the column's name, otherwise return null.
java.lang.String	getTypeName() Return the resolved, qualified name of the attribute's type (e.g.
boolean	isVirtual() Return whether the attribute has a textual representation in its underlying resource.

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

dispose, getId, getResourceType, getSelectionTextRange, getStructureNode

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

getJpaProject, getParent, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener

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

getAdapter

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

getResource

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

getAccess

Field Detail

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

MAPPING_PROPERTY

static final java.lang.String MAPPING_PROPERTY

See Also:

Constant Field Values

DEFAULT_MAPPING_KEY_PROPERTY

static final java.lang.String DEFAULT_MAPPING_KEY_PROPERTY

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

getMapping

AttributeMapping getMapping()

Return the attribute's mapping. This is never null (although, it may be a null mapping). Set the mapping via PersistentAttribute.setMappingKey(String).

getMappingKey

java.lang.String getMappingKey()

Return the attribute's mapping key.

getDefaultMappingKey

java.lang.String getDefaultMappingKey()

Return the key for the attribute's default mapping. This can be null (e.g. for specified orm.xml attributes).

See Also:

AttributeMapping.isDefault()

getOwningPersistentType

PersistentType getOwningPersistentType()

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

getOwningTypeMapping

TypeMapping getOwningTypeMapping()

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

getTypeName

java.lang.String getTypeName()

Return the resolved, qualified name of the attribute's type (e.g. "java.util.Collection" or "byte[]"). Return null if the attribute's type can not be resolved. If the type is an array, this name will include the appropriate number of bracket pairs. This name will not include the type's generic type arguments (e.g. "java.util.Collection" will only return "java.util.Collection").

getPrimaryKeyColumnName

java.lang.String getPrimaryKeyColumnName()

If the attribute is mapped to a primary key column, return the column's name, otherwise return null.

isVirtual

boolean isVirtual()

Return whether the attribute has a textual representation in its underlying resource.

getJavaPersistentAttribute

JavaPersistentAttribute getJavaPersistentAttribute()