org.eclipse.jpt.core.context
Interface AttributeMapping

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
BaseEmbeddedMapping, BasicMapping, EmbeddedIdMapping, EmbeddedMapping, Fetchable, IdMapping, JavaAttributeMapping, JavaBaseEmbeddedMapping, JavaBasicMapping, JavaEmbeddedIdMapping, JavaEmbeddedMapping, JavaIdMapping, JavaManyToManyMapping, JavaManyToOneMapping, JavaMultiRelationshipMapping, JavaOneToManyMapping, JavaOneToOneMapping, JavaRelationshipMapping, JavaSingleRelationshipMapping, JavaTransientMapping, JavaVersionMapping, ManyToManyMapping, ManyToOneMapping, MultiRelationshipMapping, NonOwningMapping, Nullable, OneToManyMapping, OneToOneMapping, OrmAttributeMapping, OrmBaseEmbeddedMapping, OrmBasicMapping, OrmEmbeddedIdMapping, OrmEmbeddedMapping, OrmIdMapping, OrmManyToManyMapping, OrmManyToOneMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToOneMapping, OrmRelationshipMapping, OrmSingleRelationshipMapping, OrmTransientMapping, OrmVersionMapping, RelationshipMapping, SingleRelationshipMapping, TransientMapping, VersionMapping

public interface AttributeMapping
extends JpaContextNode

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.


Method Summary
 java.lang.String getKey()
          Return a unique key for the IPersistentAttributeMapping.
 PersistentAttribute getPersistentAttribute()
           
 java.lang.String getPrimaryKeyColumnName()
          If the mapping is for a primary key column, return the column's name, otherwise return null.
 TypeMapping getTypeMapping()
          Return the mapping for the attribute mapping's attribute's type.
 boolean isDefault()
           
 boolean isIdMapping()
          Return whether the "attribute" mapping is for an ID.
 boolean isOverridableAssociationMapping()
          Return whether the "association" mapping can be overridden.
 boolean isOverridableAttributeMapping()
          Return whether the "attribute" mapping can be overridden.
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getEntityMappings, getOrmPersistentType, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent, getResource
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addCollectionChangeListener, addCollectionChangeListener, addListChangeListener, addListChangeListener, addPropertyChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, addTreeChangeListener, removeCollectionChangeListener, removeCollectionChangeListener, removeListChangeListener, removeListChangeListener, removePropertyChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 

Method Detail

getPersistentAttribute

PersistentAttribute getPersistentAttribute()

isDefault

boolean isDefault()

getKey

java.lang.String getKey()
Return a unique key for the IPersistentAttributeMapping. If this is defined in an extension they should be equal.


getPrimaryKeyColumnName

java.lang.String getPrimaryKeyColumnName()
If the mapping is for a primary key column, return the column's name, otherwise return null.


getTypeMapping

TypeMapping getTypeMapping()
Return the mapping for the attribute mapping's attribute's type.


isOverridableAttributeMapping

boolean isOverridableAttributeMapping()
Return whether the "attribute" mapping can be overridden.


isOverridableAssociationMapping

boolean isOverridableAssociationMapping()
Return whether the "association" mapping can be overridden.


isIdMapping

boolean isIdMapping()
Return whether the "attribute" mapping is for an ID.