org.eclipse.jpt.jpa.core.context
Interface MappingFileRoot

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, JpaStructureNode, Model, PersistentTypeContainer, XmlContextNode
All Known Subinterfaces:
EclipseLinkEntityMappings, EntityMappings

public interface MappingFileRoot
extends XmlContextNode, JpaStructureNode, PersistentTypeContainer

The root of a JPA mapping 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.1
Version:
2.1

Field Summary
 
Fields inherited from interface org.eclipse.jpt.jpa.core.context.persistence.PersistentTypeContainer
TRANSFORMER
 
Method Summary
 AccessType getAccess()
          Return the specified access if present, otherwise return the default access.
 java.lang.String getCatalog()
          Return the specified catalog if present, otherwise return the default catalog.
 MappingFile getParent()
          covariant override
 MappingFilePersistenceUnitMetadata getPersistenceUnitMetadata()
          Return the metadata defined within the mapping file for the persistence unit.
 java.lang.String getSchema()
          Return the specified schema if present, otherwise return the default schema.
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.XmlContextNode
getValidationTextRange, validate
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update
 
Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode
getJpaProject, stateChanged
 
Methods inherited from interface org.eclipse.jpt.common.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.jpt.common.core.IResourcePart
getResource
 
Methods inherited from interface org.eclipse.jpt.jpa.core.JpaStructureNode
dispose, getId, getResourceType, getSelectionTextRange, getStructureNode
 
Methods inherited from interface org.eclipse.jpt.jpa.core.context.persistence.PersistentTypeContainer
getPersistentType, getPersistentTypes
 

Method Detail

getParent

MappingFile getParent()
covariant override

Specified by:
getParent in interface JpaNode

getAccess

AccessType getAccess()
Return the specified access if present, otherwise return the default access.


getCatalog

java.lang.String getCatalog()
Return the specified catalog if present, otherwise return the default catalog.


getSchema

java.lang.String getSchema()
Return the specified schema if present, otherwise return the default schema.


getPersistenceUnitMetadata

MappingFilePersistenceUnitMetadata getPersistenceUnitMetadata()
Return the metadata defined within the mapping file for the persistence unit. Return null if none exists.

See Also:
MappingFilePersistenceUnitMetadata.resourceExists()