com.elsevier.spark_xml_utils.xpath

Class XPathProcessor

java.lang.Object

com.elsevier.spark_xml_utils.xpath.XPathProcessor

All Implemented Interfaces:

Serializable

public class XPathProcessor
extends Object
implements Serializable

Class with methods to filter an XPath expression (return a TRUE/FALSE) against a string of arbitrary xml content and evaluate an XPath expression (return a serialized response) against a string of arbitrary xml content.

Author:

Darin McBeath

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	evaluate(InputStream content) Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.
String	evaluate(String content) Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.
String	evaluateStream(InputStream content) Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.
String	evaluateString(String content) Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.
boolean	filter(InputStream content) Filter the content with the XPath expression specified when creating the XPathProcessor.
boolean	filter(String content) Filter the content with the XPath expression specified when creating the XPathProcessor.
boolean	filterStream(InputStream content) Filter the content with the XPath expression specified when creating the XPathProcessor.
boolean	filterString(String content) Filter the content with the XPath expression specified when creating the XPathProcessor.
static XPathProcessor	getInstance(String xPathExpression) Get an instance of XPathProcessor.
static XPathProcessor	getInstance(String xPathExpression, HashMap<String,String> namespaceMappings) Get an instance of XPathProcessor.
static XPathProcessor	getInstance(String xPathExpression, HashMap<String,String> namespaceMappings, HashMap<String,Object> featureMappings) Get an instance of XPathProcessor.
void	setOutputMethod(String method) Set the output method (the default is xml).

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static XPathProcessor getInstance(String xPathExpression)
                                  throws XPathException

Get an instance of XPathProcessor.

Parameters:

xPathExpression - XPath expression to apply to the content

Returns:

XPathProcessor

Throws:

XPathException

getInstance

public static XPathProcessor getInstance(String xPathExpression,
                                         HashMap<String,String> namespaceMappings)
                                  throws XPathException

Get an instance of XPathProcessor.

Parameters:

xPathExpression - XPath expression to apply to the content

namespaceMappings - Namespace prefix to Namespace uri mappings

Returns:

XPathProcessor

Throws:

XPathException

getInstance

public static XPathProcessor getInstance(String xPathExpression,
                                         HashMap<String,String> namespaceMappings,
                                         HashMap<String,Object> featureMappings)
                                  throws XPathException

Get an instance of XPathProcessor.

Parameters:

xPathExpression - XPath expression to apply to the content

namespaceMappings - Namespace prefix to Namespace uri mappings

featureMappings - Processor feature mappings

Returns:

XPathProcessor

Throws:

XPathException

setOutputMethod

public void setOutputMethod(String method)

Set the output method (the default is xml).

Parameters:

method -

filter

public boolean filter(String content)
               throws XPathException

Filter the content with the XPath expression specified when creating the XPathProcessor.

Parameters:

content - String to which the XPath expression will be applied

Returns:

TRUE if the XPath expression evaluates to true, FALSE otherwise

Throws:

XPathException

filterString

public boolean filterString(String content)
                     throws XPathException

Filter the content with the XPath expression specified when creating the XPathProcessor.

Parameters:

content - String to which the XPath expression will be applied

Returns:

TRUE if the XPath expression evaluates to true, FALSE otherwise

Throws:

XPathException

filter

public boolean filter(InputStream content)
               throws XPathException

Filter the content with the XPath expression specified when creating the XPathProcessor.

Parameters:

content - InputStream to which the XPath expression will be applied

Returns:

TRUE if the XPath expression evaluates to true, FALSE otherwise

Throws:

XPathException

filterStream

public boolean filterStream(InputStream content)
                     throws XPathException

Filter the content with the XPath expression specified when creating the XPathProcessor.

Parameters:

content - InputStream to which the XPath expression will be applied

Returns:

TRUE if the XPath expression evaluates to true, FALSE otherwise

Throws:

XPathException

evaluate

public String evaluate(String content)
                throws XPathException

Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.

Parameters:

content - String to which the XPath Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XPathException

evaluateString

public String evaluateString(String content)
                      throws XPathException

Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.

Parameters:

content - String to which the XPath Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XPathException

evaluate

public String evaluate(InputStream content)
                throws XPathException

Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.

Parameters:

content - InputStream to which the XPath Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XPathException

evaluateStream

public String evaluateStream(InputStream content)
                      throws XPathException

Evaluate the content with the XPath expression specified when creating the XPathProcessor and return a serialized response.

Parameters:

content - InputStream to which the XPath Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XPathException