org.apache.xpath
public class XPath extends Object implements Serializable, ExpressionOwner
UNKNOWN: advanced
Field Summary | |
---|---|
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 Summary | |
---|---|
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.
| |
XPath(String exprString, SourceLocator locator, PrefixResolver prefixResolver, int type)
Construct an XPath object.
| |
XPath(Expression expr)
Construct an XPath object.
|
Method Summary | |
---|---|
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, Node contextNode, PrefixResolver namespaceContext)
Given an expression and a context, evaluate the XPath
and return the result.
|
XObject | execute(XPathContext xctxt, int 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.
|
UNKNOWN: advanced
UNKNOWN: advanced
UNKNOWN: advanced
UNKNOWN: advanced
UNKNOWN: advanced
Parameters: 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 {@link #SELECT} or {@link #MATCH}. errorListener The error listener, or null if default should be used.
Throws: javax.xml.transform.TransformerException if syntax or other error.
Parameters: 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 {@link #SELECT} or {@link #MATCH}. errorListener The error listener, or null if default should be used.
Throws: javax.xml.transform.TransformerException if syntax or other error.
Parameters: 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 {@link #SELECT} or {@link #MATCH}.
Throws: javax.xml.transform.TransformerException if syntax or other error.
Parameters: expr The Expression object.
Throws: javax.xml.transform.TransformerException if syntax or other error.
Parameters: b If false, a runtime exception will be thrown. msg The assertion message, which should be informative.
Throws: RuntimeException if the b argument is false.
Parameters: xctxt The execution context. contextNode The node that "." expresses. namespaceContext The context in which namespaces in the XPath are supposed to be expanded.
Throws: TransformerException thrown if the active ProblemListener decides the error condition is severe enough to halt processing. javax.xml.transform.TransformerException
UNKNOWN: experimental
Parameters: owner The owner of the visitor, where that path may be rewritten if needed. visitor The visitor whose appropriate method will be called.
Parameters: xctxt The XPath runtime context. sourceNode Not used. msg An error msgkey that corresponds to one of the constants found in {@link org.apache.xpath.res.XPATHErrorResources}, which is a key for a format string. args An array of arguments represented in the format string, which may be null.
Throws: TransformerException if the current ErrorListoner determines to throw an exception.
Parameters: xctxt The execution context. contextNode The node that "." expresses. namespaceContext The context in which namespaces in the XPath are supposed to be expanded.
Returns: The result of the XPath or null if callbacks are used.
Throws: TransformerException thrown if the error condition is severe enough to halt processing. javax.xml.transform.TransformerException
UNKNOWN: experimental
Parameters: xctxt The execution context. contextNode The node that "." expresses. namespaceContext The context in which namespaces in the XPath are supposed to be expanded.
Throws: TransformerException thrown if the active ProblemListener decides the error condition is severe enough to halt processing. javax.xml.transform.TransformerException
UNKNOWN: experimental
Parameters: 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).
Returns: the raw Expression object, which should not normally be null.
Returns: the SourceLocator on the expression object, which may be null.
Parameters: xctxt XPath runtime context. context The current source tree context node.
Returns: score, one of {@link #MATCH_SCORE_NODETEST}, {@link #MATCH_SCORE_NONE}, {@link #MATCH_SCORE_OTHER}, or {@link #MATCH_SCORE_QNAME}.
Throws: javax.xml.transform.TransformerException
Returns: the XPath string associated with this object.
Parameters: exp the raw Expression object, which should not normally be null.
Parameters: xctxt The XPath runtime context. sourceNode Not used. msg An error msgkey that corresponds to one of the constants found in {@link org.apache.xpath.res.XPATHErrorResources}, which is a key for a format string. args An array of arguments represented in the format string, which may be null.
Throws: TransformerException if the current ErrorListoner determines to throw an exception.