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

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model

All Known Subinterfaces:

OrmXml, PersistenceXml, PersistenceXml2_0

public interface XmlFile
extends JpaContextNode

Context representation of any JPA 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.3

Nested Class Summary

static interface	XmlFile.Root Common interface for the root element for a JPA XML file (e.g.
static class	XmlFile.XmlFile_ Common implementations.

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String

ROOT_PROPERTY String constant associated with changes to the root property.

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

RESOURCE_TYPE_TRANSFORMER

Method Summary

void	dispose() Dispose the structure node and its children.
void	gatherRootStructureNodes(JpaFile jpaFile, Collection<JpaStructureNode> rootStructureNodes) Add the appropriate root structure nodes to the collection that correspond to the given JPA file.
XmlFile.Root	getRoot() Return the XML file's root element.
JptXmlResource	getXmlResource() Return the resource model object
boolean	isGenericMappingFile() Return whether the XML file is a generic mapping file
boolean	isLatestSupportedVersion() Return whether the XML file's version is the latest supported by its JPA platform.

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getParent, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

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

Field Detail

ROOT_PROPERTY

static final String ROOT_PROPERTY

String constant associated with changes to the root property.

See Also:

Constant Field Values

Method Detail

getRoot

XmlFile.Root getRoot()

Return the XML file's root element. This may be null.

getXmlResource

JptXmlResource getXmlResource()

Return the resource model object

isLatestSupportedVersion

boolean isLatestSupportedVersion()

Return whether the XML file's version is the latest supported by its JPA platform.

isGenericMappingFile

boolean isGenericMappingFile()

Return whether the XML file is a generic mapping file

gatherRootStructureNodes

void gatherRootStructureNodes(JpaFile jpaFile,
                              Collection<JpaStructureNode> rootStructureNodes)

Add the appropriate root structure nodes to the collection that correspond to the given JPA file.

See Also:

JpaFile.getRootStructureNodes()

dispose

void dispose()

Dispose the structure node and its children. Typically this would be used to update the structure node's JPA file's root structure nodes.