public class XPath extends Object implements Serializable, ExpressionOwner
Modifier and Type | Field and Description |
---|---|
static int |
MATCH
Represents a match type expression.
|
static double |
MATCH_SCORE_NODETEST
The match score if the pattern consists of just a NodeTest.
|
static double |
MATCH_SCORE_NONE
The match score if no match is made.
|
static double |
MATCH_SCORE_NSWILD
The match score if the pattern pattern has the form NCName:*.
|
static double |
MATCH_SCORE_OTHER
The match score if the pattern consists of something
other than just a NodeTest or just a qname.
|
static double |
MATCH_SCORE_QNAME
The match score if the pattern has the form
of a QName optionally preceded by an @ character.
|
static int |
SELECT
Represents a select type expression.
|
Constructor and Description |
---|
XPath(Expression expr)
Construct an XPath object.
|
XPath(String exprString,
SourceLocator locator,
PrefixResolver prefixResolver,
int type)
Construct an XPath object.
|
XPath(String exprString,
SourceLocator locator,
PrefixResolver prefixResolver,
int type,
ErrorListener errorListener)
Construct an XPath object.
|
XPath(String exprString,
SourceLocator locator,
PrefixResolver prefixResolver,
int type,
ErrorListener errorListener,
FunctionTable aTable)
Construct an XPath object.
|
Modifier and Type | Method and Description |
---|---|
void |
assertion(boolean b,
String msg)
Tell the user of an assertion error, and probably throw an
exception.
|
boolean |
bool(XPathContext xctxt,
int contextNode,
PrefixResolver namespaceContext)
Given an expression and a context, evaluate the XPath
and return the result.
|
void |
callVisitors(ExpressionOwner owner,
XPathVisitor visitor)
This will traverse the heararchy, calling the visitor for
each member.
|
void |
error(XPathContext xctxt,
int sourceNode,
String msg,
Object[] args)
Tell the user of an error, and probably throw an
exception.
|
XObject |
execute(XPathContext xctxt,
int contextNode,
PrefixResolver namespaceContext)
Given an expression and a context, evaluate the XPath
and return the result.
|
XObject |
execute(XPathContext xctxt,
Node contextNode,
PrefixResolver namespaceContext)
Given an expression and a context, evaluate the XPath
and return the result.
|
void |
fixupVariables(Vector vars,
int globalsSize)
This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time.
|
Expression |
getExpression()
Get the raw Expression object that this class wraps.
|
SourceLocator |
getLocator()
Get the SourceLocator on the expression object.
|
double |
getMatchScore(XPathContext xctxt,
int context)
Get the match score of the given node.
|
String |
getPatternString()
Return the XPath string associated with this object.
|
void |
setExpression(Expression exp)
Set the raw expression object for this object.
|
void |
warn(XPathContext xctxt,
int sourceNode,
String msg,
Object[] args)
Warn the user of an problem.
|
public static final int SELECT
public static final int MATCH
public static final double MATCH_SCORE_NONE
public static final double MATCH_SCORE_QNAME
public static final double MATCH_SCORE_NSWILD
public static final double MATCH_SCORE_NODETEST
public static final double MATCH_SCORE_OTHER
public XPath(String exprString, SourceLocator locator, PrefixResolver prefixResolver, int type, ErrorListener errorListener) throws TransformerException
exprString
- The XPath expression.locator
- The location of the expression, may be null.prefixResolver
- A prefix resolver to use to resolve prefixes to
namespace URIs.type
- one of SELECT
or MATCH
.errorListener
- The error listener, or null if default should be used.TransformerException
- if syntax or other error.public XPath(String exprString, SourceLocator locator, PrefixResolver prefixResolver, int type, ErrorListener errorListener, FunctionTable aTable) throws TransformerException
exprString
- The XPath expression.locator
- The location of the expression, may be null.prefixResolver
- A prefix resolver to use to resolve prefixes to
namespace URIs.type
- one of SELECT
or MATCH
.errorListener
- The error listener, or null if default should be used.TransformerException
- if syntax or other error.public XPath(String exprString, SourceLocator locator, PrefixResolver prefixResolver, int type) throws TransformerException
exprString
- The XPath expression.locator
- The location of the expression, may be null.prefixResolver
- A prefix resolver to use to resolve prefixes to
namespace URIs.type
- one of SELECT
or MATCH
.TransformerException
- if syntax or other error.public XPath(Expression expr)
expr
- The Expression object.TransformerException
- if syntax or other error.public Expression getExpression()
getExpression
in interface ExpressionOwner
public void fixupVariables(Vector vars, int globalsSize)
vars
- List of QNames that correspond to variables. This list
should be searched backwards for the first qualified name that
corresponds to the variable reference qname. The position of the
QName in the vector from the start of the vector will be its position
in the stack frame (but variables above the globalsTop value will need
to be offset to the current stack frame).public void setExpression(Expression exp)
setExpression
in interface ExpressionOwner
exp
- the raw Expression object, which should not normally be null.public SourceLocator getLocator()
public String getPatternString()
public XObject execute(XPathContext xctxt, Node contextNode, PrefixResolver namespaceContext) throws TransformerException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.TransformerException
- thrown if
the error condition is severe enough to halt processing.TransformerException
public XObject execute(XPathContext xctxt, int contextNode, PrefixResolver namespaceContext) throws TransformerException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.TransformerException
- thrown if the active ProblemListener decides
the error condition is severe enough to halt processing.TransformerException
public boolean bool(XPathContext xctxt, int contextNode, PrefixResolver namespaceContext) throws TransformerException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.TransformerException
- thrown if the active ProblemListener decides
the error condition is severe enough to halt processing.TransformerException
public double getMatchScore(XPathContext xctxt, int context) throws TransformerException
xctxt
- XPath runtime context.context
- The current source tree context node.MATCH_SCORE_NODETEST
,
MATCH_SCORE_NONE
, MATCH_SCORE_OTHER
,
or MATCH_SCORE_QNAME
.TransformerException
public void warn(XPathContext xctxt, int sourceNode, String msg, Object[] args) throws TransformerException
xctxt
- The XPath runtime context.sourceNode
- Not used.msg
- An error msgkey that corresponds to one of the constants found
in XPATHErrorResources
, which is
a key for a format string.args
- An array of arguments represented in the format string, which
may be null.TransformerException
- if the current ErrorListoner determines to
throw an exception.public void assertion(boolean b, String msg)
b
- If false, a runtime exception will be thrown.msg
- The assertion message, which should be informative.RuntimeException
- if the b argument is false.public void error(XPathContext xctxt, int sourceNode, String msg, Object[] args) throws TransformerException
xctxt
- The XPath runtime context.sourceNode
- Not used.msg
- An error msgkey that corresponds to one of the constants found
in XPATHErrorResources
, which is
a key for a format string.args
- An array of arguments represented in the format string, which
may be null.TransformerException
- if the current ErrorListoner determines to
throw an exception.public void callVisitors(ExpressionOwner owner, XPathVisitor visitor)
owner
- The owner of the visitor, where that path may be
rewritten if needed.visitor
- The visitor whose appropriate method will be called.Copyright © 2017 JBoss by Red Hat. All rights reserved.