org.apache.xpath
public abstract class Expression extends Object implements Serializable, ExpressionNode, XPathVisitable
Method Summary | |
---|---|
DTMIterator | asIterator(XPathContext xctxt, int contextNode)
Given an select expression and a context, evaluate the XPath
and return the resulting iterator.
|
DTMIterator | asIteratorRaw(XPathContext xctxt, int contextNode)
Given an select expression and a context, evaluate the XPath
and return the resulting iterator, but do not clone.
|
int | asNode(XPathContext xctxt)
Return the first node out of the nodeset, if this expression is
a nodeset expression. |
void | assertion(boolean b, String msg)
Tell the user of an assertion error, and probably throw an
exception.
|
boolean | bool(XPathContext xctxt)
Evaluate expression to a boolean.
|
boolean | canTraverseOutsideSubtree()
Tell if this expression or it's subexpressions can traverse outside
the current subtree.
|
abstract boolean | deepEquals(Expression expr)
Compare this object with another object and see
if they are equal, include the sub heararchy.
|
void | error(XPathContext xctxt, String msg, Object[] args)
Tell the user of an error, and probably throw an
exception.
|
XObject | execute(XPathContext xctxt, int currentNode)
Execute an expression in the XPath runtime context, and return the
result of the expression.
|
XObject | execute(XPathContext xctxt, int currentNode, DTM dtm, int expType)
Execute an expression in the XPath runtime context, and return the
result of the expression.
|
abstract XObject | execute(XPathContext xctxt)
Execute an expression in the XPath runtime context, and return the
result of the expression.
|
XObject | execute(XPathContext xctxt, boolean destructiveOK)
Execute an expression in the XPath runtime context, and return the
result of the expression, but tell that a "safe" object doesn't have
to be returned. |
void | executeCharsToContentHandler(XPathContext xctxt, ContentHandler handler)
Execute an expression in the XPath runtime context, and return the
result of the expression.
|
void | exprAddChild(ExpressionNode n, int i) This method tells the node to add its argument to the node's
list of children. |
ExpressionNode | exprGetChild(int i) This method returns a child node. |
int | exprGetNumChildren() Return the number of children the node has. |
ExpressionNode | exprGetParent() |
void | exprSetParent(ExpressionNode n) This pair of methods are used to inform the node of its
parent. |
abstract void | fixupVariables(Vector vars, int globalsSize)
This function is used to fixup variables from QNames to stack frame
indexes at stylesheet build time. |
int | getColumnNumber()
Return the character position where the current document event ends.
|
ExpressionNode | getExpressionOwner()
Get the first non-Expression parent of this node. |
int | getLineNumber()
Return the line number where the current document event ends.
|
String | getPublicId()
Return the public identifier for the current document event.
|
String | getSystemId()
Return the system identifier for the current document event.
|
boolean | isNodesetExpr()
Tell if the expression is a nodeset expression. |
boolean | isStableNumber()
Tell if this expression returns a stable number that will not change during
iterations within the expression. |
double | num(XPathContext xctxt)
Evaluate expression to a number.
|
void | warn(XPathContext xctxt, String msg, Object[] args)
Warn the user of an problem.
|
XMLString | xstr(XPathContext xctxt)
Cast result object to a string.
|
Parameters: xctxt The execution context. contextNode The node that "." expresses.
Returns: A valid DTMIterator.
Throws: TransformerException thrown if the active ProblemListener decides 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.
Returns: A valid DTMIterator.
Throws: TransformerException thrown if the active ProblemListener decides the error condition is severe enough to halt processing. javax.xml.transform.TransformerException
UNKNOWN: experimental
Parameters: xctxt The XPath runtime context.
Returns: the first node out of the nodeset, or DTM.NULL.
Throws: javax.xml.transform.TransformerException
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. javax.xml.transform.TransformerException
Parameters: xctxt The XPath runtime context.
Returns: false
Throws: javax.xml.transform.TransformerException
Returns: true if traversal outside the context node's subtree can occur.
Parameters: expr Another expression object.
Returns: true if this objects class and the expr object's class are the same, and the data contained within both objects are considered equal.
Parameters: xctxt The XPath runtime context. 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.
Throws: TransformerException if the current ErrorListoner determines to throw an exception. javax.xml.transform.TransformerException
Parameters: xctxt The XPath runtime context. currentNode The currentNode.
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs.
Parameters: xctxt The XPath runtime context. currentNode The currentNode. dtm The DTM of the current node. expType The expanded type ID of the current node.
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs.
Parameters: xctxt The XPath runtime context.
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs.
Parameters: xctxt The XPath runtime context. destructiveOK true if a "safe" object doesn't need to be returned.
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs.
Parameters: xctxt The XPath runtime context. NEEDSDOC @param handler
Returns: The result of the expression in the form of a XObject
.
Throws: javax.xml.transform.TransformerException if a runtime exception occurs. org.xml.sax.SAXException
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). NEEDSDOC @param globalsSize
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the column number in the document entity or external parsed entity where the markup that triggered the event appears.
Returns: The column number, or -1 if none is available.
See Also: Expression
Returns: null or first ancestor that is not an Expression.
Warning: The return value from the method is intended only as an approximation for the sake of error reporting; it is not intended to provide sufficient information to edit the character content of the original XML document.
The return value is an approximation of the line number in the document entity or external parsed entity where the markup that triggered the event appears.
Returns: The line number, or -1 if none is available.
See Also: Expression
The return value is the public identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
Returns: A string containing the public identifier, or null if none is available.
See Also: Expression
The return value is the system identifier of the document entity or of the external parsed entity in which the markup that triggered the event appears.
If the system identifier is a URL, the parser must resolve it fully before passing it to the application.
Returns: A string containing the system identifier, or null if none is available.
See Also: Expression
asNode
without an exception.Returns: true if the expression can be represented as a nodeset.
Returns: true if the expression represents a stable number.
Parameters: xctxt The XPath runtime context.
Returns: The expression evaluated as a double.
Throws: javax.xml.transform.TransformerException
Parameters: xctxt The XPath runtime context. msg An error msgkey that corresponds to one of the conststants 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.
Throws: TransformerException if the current ErrorListoner determines to throw an exception. javax.xml.transform.TransformerException
Parameters: xctxt The XPath runtime context.
Returns: The string this wraps or the empty string if null
Throws: javax.xml.transform.TransformerException