gov.nasa.pds.tools.util

Class XMLExtractor

java.lang.Object

gov.nasa.pds.tools.util.XMLExtractor

public class XMLExtractor
extends Object

Class to extract data from an XML file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAMESPACE
static String	SCHEMA_LOCATION_XPATH
static String	TARGET_NAMESPACE
static String	XML_MODEL_XPATH

Constructor Summary

Constructors

Constructor and Description
XMLExtractor(net.sf.saxon.om.DocumentInfo xml) Constructor.
XMLExtractor(File file)
XMLExtractor(InputSource source)
XMLExtractor(String url) Constructor.
XMLExtractor(URL url) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultNamespace()
net.sf.saxon.om.DocumentInfo	getDocNode() Gets the document node of the XML document.
net.sf.saxon.tinytree.TinyNodeImpl	getNodeFromDoc(String expression) Gets a Node object from the given expression.
net.sf.saxon.tinytree.TinyNodeImpl	getNodeFromItem(String expression, Object item) Gets a Node object from the given expression.
List<net.sf.saxon.tinytree.TinyNodeImpl>	getNodesFromDoc(String expression) Gets Node objects from the given expression.
List<net.sf.saxon.tinytree.TinyNodeImpl>	getNodesFromItem(String expression, Object item) Gets Node objects from the given expression.
String	getSchemaLocation()
String	getTargetNamespace()
String	getValueFromDoc(String expression) Gets the value of the given expression.
String	getValueFromItem(String expression, Object item) Gets the value of the given expression.
List<String>	getValuesFromDoc(String expression) Gets the values of the given expression.
List<String>	getValuesFromItem(String expression, Object item) Gets the values of the given expression.
List<String>	getXmlModels()

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA_LOCATION_XPATH

public static final String SCHEMA_LOCATION_XPATH

See Also:

Constant Field Values

XML_MODEL_XPATH

public static final String XML_MODEL_XPATH

See Also:

Constant Field Values

DEFAULT_NAMESPACE

public static final String DEFAULT_NAMESPACE

See Also:

Constant Field Values

TARGET_NAMESPACE

public static final String TARGET_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

XMLExtractor

public XMLExtractor(net.sf.saxon.om.DocumentInfo xml)
             throws XPathExpressionException,
                    net.sf.saxon.trans.XPathException

Constructor.

Parameters:

xml - A parsed XML document.

Throws:

net.sf.saxon.trans.XPathException - If an error occurred while parsing the given xml file.

XPathExpressionException - If an error occurred while setting up the default namespace.

XMLExtractor

public XMLExtractor(URL url)
             throws net.sf.saxon.trans.XPathException,
                    XPathExpressionException

Constructor.

Parameters:

xmlFile - An xml file.

Throws:

net.sf.saxon.trans.XPathException - If an error occurred while parsing the given xml file.

XPathExpressionException - If an error occurred while setting up the default namespace.

XMLExtractor

public XMLExtractor(InputSource source)
             throws net.sf.saxon.trans.XPathException,
                    XPathExpressionException

Throws:

net.sf.saxon.trans.XPathException

XPathExpressionException

XMLExtractor

public XMLExtractor(File file)
             throws net.sf.saxon.trans.XPathException,
                    XPathExpressionException,
                    MalformedURLException

Throws:

net.sf.saxon.trans.XPathException

XPathExpressionException

MalformedURLException

XMLExtractor

public XMLExtractor(String url)
             throws net.sf.saxon.trans.XPathException,
                    XPathExpressionException,
                    MalformedURLException

Constructor.

Parameters:

xmlFile - An xml file.

Throws:

net.sf.saxon.trans.XPathException - If an error occurred while parsing the given xml file.

XPathExpressionException - If an error occurred while setting up the default namespace.

MalformedURLException

Method Detail

getValueFromDoc

public String getValueFromDoc(String expression)
                       throws XPathExpressionException,
                              net.sf.saxon.trans.XPathException

Gets the value of the given expression.

Parameters:

