Dali Provisional API
Release 3.2

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

All Superinterfaces:
DeleteTypeRefactoringParticipant, IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, ManagedTypeContainer, MappingFile, Model, PersistentTypeContainer, TypeRefactoringParticipant, XmlFile

public interface OrmXml
extends MappingFile, XmlFile

JPA orm.xml file.

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.

Since:
2.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.MappingFile
MappingFile.Root
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.PersistentTypeContainer
PersistentTypeContainer.PersistentTypesTransformer
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.ManagedTypeContainer
ManagedTypeContainer.ContainsType, ManagedTypeContainer.ManagedTypesTransformer
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.DeleteTypeRefactoringParticipant
DeleteTypeRefactoringParticipant.DeleteTypeEditsTransformer
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.TypeRefactoringParticipant
TypeRefactoringParticipant.MoveTypeEditsTransformer, TypeRefactoringParticipant.RenamePackageEditsTransformer, TypeRefactoringParticipant.RenameTypeEditsTransformer
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.context.XmlFile
XmlFile.Root, XmlFile.XmlFile_
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel
JpaModel.JpaVersionIsCompatibleWith
 
Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer
 
Field Summary
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.MappingFile
ROOT_PROPERTY
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.PersistentTypeContainer
TRANSFORMER
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.XmlFile
ROOT_PROPERTY
 
Method Summary
 OrmXmlDefinition getDefinition()
          Return the mapping file's definition.
 OrmPersistentType getPersistentType(String name)
          Return the persistent type with the specified name.
 EntityMappings getRoot()
          Return the mapping file's root.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.MappingFile
addRootStructureNodesTo, dispose, getMappingFileGenerators, getMappingFileQueries, getParent, getResourceMappingFile, isIn
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.PersistentTypeContainer
getPersistentTypes
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.ManagedTypeContainer
getManagedType, getManagedTypes
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.DeleteTypeRefactoringParticipant
createDeleteTypeEdits
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.TypeRefactoringParticipant
createMoveTypeEdits, createRenamePackageEdits, createRenameTypeEdits
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.XmlFile
addRootStructureNodesTo, dispose, getXmlResource, isGenericMappingFile, isLatestSupportedVersion
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextModel
getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate
 
Methods inherited from interface org.eclipse.jpt.jpa.core.JpaModel
getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged
 
Methods inherited from interface org.eclipse.jpt.common.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference
getResourceType
 

Method Detail

getRoot

EntityMappings getRoot()
Description copied from interface: MappingFile
Return the mapping file's root. This can be null.

Specified by:
getRoot in interface MappingFile
Specified by:
getRoot in interface XmlFile

getDefinition

OrmXmlDefinition getDefinition()
Description copied from interface: MappingFile
Return the mapping file's definition.

Specified by:
getDefinition in interface MappingFile

getPersistentType

OrmPersistentType getPersistentType(String name)
Description copied from interface: PersistentTypeContainer
Return the persistent type with the specified name. Return null if the persistent type is not found. If the persistent unit has more than one persistent type with the specified name, return the first one found, using the following search order:

Specified by:
getPersistentType in interface PersistentTypeContainer

Dali Provisional API
Release 3.2

Copyright (c) 2012 Oracle. All rights reserved.