gov.nasa.pds.harvest.util
Class XMLExtractor

java.lang.Object
  extended by gov.nasa.pds.harvest.util.XMLExtractor

public class XMLExtractor
extends Object

Class to extract data from an XML file.


Constructor Summary
XMLExtractor()
          Constructor.
 
Method Summary
static String getDefaultNamespace()
          Get the default namespace URI.
 net.sf.saxon.om.DocumentInfo getDocNode()
          Gets the document node of the XML document.
 net.sf.saxon.tinytree.TinyElementImpl getNodeFromDoc(String expression)
          Gets a Node object from the given expression.
 net.sf.saxon.tinytree.TinyElementImpl getNodeFromItem(String expression, Object item)
          Gets a Node object from the given expression.
 List<net.sf.saxon.tinytree.TinyElementImpl> getNodesFromDoc(String expression)
          Gets Node objects from the given expression.
 List<net.sf.saxon.tinytree.TinyElementImpl> getNodesFromItem(String expression, Object item)
          Gets Node objects from the given expression.
 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.
 void parse(File src)
          Parse the given file.
 void parse(String src)
          Parse the given file.
static void setDefaultNamespace(String uri)
          Sets the default namespace URI.
static void setNamespaceContext(PDSNamespaceContext context)
          Sets the Namespace Context to support handling of namespaces in XML documents.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLExtractor

public XMLExtractor()
Constructor.

Method Detail

parse

public void parse(File src)
           throws net.sf.saxon.trans.XPathException
Parse the given file.

Parameters:
src - An XML file.
Throws:
net.sf.saxon.trans.XPathException - If an error occurred while parsing the XML file.

parse

public void parse(String src)
           throws net.sf.saxon.trans.XPathException
Parse the given file.

Parameters:
src - An XML file.
Throws:
net.sf.saxon.trans.XPathException - If an error occurred while parsing the XML file.

setDefaultNamespace

public static void setDefaultNamespace(String uri)
Sets the default namespace URI.

Parameters:
uri - A URI.

getDefaultNamespace

public static String getDefaultNamespace()
Get the default namespace URI.

Returns:
The namespace.

setNamespaceContext

public static void setNamespaceContext(PDSNamespaceContext context)
Sets the Namespace Context to support handling of namespaces in XML documents.

Parameters:
context - The NamespaceContext object.

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.TinyElementImpl 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.TinyElementImpl 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.TinyElementImpl> 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.TinyElementImpl> 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.


Copyright © 2010-2013 Planetary Data System. All Rights Reserved.