com.elsevier.spark_xml_utils.xquery

Class XQueryProcessor

java.lang.Object

com.elsevier.spark_xml_utils.xquery.XQueryProcessor

All Implemented Interfaces:

Serializable

public class XQueryProcessor
extends Object
implements Serializable

Class with methods to apply an XQuery expression 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 XQuery expression specified when creating the XQueryProcessor and return a serialized response.
String	evaluate(String content) Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.
String	evaluateStream(InputStream content) Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.
String	evaluateString(String content) Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.
static XQueryProcessor	getInstance(String xQueryExpression) Get an instance of XQueryProcessor.
static XQueryProcessor	getInstance(String xQueryExpression, HashMap<String,String> namespaceMappings) Get an instance of XQueryProcessor.
static XQueryProcessor	getInstance(String xQueryExpression, HashMap<String,String> namespaceMappings, HashMap<String,Object> featureMappings) Get an instance of XQueryProcessor.
void	setExternalVariable(String name, String value) Set the external variable.
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 XQueryProcessor getInstance(String xQueryExpression)
                                   throws XQueryException

Get an instance of XQueryProcessor.

Parameters:

xQueryExpression - XQuery expression to apply to the content

Returns:

XQueryProcessor

Throws:

XQueryException

getInstance

public static XQueryProcessor getInstance(String xQueryExpression,
                                          HashMap<String,String> namespaceMappings)
                                   throws XQueryException

Get an instance of XQueryProcessor.

Parameters:

xQueryExpression - XQuery expression to apply to the content

namespaceMappings - Namespace prefix to Namespace uri mappings

Returns:

XQueryProcessor

Throws:

XQueryException

getInstance

public static XQueryProcessor getInstance(String xQueryExpression,
                                          HashMap<String,String> namespaceMappings,
                                          HashMap<String,Object> featureMappings)
                                   throws XQueryException

Get an instance of XQueryProcessor.

Parameters:

xQueryExpression - XQuery expression to apply to the content

namespaceMappings - Namespace prefix to Namespace uri mappings

featureMappings - Processor feature mappings

Returns:

XQueryProcessor

Throws:

XQueryException

setOutputMethod

public void setOutputMethod(String method)

Set the output method (the default is xml).

Parameters:

method -

setExternalVariable

public void setExternalVariable(String name,
                                String value)

Set the external variable. The value should be a String.

Parameters:

name - Name of the external variable in the XQuery

value - Value for the external variable

evaluate

public String evaluate(String content)
                throws XQueryException

Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.

Parameters:

content - String to which the XQuery Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XQueryException

evaluateString

public String evaluateString(String content)
                      throws XQueryException

Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.

Parameters:

content - String to which the XQuery Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XQueryException

evaluate

public String evaluate(InputStream content)
                throws XQueryException

Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.

Parameters:

content - InputStream to which the XQuery Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XQueryException

evaluateStream

public String evaluateStream(InputStream content)
                      throws XQueryException

Evaluate the content with the XQuery expression specified when creating the XQueryProcessor and return a serialized response.

Parameters:

content - InputStream to which the XQuery Expression will be evaluated

Returns:

Serialized response from the evaluation.

Throws:

XQueryException