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

All Superinterfaces:
AttributeMapping, BaseColumn.Owner, ColumnMapping, ConvertibleMapping, GeneratorHolder, org.eclipse.core.runtime.IAdaptable, IdMapping, IResourcePart, JpaContextNode, JpaNode, Model, NamedColumn.Owner, OrmAttributeMapping, OrmBaseColumn.Owner, OrmColumn.Owner, OrmColumnMapping, OrmGeneratorHolder, OrmNamedColumn.Owner, XmlContextNode

public interface OrmIdMapping
extends IdMapping, OrmColumnMapping, OrmAttributeMapping, OrmGeneratorHolder

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
 
Fields inherited from interface org.eclipse.jpt.core.context.IdMapping
GENERATED_VALUE_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder
SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.ConvertibleMapping
DEFAULT_CONVERTER_PROPERTY, SPECIFIED_CONVERTER_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.orm.OrmAttributeMapping
JAVA_PERSISTENT_ATTRIBUTE_PROPERTY, NAME_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.core.context.GeneratorHolder
SEQUENCE_GENERATOR_PROPERTY, TABLE_GENERATOR_PROPERTY
 
Method Summary
 OrmGeneratedValue addGeneratedValue()
           
 OrmConverter getDefaultConverter()
          Return the default converter, NO_CONVERTER except in instances where an underlying model has a converter set (an xml mapping could return a default converter if one is set in java)
 OrmGeneratedValue getGeneratedValue()
           
 OrmConverter getSpecifiedConverter()
          Return the specified converter or null, if none is specified in the underlying resource model
 
Methods inherited from interface org.eclipse.jpt.core.context.IdMapping
removeGeneratedValue
 
Methods inherited from interface org.eclipse.jpt.core.context.AttributeMapping
getKey, getPrimaryKeyColumnName, getTypeMapping, isDefault, isIdMapping, isOverridableAssociationMapping, isOverridableAttributeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.NamedColumn.Owner
getDbTable, getDefaultColumnName, getTypeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.GeneratorHolder
removeSequenceGenerator, removeTableGenerator
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.ConvertibleMapping
getConverter, setSpecifiedConverter
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmColumnMapping
getColumn
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.NamedColumn.Owner
getDbTable, getDefaultColumnName, getTypeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmColumn.Owner
addResourceColumn, getResourceColumn, removeResourceColumn
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmNamedColumn.Owner
getValidationTextRange
 
Methods inherited from interface org.eclipse.jpt.core.context.NamedColumn.Owner
getDbTable, getDefaultColumnName, getTypeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.NamedColumn.Owner
getDbTable, getDefaultColumnName, getTypeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmAttributeMapping
addToResourceModel, contains, getJavaPersistentAttribute, getName, getPersistentAttribute, getResourceAttributeMapping, getSelectionTextRange, getXmlSequence, initialize, initializeFromOrmAttributeMapping, initializeFromOrmBasicMapping, initializeFromOrmEmbeddedIdMapping, initializeFromOrmEmbeddedMapping, initializeFromOrmIdMapping, initializeFromOrmManyToManyMapping, initializeFromOrmManyToOneMapping, initializeFromOrmOneToManyMapping, initializeFromOrmOneToOneMapping, initializeFromOrmTransientMapping, initializeFromOrmVersionMapping, initializeOn, removeFromResourceModel, setName, update
 
Methods inherited from interface org.eclipse.jpt.core.context.AttributeMapping
getKey, getPrimaryKeyColumnName, getTypeMapping, isDefault, isIdMapping, isOverridableAssociationMapping, isOverridableAttributeMapping
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.XmlContextNode
getEResource, getValidationTextRange, validate
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmGeneratorHolder
addSequenceGenerator, addTableGenerator, getSequenceGenerator, getTableGenerator
 
Methods inherited from interface org.eclipse.jpt.core.context.GeneratorHolder
removeSequenceGenerator, removeTableGenerator
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit
 
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

getDefaultConverter

OrmConverter getDefaultConverter()
Description copied from interface: ConvertibleMapping
Return the default converter, NO_CONVERTER except in instances where an underlying model has a converter set (an xml mapping could return a default converter if one is set in java)

Specified by:
getDefaultConverter in interface ConvertibleMapping

getSpecifiedConverter

OrmConverter getSpecifiedConverter()
Description copied from interface: ConvertibleMapping
Return the specified converter or null, if none is specified in the underlying resource model

Specified by:
getSpecifiedConverter in interface ConvertibleMapping

getGeneratedValue

OrmGeneratedValue getGeneratedValue()
Specified by:
getGeneratedValue in interface IdMapping

addGeneratedValue

OrmGeneratedValue addGeneratedValue()
Specified by:
addGeneratedValue in interface IdMapping