expression - An XPath expression.

Returns:

The resulting value or null if nothing was found.

Throws:

XPathExpressionException - If the given expression was malformed.

net.sf.saxon.trans.XPathException

getValueFromItem

public String getValueFromItem(String expression,
                      Object item)
                        throws XPathExpressionException

Gets the value of the given expression.

Parameters:

expression - An XPath expression.

item - The starting point from which to evaluate the XPath expression.

Returns:

The resulting value or null if nothing was found.

Throws:

XPathExpressionException - If the given expression was malformed.

getNodeFromDoc

public net.sf.saxon.tinytree.TinyNodeImpl getNodeFromDoc(String expression)
                                                  throws XPathExpressionException

Gets a Node object from the given expression.

Parameters:

expression - An XPath expression.

Returns:

A Node object.

Throws:

XPathExpressionException - If the given expression was malformed.

getNodeFromItem

public net.sf.saxon.tinytree.TinyNodeImpl getNodeFromItem(String expression,
                                                 Object item)
                                                   throws XPathExpressionException

Gets a Node object from the given expression.

Parameters:

expression - An XPath expression.

item - The starting point from which to evaluate the XPath expression.

Returns:

A Node object.

Throws:

XPathExpressionException - If the given expression was malformed.

getValuesFromDoc

public List<String> getValuesFromDoc(String expression)
                              throws XPathExpressionException

Gets the values of the given expression.

Parameters:

expression - An XPath expression.

Returns:

The resulting values or an empty list if nothing was found.

Throws:

XPathExpressionException - If the given expression was malformed.

getValuesFromItem

public List<String> getValuesFromItem(String expression,
                             Object item)
                               throws XPathExpressionException

Gets the values of the given expression.

Parameters:

expression - An XPath expression.

item - The starting point from which to evaluate the XPath expression.

Returns:

The resulting values or an empty list if nothing was found.

Throws:

XPathExpressionException - If the given expression was malformed.

getDocNode

public net.sf.saxon.om.DocumentInfo getDocNode()
                                        throws net.sf.saxon.trans.XPathException

Gets the document node of the XML document.

Returns:

The Document Node.

Throws:

net.sf.saxon.trans.XPathException

getNodesFromDoc

public List<net.sf.saxon.tinytree.TinyNodeImpl> getNodesFromDoc(String expression)
                                                         throws XPathExpressionException

Gets Node objects from the given expression.

Parameters:

expression - An XPath expression.

Returns:

A NodeList object.

Throws:

XPathExpressionException - If the given expression was malformed.

getNodesFromItem

public List<net.sf.saxon.tinytree.TinyNodeImpl> getNodesFromItem(String expression,
                                                        Object item)
                                                          throws XPathExpressionException

Gets Node objects from the given expression.

Parameters:

expression - An XPath expression.

item - The starting point from which to evaluate the XPath expression.

Returns:

A NodeList object.

Throws:

XPathExpressionException - If the given expression was malformed.

getSchemaLocation

public String getSchemaLocation()
                         throws XPathExpressionException,
                                net.sf.saxon.trans.XPathException

Returns:

Returns the schemalocation attribute value from the label. If it was not found, a null value will be returned.

Throws:

XPathExpressionException

net.sf.saxon.trans.XPathException

getXmlModels

public List<String> getXmlModels()
                          throws XPathExpressionException

Returns:

Returns the schematron specifications in the label.

Throws:

XPathExpressionException

getDefaultNamespace

public String getDefaultNamespace()
                           throws XPathExpressionException,
                                  net.sf.saxon.trans.XPathException

Returns:

Returns the 'xmlns' attribute of the document (default namespace)

Throws:

XPathExpressionException

net.sf.saxon.trans.XPathException

getTargetNamespace

public String getTargetNamespace()
                          throws XPathExpressionException,
                                 net.sf.saxon.trans.XPathException

Returns:

Returns the 'targetNamespace' attribute of the document (default namespace)

Throws:

XPathExpressionException

net.sf.saxon.trans.XPathException