com.ihr.xbrl.om

Class XPathOnXMLFragment

java.lang.Object

com.ihr.xbrl.om.XPathOnXMLFragment

public class XPathOnXMLFragment
extends java.lang.Object

This class provides the capacity to evaluate XPath expressions over an instance of an XMLFragment.

Author:

Ignacio

Constructor Summary

Constructors

Constructor and Description
XPathOnXMLFragment(XMLFragment xmlFragment) Instantiates a new x path on XML fragment.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear.
XPathOnXMLFragment	declareNamespace(net.sf.saxon.om.NamespaceBinding namespaceBinding) Declare namespace.
java.lang.Boolean	evaluateBoolean(java.lang.String strXPath) Evaluates an XPath 2.0 expression using this node as the evaluation conetxt.
net.sf.saxon.s9api.XdmValue	evaluateList(java.lang.String strXPath) Evaluates an XPath 2.0 expression using this node as the evaluation context.
net.sf.saxon.s9api.XdmItem	evaluateNode(java.lang.String strXPath) Evaluates an XPath 2.0 expression using this node as the evaluation conetxt.
java.lang.Double	evaluateNumber(java.lang.String strXPath) Evaluates an XPath 2.0 expression using this node as the evaluation context.
java.lang.String	evaluateString(java.lang.String strXPath) Evaluates an XPath 2.0 expression using this node as the evaluation conetxt.
net.sf.saxon.expr.StaticContext	getStaticContext() Returns a StaticContext from this XMLFragment.
net.sf.saxon.s9api.XPathExecutable	getXPathExecutable(java.lang.String strXPath) Prepares an XPathExecutable from an XPath string that uses this XMLFragment properties for evaluation.
XPathOnXMLFragment	importSchemaNamespace(java.lang.String nampespace) Import schema namespace.
void	setNamespaceContext(net.sf.saxon.om.NamespaceResolver ns) Replace the namespace context of this XMLFragment by the new one provided as a parameter
void	setVariablesDefined(XBRLVariableResolver res) Sets the object that will serve as a variable resolver for variables in the scope of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathOnXMLFragment

public XPathOnXMLFragment(XMLFragment xmlFragment)

Instantiates a new x path on XML fragment.

Parameters:

xmlFragment - the xml fragment

Method Detail

getStaticContext

public net.sf.saxon.expr.StaticContext getStaticContext()

Returns a StaticContext from this XMLFragment.

Returns:

StaticContext suitable for XPath evaluation

getXPathExecutable

public net.sf.saxon.s9api.XPathExecutable getXPathExecutable(java.lang.String strXPath)
                                                      throws net.sf.saxon.s9api.SaxonApiException

Prepares an XPathExecutable from an XPath string that uses this XMLFragment properties for evaluation. Variables in the strXPath must be inyected setting a XBRLVariableResolver before calling this method

Parameters:

strXPath - the str x path

Returns:

the x path executable

Throws:

net.sf.saxon.s9api.SaxonApiException - the saxon api exception

setVariablesDefined

public void setVariablesDefined(XBRLVariableResolver res)

Sets the object that will serve as a variable resolver for variables in the scope of this object.

Parameters:

res - XBRLVariableResolver

setNamespaceContext

public void setNamespaceContext(net.sf.saxon.om.NamespaceResolver ns)

Replace the namespace context of this XMLFragment by the new one provided as a parameter

Parameters:

ns - The new namespace context to use in XPath evaluations

evaluateList

public net.sf.saxon.s9api.XdmValue evaluateList(java.lang.String strXPath)

Evaluates an XPath 2.0 expression using this node as the evaluation context. Returns a List of nodes or strings or whatever other data type

Parameters:

strXPath - the str x path

Returns:

XdmValue which is a sequence of nodes and/or atomic values

evaluateString

public java.lang.String evaluateString(java.lang.String strXPath)

Evaluates an XPath 2.0 expression using this node as the evaluation conetxt. Returns an String

Parameters:

strXPath - the str x path

Returns:

String

evaluateNode

public net.sf.saxon.s9api.XdmItem evaluateNode(java.lang.String strXPath)

Evaluates an XPath 2.0 expression using this node as the evaluation conetxt. Returns a single Node

Parameters:

strXPath - the str x path

Returns:

NodeInfo

evaluateBoolean

public java.lang.Boolean evaluateBoolean(java.lang.String strXPath)

Evaluates an XPath 2.0 expression using this node as the evaluation conetxt. Returns a Boolean object

Parameters:

strXPath - the str x path

Returns:

Boolean

evaluateNumber

public java.lang.Double evaluateNumber(java.lang.String strXPath)

Evaluates an XPath 2.0 expression using this node as the evaluation context. Returns a Number

Parameters:

strXPath - the str x path

Returns:

Double

clear

public void clear()

Clear.

declareNamespace

public XPathOnXMLFragment declareNamespace(net.sf.saxon.om.NamespaceBinding namespaceBinding)

Declare namespace.

Parameters:

namespaceBinding - the namespace binding

Returns:

the x path on XML fragment

importSchemaNamespace

public XPathOnXMLFragment importSchemaNamespace(java.lang.String nampespace)

Import schema namespace.

Parameters:

nampespace - the nampespace

Returns:

the x path on XML fragment