org.eclipse.jpt.core.context.orm
Interface OrmTypeMapping

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, Model, OrmJpaContextNode, TypeMapping
All Known Subinterfaces:
OrmEmbeddable, OrmEntity, OrmMappedSuperclass

public interface OrmTypeMapping
extends TypeMapping, OrmJpaContextNode

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 CLASS_PROPERTY
           
static java.lang.String DEFAULT_ACCESS_PROPERTY
           
static java.lang.String DEFAULT_METADATA_COMPLETE_PROPERTY
           
static java.lang.String JAVA_PERSISTENT_TYPE_PROPERTY
           
static java.lang.String SPECIFIED_ACCESS_PROPERTY
           
static java.lang.String SPECIFIED_METADATA_COMPLETE_PROPERTY
           
 
Method Summary
 AbstractXmlTypeMapping addToResourceModel(XmlEntityMappings entityMappings)
           
 boolean containsOffset(int textOffset)
           
 AccessType getAccess()
           
 TextRange getAttributesTextRange()
           
 java.lang.String getClass_()
           
 AccessType getDefaultAccess()
           
 JavaPersistentType getJavaPersistentType()
           
 OrmPersistentType getPersistentType()
           
 TextRange getSelectionTextRange()
           
 AccessType getSpecifiedAccess()
           
 java.lang.Boolean getSpecifiedMetadataComplete()
           
 AbstractXmlTypeMapping getTypeMappingResource()
           
 int getXmlSequence()
          type mappings are a sequence in the orm schema.
 void initializeFrom(OrmTypeMapping oldMapping)
           
 boolean isDefaultMetadataComplete()
           
 boolean isMetadataComplete()
           
 java.util.Iterator<OrmPersistentAttribute> overridableAssociations()
          Return an Iterator of associations that can be overriden.
 java.util.Iterator<OrmPersistentAttribute> overridableAttributes()
          Return an Iterator of attributes.
 void removeFromResourceModel(XmlEntityMappings entityMappings)
           
 void setClass(java.lang.String newClass)
           
 void setSpecifiedAccess(AccessType newSpecifiedAccess)
           
 void setSpecifiedMetadataComplete(java.lang.Boolean newSpecifiedMetadataComplete)
           
 
Methods inherited from interface org.eclipse.jpt.core.context.TypeMapping
allOverridableAssociationNames, allOverridableAssociations, allOverridableAttributeNames, allOverridableAttributes, associatedTableNamesIncludingInherited, associatedTables, associatedTablesIncludingInherited, attributeMappingKeyAllowed, getDbSchema, getDbTable, getKey, getPrimaryDbTable, getTableName, isMapped, overridableAssociationNames, overridableAttributeNames, tableNameIsInvalid
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmJpaContextNode
addToMessages, getValidationTextRange
 
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
 

Field Detail

JAVA_PERSISTENT_TYPE_PROPERTY

static final java.lang.String JAVA_PERSISTENT_TYPE_PROPERTY
See Also:
Constant Field Values

CLASS_PROPERTY

static final java.lang.String CLASS_PROPERTY
See Also:
Constant Field Values

DEFAULT_ACCESS_PROPERTY

static final java.lang.String DEFAULT_ACCESS_PROPERTY
See Also:
Constant Field Values

SPECIFIED_ACCESS_PROPERTY

static final java.lang.String SPECIFIED_ACCESS_PROPERTY
See Also:
Constant Field Values

SPECIFIED_METADATA_COMPLETE_PROPERTY

static final java.lang.String SPECIFIED_METADATA_COMPLETE_PROPERTY
See Also:
Constant Field Values

DEFAULT_METADATA_COMPLETE_PROPERTY

static final java.lang.String DEFAULT_METADATA_COMPLETE_PROPERTY
See Also:
Constant Field Values
Method Detail

getClass_

java.lang.String getClass_()

setClass

void setClass(java.lang.String newClass)

getAccess

AccessType getAccess()

getDefaultAccess

AccessType getDefaultAccess()

getSpecifiedAccess

AccessType getSpecifiedAccess()

setSpecifiedAccess

void setSpecifiedAccess(AccessType newSpecifiedAccess)

isMetadataComplete

boolean isMetadataComplete()

getSpecifiedMetadataComplete

java.lang.Boolean getSpecifiedMetadataComplete()

setSpecifiedMetadataComplete

void setSpecifiedMetadataComplete(java.lang.Boolean newSpecifiedMetadataComplete)

isDefaultMetadataComplete

boolean isDefaultMetadataComplete()

getXmlSequence

int getXmlSequence()
type mappings are a sequence in the orm schema. We must keep the list of type mappings in the appropriate order so the wtp xml translators will write them to the xml in that order and they will adhere to the schema. Each concrete subclass of XmlTypeMapping must implement this method and return an int that matches it's order in the schema

Returns:

removeFromResourceModel

void removeFromResourceModel(XmlEntityMappings entityMappings)

addToResourceModel

AbstractXmlTypeMapping addToResourceModel(XmlEntityMappings entityMappings)

initializeFrom

void initializeFrom(OrmTypeMapping oldMapping)

getTypeMappingResource

AbstractXmlTypeMapping getTypeMappingResource()

getJavaPersistentType

JavaPersistentType getJavaPersistentType()

getSelectionTextRange

TextRange getSelectionTextRange()

getAttributesTextRange

TextRange getAttributesTextRange()

containsOffset

boolean containsOffset(int textOffset)

getPersistentType

OrmPersistentType getPersistentType()
Specified by:
getPersistentType in interface TypeMapping

overridableAttributes

java.util.Iterator<OrmPersistentAttribute> overridableAttributes()
Description copied from interface: TypeMapping
Return an Iterator of attributes. The attributes must be BasicMappings or IdMappings found in this type mapping

Specified by:
overridableAttributes in interface TypeMapping

overridableAssociations

java.util.Iterator<OrmPersistentAttribute> overridableAssociations()
Description copied from interface: TypeMapping
Return an Iterator of associations that can be overriden. The associations must be OneToOneMappings or ManyToOneMappings found in this type mapping

Specified by:
overridableAssociations in interface TypeMapping