|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xpath.XPath
The XPath class represents the semantic parse tree of the XPath pattern. It is the representation of the grammar which filters out the choice for replacement order of the production rules. In order to conserve memory and reduce object creation, the tree is represented as an array of integers: [op code][length][...] where strings are represented within the array as indexes into the token tree.
Field Summary | |
static int |
MATCH
|
static double |
MATCH_SCORE_NODETEST
**For advanced use only** The match score if the pattern consists of just a NodeTest. |
static double |
MATCH_SCORE_NONE
**For advanced use only** The match score if no match is made. |
static double |
MATCH_SCORE_NSWILD
**For advanced use only** The match score if the pattern pattern has the form NCName:*. |
static double |
MATCH_SCORE_OTHER
**For advanced use only** The match score if the pattern consists of something other than just a NodeTest or just a qname. |
static double |
MATCH_SCORE_QNAME
**For advanced use only** The match score if the pattern has the form of a QName optionally preceded by an @ character. |
static int |
SELECT
|
Constructor Summary | |
XPath(java.lang.String exprString,
Locator locator,
PrefixResolver prefixResolver,
int type)
Construct an XPath object. |
Method Summary | |
void |
assert(boolean b,
java.lang.String msg)
Tell the user of an assertion error, and probably throw an exception. |
void |
error(XPathContext xctxt,
Node sourceNode,
int msg,
java.lang.Object[] args)
Tell the user of an error, and probably throw an exception. |
XObject |
execute(XPathContext xctxt,
Node contextNode,
PrefixResolver namespaceContext)
**Experimental** Given an expression and a context, evaluate the XPath and call the callback as nodes are found. |
Expression |
getExpression()
|
Locator |
getLocator()
|
double |
getMatchScore(XPathContext xctxt,
Node context)
Get the match score of the given node. |
java.lang.String |
getPatternString()
|
java.util.Vector |
getTargetElementStrings()
**For advanced use only** This method is for building indexes of match patterns for fast lookup. |
void |
installFunction(java.lang.String name,
int funcIndex,
Function func)
Install a built-in function. |
void |
setExpression(Expression exp)
|
void |
setLocator(Locator l)
|
void |
warn(XPathContext xctxt,
Node sourceNode,
int msg,
java.lang.Object[] args)
Warn the user of an problem. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
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
Constructor Detail |
public XPath(java.lang.String exprString, Locator locator, PrefixResolver prefixResolver, int type) throws SAXException
Method Detail |
public Expression getExpression()
public void setExpression(Expression exp)
public Locator getLocator()
public void setLocator(Locator l)
public java.lang.String getPatternString()
public XObject execute(XPathContext xctxt, Node contextNode, PrefixResolver namespaceContext) throws SAXException
xctxt
- The execution context.contextNode
- The node that "." expresses.namespaceContext
- The context in which namespaces in the
XPath are supposed to be expanded.callback
- Interface that implements the processLocatedNode method.callbackInfo
- Object that will be passed to the processLocatedNode method.stopAtFirst
- True if the search should stop once the first node in document
order is found.public double getMatchScore(XPathContext xctxt, Node context) throws SAXException
context
- The current source tree context node.public void installFunction(java.lang.String name, int funcIndex, Function func)
name
- The unqualified name of the function.funcIndex
- The index of the function in the table.func
- A Implementation of an XPath Function object.public java.util.Vector getTargetElementStrings()
public void warn(XPathContext xctxt, Node sourceNode, int msg, java.lang.Object[] args) throws SAXException
public void assert(boolean b, java.lang.String msg) throws SAXException
public void error(XPathContext xctxt, Node sourceNode, int msg, java.lang.Object[] args) throws SAXException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |