org.eclipse.jpt.core.context
Interface AttributeMapping

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model
All Known Subinterfaces:
BaseEmbeddedMapping, BasicCollectionMapping, BasicMapMapping, BasicMapping, EclipseLinkBasicMapping, EclipseLinkIdMapping, EclipseLinkOneToManyMapping, EclipseLinkOneToOneMapping, EclipseLinkRelationshipMapping, EclipseLinkVersionMapping, EmbeddedIdMapping, EmbeddedMapping, Fetchable, IdMapping, JavaAttributeMapping, JavaBaseEmbeddedMapping, JavaBasicMapping, JavaEmbeddedIdMapping, JavaEmbeddedMapping, JavaIdMapping, JavaManyToManyMapping, JavaManyToOneMapping, JavaMultiRelationshipMapping, JavaOneToManyMapping, JavaOneToOneMapping, JavaRelationshipMapping, JavaSingleRelationshipMapping, JavaTransientMapping, JavaVersionMapping, ManyToManyMapping, ManyToOneMapping, MultiRelationshipMapping, Nullable, OneToManyMapping, OneToOneMapping, OrmAttributeMapping, OrmBaseEmbeddedMapping, OrmBasicMapping, OrmEmbeddedIdMapping, OrmEmbeddedMapping, OrmIdMapping, OrmManyToManyMapping, OrmManyToOneMapping, OrmMultiRelationshipMapping, OrmOneToManyMapping, OrmOneToOneMapping, OrmRelationshipMapping, OrmSingleRelationshipMapping, OrmTransientMapping, OrmVersionMapping, RelationshipMapping, SingleRelationshipMapping, TransformationMapping, TransientMapping, VariableOneToOneMapping, 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.
 java.lang.String getName()
           
 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.
 boolean isOwnedBy(RelationshipMapping mapping)
          Return whether the given mapping manages a relationship with this mapping
 boolean shouldValidateAgainstDatabase()
          Return whether any database metadata specific validation should occur.
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
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
 
Methods inherited from interface org.eclipse.jpt.core.IResourcePart
getResource
 

Method Detail

getPersistentAttribute

PersistentAttribute getPersistentAttribute()

getName

java.lang.String getName()

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.


isOverridableAttributeMapping

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


isOverridableAssociationMapping

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


getTypeMapping

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


isIdMapping

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


getPrimaryKeyColumnName

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


isOwnedBy

boolean isOwnedBy(RelationshipMapping mapping)
Return whether the given mapping manages a relationship with this mapping


shouldValidateAgainstDatabase

boolean shouldValidateAgainstDatabase()
Return whether any database metadata specific validation should occur. (For instance, if the connection is not active, then it should not.)