Package gov.nist.secauto.decima.xml.document

Class JDOMDocument

java.lang.Object

gov.nist.secauto.decima.xml.document.AbstractJDOMDocument

gov.nist.secauto.decima.xml.document.JDOMDocument

All Implemented Interfaces:

Document, MutableDocument, XMLContextResolver, MutableXMLDocument, XMLDocument

Direct Known Subclasses:

CompositeXMLDocument

public class JDOMDocument
extends AbstractJDOMDocument

Constructor Summary

Constructors

Modifier	Constructor	Description
	JDOMDocument(XMLDocument toCopy)	A copy constructor.
	JDOMDocument(File location)
	JDOMDocument(File location, URL originalLocation)
	JDOMDocument(File location, URL originalLocation, org.jdom2.input.sax.SAXEngine saxEngine)	Loads a JDOM document from a File location using the provided SAXEngine.
	JDOMDocument(File location, org.jdom2.input.sax.SAXEngine saxEngine)	Loads a JDOM document from a File location using the provided SAXEngine.
	JDOMDocument(InputStream is, String systemId)
	JDOMDocument(InputStream is, String systemId, org.jdom2.input.sax.SAXEngine saxEngine)	Loads an XML document from an InputStream.
	JDOMDocument(URL location)
	JDOMDocument(URL location, org.jdom2.input.sax.SAXEngine saxEngine)
	JDOMDocument(org.jdom2.Document document, URL originalLocation)
protected	JDOMDocument(org.jdom2.Document document, URL originalLocation, XMLContextResolver resolver)	A basic constructor for a JDOMDocument that can be used by extensions to construct a new document.

Method Summary

Modifier and Type	Method	Description
org.jdom2.Document	getJDOMDocument(boolean copy)	Retrieves the underlying JDOM document.
URL	getOriginalLocation()
protected XMLContextResolver	getXMLContextResolver()

Methods inherited from class gov.nist.secauto.decima.xml.document.AbstractJDOMDocument

asString, copyTo, getContext, getContext, getJDOMDocument, getSource, getSourceInfo, getSystemId, getSystemId, getXPath, getXPath, newInputStream, newXMLDocumentFragment, newXMLDocumentFragment, newXPathEvaluator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDOMDocument

public JDOMDocument(File location)
             throws DocumentException,
                    FileNotFoundException

Throws:

DocumentException

FileNotFoundException

JDOMDocument

public JDOMDocument(File location,
                    org.jdom2.input.sax.SAXEngine saxEngine)
             throws DocumentException,
                    FileNotFoundException

Loads a JDOM document from a File location using the provided SAXEngine.

Parameters:

location - the file location to load the XML document from

saxEngine - the JDOM SAXEngine to use to parse the document

Throws:

DocumentException - if an error occured while reading the XML document

FileNotFoundException - if the file to be loaded does not exist

JDOMDocument

public JDOMDocument(File location,
                    URL originalLocation)
             throws DocumentException,
                    FileNotFoundException

Throws:

DocumentException

FileNotFoundException

JDOMDocument

public JDOMDocument(File location,
                    URL originalLocation,
                    org.jdom2.input.sax.SAXEngine saxEngine)
             throws DocumentException,
                    FileNotFoundException

Loads a JDOM document from a File location using the provided SAXEngine.

Parameters:

location - the file location to load the XML document from

originalLocation - the location the document was originally loaded from, before creating the current instance

saxEngine - the JDOM SAXEngine to use to parse the document

Throws:

DocumentException - if an error occured while reading the XML document

FileNotFoundException - if the file to be loaded does not exist

JDOMDocument

public JDOMDocument(URL location)
             throws DocumentException

Throws:

DocumentException

JDOMDocument

public JDOMDocument(URL location,
                    org.jdom2.input.sax.SAXEngine saxEngine)
             throws DocumentException

Throws:

DocumentException

JDOMDocument

public JDOMDocument(InputStream is,
                    String systemId)
             throws DocumentException,
                    MalformedURLException

Throws:

DocumentException

MalformedURLException

JDOMDocument

public JDOMDocument(InputStream is,
                    String systemId,
                    org.jdom2.input.sax.SAXEngine saxEngine)
             throws DocumentException,
                    MalformedURLException

Loads an XML document from an InputStream.

Parameters:

is - the InputStream to read from

systemId - the location of the resource being read

saxEngine - the JDOM SAXEngine to use to parse the document

Throws:

DocumentException - if an error occured while reading the XML document

MalformedURLException - if the original location URL is malformed

JDOMDocument

public JDOMDocument(org.jdom2.Document document,
                    URL originalLocation)
             throws DocumentException

Throws:

DocumentException

JDOMDocument

protected JDOMDocument(org.jdom2.Document document,
                       URL originalLocation,
                       XMLContextResolver resolver)

A basic constructor for a JDOMDocument that can be used by extensions to construct a new document.

Parameters:

document - the JDOM 2 Document objects that backs this document.

originalLocation - the original document location or null

resolver - the XMLContextResolver to use to resolve XPaths, XPathContext, and systemId.

JDOMDocument

public JDOMDocument(XMLDocument toCopy)

A copy constructor.

Parameters:

toCopy - the XMLDocument to copy

Method Detail

getOriginalLocation

public URL getOriginalLocation()

getJDOMDocument

public org.jdom2.Document getJDOMDocument(boolean copy)

Description copied from interface: MutableXMLDocument

Retrieves the underlying JDOM document. This will be a copy if the provided argument is true.

Parameters:

copy - if true the returned document must be a cloned copy

Returns:

the underlying JDOM document or a copy of it

getXMLContextResolver

protected XMLContextResolver getXMLContextResolver()

Specified by:

getXMLContextResolver in class AbstractJDOMDocument