org.etourdot.xincproc.xpointer

Class XPointerEngine

java.lang.Object

org.etourdot.xincproc.xpointer.XPointerEngine

public class XPointerEngine
extends Object

The XPointer engine.

Constructor Summary

Constructors

Constructor and Description
XPointerEngine() Instantiates a new XPointerEngine.
XPointerEngine(net.sf.saxon.s9api.Processor processor) Instantiates a new XPointerEngine

Method Summary

Modifier and Type	Method and Description
String	execute(String pointerStr, Source source) Execute xpointer expression on a xml source returning a xml string
int	executeToDestination(String pointerStr, Source source, net.sf.saxon.s9api.Destination destination) Execute a xpointer expression on a xml source.
XPointerErrorHandler	getXPointerErrorHandler() Getting the error handler
static XPointerErrorHandler	newDefaultXPointerErrorHandler() Return a default error handler
static XPointerErrorHandler	newNilXPointerErrorHandler() Return an error handler which forget error messages
XPointerEngine	setBaseURI(String baseURI) Setting the base uri for the pointer resolution The base uri is used for xml:base calculations
XPointerEngine	setLanguage(String language) Setting the language for the pointer resolution The language is used for xml:lang calculation
XPointerEngine	setXPointerErrorHandler(XPointerErrorHandler xPointerErrorHandler) Setting an error handler to capture parsing errors or warnings
String	verifyXPathExpression(Iterable<XmlNsScheme> xmlNsSchemes, String xpathExpression) Utility method for verifying xpath expression

Methods inherited from class java.lang.Object

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

Constructor Detail

XPointerEngine

public XPointerEngine()

Instantiates a new XPointerEngine.

XPointerEngine

public XPointerEngine(net.sf.saxon.s9api.Processor processor)

Instantiates a new XPointerEngine

Parameters:

processor - the saxon processor to use

Method Detail

newNilXPointerErrorHandler

public static XPointerErrorHandler newNilXPointerErrorHandler()

Return an error handler which forget error messages

Returns:

an XPointerErrorHandler

newDefaultXPointerErrorHandler

public static XPointerErrorHandler newDefaultXPointerErrorHandler()

Return a default error handler

Returns:

an XPointerErrorHandler

setBaseURI

public XPointerEngine setBaseURI(String baseURI)

Setting the base uri for the pointer resolution The base uri is used for xml:base calculations

Parameters:

baseURI - of the parent xml

Returns:

the XPointerEngine for fluent api usage

setLanguage

public XPointerEngine setLanguage(String language)

Setting the language for the pointer resolution The language is used for xml:lang calculation

Parameters:

language - of the parent xml

Returns:

the XPointerEngine for fluent api usage

getXPointerErrorHandler

public XPointerErrorHandler getXPointerErrorHandler()

Getting the error handler

Returns:

the current error handler or null if absent

setXPointerErrorHandler

public XPointerEngine setXPointerErrorHandler(XPointerErrorHandler xPointerErrorHandler)

Setting an error handler to capture parsing errors or warnings

Parameters:

xPointerErrorHandler - a XPointerErrorHandler

Returns:

the XPointerEngine for fluent api usage

execute

public String execute(String pointerStr,
                      Source source)

Execute xpointer expression on a xml source returning a xml string

Parameters:

pointerStr - xpointer expression

source - xml source

Returns:

serialized xml result or an empty string (not null)

executeToDestination

public int executeToDestination(String pointerStr,
                                Source source,
                                net.sf.saxon.s9api.Destination destination)
                         throws XPointerException

Execute a xpointer expression on a xml source. The result is send to a Saxon Destination

Parameters:

pointerStr - xpointer expression

source - xml source

destination - Saxon destination of result stream

Returns:

number of elements in result infoset excluding comments et processing instructions

Throws:

XPointerException - the x pointer exception

verifyXPathExpression

public String verifyXPathExpression(Iterable<XmlNsScheme> xmlNsSchemes,
                                    String xpathExpression)

Utility method for verifying xpath expression

Parameters:

xmlNsSchemes - namespaces list

xpathExpression - xpath expression to test

Returns:

empty string if expression is right, error otherwise