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

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, JpaContextNode, JpaNode, JpaStructureNode, Model, OrmJpaContextNode

public interface OrmXml
extends OrmJpaContextNode, JpaStructureNode

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 ENTITY_MAPPINGS_PROPERTY
          String constant associated with changes to the entity-mappings property
 
Method Summary
 EntityMappings addEntityMappings()
          Add a entity-mappings node to the orm.xml file and return the object representing it.
 EntityMappings getEntityMappings()
          Return the content represented by the root of the orm.xml file.
 MappingFileRef getParent()
          Return the JPA node's parent.
 PersistenceUnitDefaults getPersistenceUnitDefaults()
           
 OrmPersistentType getPersistentType(java.lang.String fullyQualifiedTypeName)
          Return the OrmPersistentType listed in this mapping file with the given fullyQualifiedTypeName.
 void removeEntityMappings()
          Remove the entity-mappings node from the orm.xml file.
 void update(OrmResource ormResource)
           
 
Methods inherited from interface org.eclipse.jpt.core.context.orm.OrmJpaContextNode
addToMessages, getValidationTextRange
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getOrmPersistentType, getPersistenceUnit
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, 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.JpaStructureNode
dispose, getId, getSelectionTextRange, getStructureNode
 

Field Detail

ENTITY_MAPPINGS_PROPERTY

static final java.lang.String ENTITY_MAPPINGS_PROPERTY
String constant associated with changes to the entity-mappings property

See Also:
Constant Field Values
Method Detail

getParent

MappingFileRef getParent()
Description copied from interface: JpaNode
Return the JPA node's parent. The JPA project will not have a parent.

Specified by:
getParent in interface JpaNode

getEntityMappings

EntityMappings getEntityMappings()
Return the content represented by the root of the orm.xml file. This may be null.

Specified by:
getEntityMappings in interface JpaContextNode

addEntityMappings

EntityMappings addEntityMappings()
Add a entity-mappings node to the orm.xml file and return the object representing it. Throws IllegalStateException if a entity-mappings node already exists.


removeEntityMappings

void removeEntityMappings()
Remove the entity-mappings node from the orm.xml file. Throws IllegalStateException if a persistence node does not exist.


getPersistenceUnitDefaults

PersistenceUnitDefaults getPersistenceUnitDefaults()

getPersistentType

OrmPersistentType getPersistentType(java.lang.String fullyQualifiedTypeName)
Return the OrmPersistentType listed in this mapping file with the given fullyQualifiedTypeName. Return null if none exists.


update

void update(OrmResource ormResource)