| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
|
| <!--NewPage-->
|
| <HTML>
|
| <HEAD>
|
| <!-- Generated by javadoc on Thu Nov 22 17:12:58 EST 2007 -->
|
| <TITLE>
|
| Xalan-Java 2.7.1: Class Expression
|
| </TITLE>
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
| </HEAD>
|
| <BODY BGCOLOR="white">
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Expression.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../org/apache/xpath/CachedXPathAPI.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/apache/xpath/NodeSet.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="Expression.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| <!-- ======== START OF CLASS DATA ======== -->
|
| <H2>
|
| <FONT SIZE="-1">
|
| org.apache.xpath</FONT>
|
| <BR>
|
| Class Expression</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<B>org.apache.xpath.Expression</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/xpath/functions/Function.html">Function</A>, <A HREF="../../../org/apache/xpath/patterns/NodeTest.html">NodeTest</A>, <A HREF="../../../org/apache/xpath/operations/Operation.html">Operation</A>, <A HREF="../../../org/apache/xpath/operations/UnaryOperation.html">UnaryOperation</A>, <A HREF="../../../org/apache/xpath/patterns/UnionPattern.html">UnionPattern</A>, <A HREF="../../../org/apache/xpath/operations/Variable.html">Variable</A>, <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public abstract class <B>Expression</B><DT>extends java.lang.Object<DT>implements java.io.Serializable, <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A>, <A HREF="../../../org/apache/xpath/XPathVisitable.html">XPathVisitable</A></DL>
|
|
|
| <P>
|
| This abstract class serves as the base for all expression objects. An |
| Expression can be executed to return a <A HREF="../../../org/apache/xpath/objects/XObject.html"><CODE>XObject</CODE></A>, |
| normally has a location within a document or DOM, can send error and warning |
| events, and normally do not hold state and are meant to be immutable once |
| construction has completed. An exception to the immutibility rule is iterators |
| and walkers, which must be cloned in order to be used -- the original must |
| still be immutable.
|
| <P>
|
| <DL>
|
| <DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.apache.xpath.Expression">Serialized Form</A></DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== INNER CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
|
| <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Constructor Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#Expression()">Expression</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ========== METHOD SUMMARY =========== -->
|
|
|
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=2><FONT SIZE="+2">
|
| <B>Method Summary</B></FONT></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#asIterator(org.apache.xpath.XPathContext, int)">asIterator</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode)</CODE>
|
|
|
| <BR>
|
| Given an select expression and a context, evaluate the XPath |
| and return the resulting iterator.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#asIteratorRaw(org.apache.xpath.XPathContext, int)">asIteratorRaw</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode)</CODE>
|
|
|
| <BR>
|
| Given an select expression and a context, evaluate the XPath |
| and return the resulting iterator, but do not clone.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#asNode(org.apache.xpath.XPathContext)">asNode</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Return the first node out of the nodeset, if this expression is |
| a nodeset expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#assertion(boolean, java.lang.String)">assertion</A></B>(boolean b, |
| java.lang.String msg)</CODE>
|
|
|
| <BR>
|
| Tell the user of an assertion error, and probably throw an |
| exception.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#bool(org.apache.xpath.XPathContext)">bool</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Evaluate expression to a boolean.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#canTraverseOutsideSubtree()">canTraverseOutsideSubtree</A></B>()</CODE>
|
|
|
| <BR>
|
| Tell if this expression or it's subexpressions can traverse outside |
| the current subtree.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#deepEquals(org.apache.xpath.Expression)">deepEquals</A></B>(<A HREF="../../../org/apache/xpath/Expression.html">Expression</A> expr)</CODE>
|
|
|
| <BR>
|
| Compare this object with another object and see |
| if they are equal, include the sub heararchy.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#error(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">error</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| java.lang.String msg, |
| java.lang.Object[] args)</CODE>
|
|
|
| <BR>
|
| Tell the user of an error, and probably throw an |
| exception.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext)">execute</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Execute an expression in the XPath runtime context, and return the |
| result of the expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, boolean)">execute</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| boolean destructiveOK)</CODE>
|
|
|
| <BR>
|
| 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.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, int)">execute</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int currentNode)</CODE>
|
|
|
| <BR>
|
| Execute an expression in the XPath runtime context, and return the |
| result of the expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)">execute</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int currentNode, |
| <A HREF="../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm, |
| int expType)</CODE>
|
|
|
| <BR>
|
| Execute an expression in the XPath runtime context, and return the |
| result of the expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)">executeCharsToContentHandler</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| <A HREF="../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler)</CODE>
|
|
|
| <BR>
|
| Execute an expression in the XPath runtime context, and return the |
| result of the expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#exprAddChild(org.apache.xpath.ExpressionNode, int)">exprAddChild</A></B>(<A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> n, |
| int i)</CODE>
|
|
|
| <BR>
|
| This method tells the node to add its argument to the node's |
| list of children.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#exprGetChild(int)">exprGetChild</A></B>(int i)</CODE>
|
|
|
| <BR>
|
| This method returns a child node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#exprGetNumChildren()">exprGetNumChildren</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the number of children the node has.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#exprGetParent()">exprGetParent</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#exprSetParent(org.apache.xpath.ExpressionNode)">exprSetParent</A></B>(<A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> n)</CODE>
|
|
|
| <BR>
|
| This pair of methods are used to inform the node of its |
| parent.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>abstract void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#fixupVariables(java.util.Vector, int)">fixupVariables</A></B>(java.util.Vector vars, |
| int globalsSize)</CODE>
|
|
|
| <BR>
|
| This function is used to fixup variables from QNames to stack frame |
| indexes at stylesheet build time.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#getColumnNumber()">getColumnNumber</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the character position where the current document event ends.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#getExpressionOwner()">getExpressionOwner</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the first non-Expression parent of this node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#getLineNumber()">getLineNumber</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the line number where the current document event ends.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#getPublicId()">getPublicId</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the public identifier for the current document event.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.String</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#getSystemId()">getSystemId</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the system identifier for the current document event.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#isNodesetExpr()">isNodesetExpr</A></B>()</CODE>
|
|
|
| <BR>
|
| Tell if the expression is a nodeset expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#isStableNumber()">isStableNumber</A></B>()</CODE>
|
|
|
| <BR>
|
| Tell if this expression returns a stable number that will not change during |
| iterations within the expression.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> double</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#num(org.apache.xpath.XPathContext)">num</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Evaluate expression to a number.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#warn(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])">warn</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| java.lang.String msg, |
| java.lang.Object[] args)</CODE>
|
|
|
| <BR>
|
| Warn the user of an problem.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xml/utils/XMLString.html">XMLString</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/Expression.html#xstr(org.apache.xpath.XPathContext)">xstr</A></B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Cast result object to a string.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE>equals,
|
| getClass,
|
| hashCode,
|
| notify,
|
| notifyAll,
|
| toString,
|
| wait,
|
| wait,
|
| wait</CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <P>
|
|
|
| <!-- ============ FIELD DETAIL =========== -->
|
|
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Constructor Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="Expression()"><!-- --></A><H3>
|
| Expression</H3>
|
| <PRE>
|
| public <B>Expression</B>()</PRE>
|
| <DL>
|
| </DL>
|
|
|
| <!-- ============ METHOD DETAIL ========== -->
|
|
|
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="canTraverseOutsideSubtree()"><!-- --></A><H3>
|
| canTraverseOutsideSubtree</H3>
|
| <PRE>
|
| public boolean <B>canTraverseOutsideSubtree</B>()</PRE>
|
| <DL>
|
| <DD>Tell if this expression or it's subexpressions can traverse outside |
| the current subtree.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if traversal outside the context node's subtree can occur.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="execute(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
|
| execute</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int currentNode) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Execute an expression in the XPath runtime context, and return the |
| result of the expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>currentNode</CODE> - The currentNode.<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="execute(org.apache.xpath.XPathContext, int, org.apache.xml.dtm.DTM, int)"><!-- --></A><H3>
|
| execute</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int currentNode, |
| <A HREF="../../../org/apache/xml/dtm/DTM.html">DTM</A> dtm, |
| int expType) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Execute an expression in the XPath runtime context, and return the |
| result of the expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>currentNode</CODE> - The currentNode.<DD><CODE>dtm</CODE> - The DTM of the current node.<DD><CODE>expType</CODE> - The expanded type ID of the current node.<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="execute(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| execute</H3>
|
| <PRE>
|
| public abstract <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Execute an expression in the XPath runtime context, and return the |
| result of the expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="execute(org.apache.xpath.XPathContext, boolean)"><!-- --></A><H3>
|
| execute</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/objects/XObject.html">XObject</A> <B>execute</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| boolean destructiveOK) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>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. The default implementation just calls execute(xctxt).<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>destructiveOK</CODE> - true if a "safe" object doesn't need to be returned.<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="num(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| num</H3>
|
| <PRE>
|
| public double <B>num</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Evaluate expression to a number.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>The expression evaluated as a double.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="bool(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| bool</H3>
|
| <PRE>
|
| public boolean <B>bool</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Evaluate expression to a boolean.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>false<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="xstr(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| xstr</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/utils/XMLString.html">XMLString</A> <B>xstr</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Cast result object to a string.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>The string this wraps or the empty string if null<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isNodesetExpr()"><!-- --></A><H3>
|
| isNodesetExpr</H3>
|
| <PRE>
|
| public boolean <B>isNodesetExpr</B>()</PRE>
|
| <DL>
|
| <DD>Tell if the expression is a nodeset expression. In other words, tell |
| if you can execute <A HREF="../../../org/apache/xpath/Expression.html#asNode(org.apache.xpath.XPathContext)">asNode</A> without an exception.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the expression can be represented as a nodeset.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="asNode(org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| asNode</H3>
|
| <PRE>
|
| public int <B>asNode</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Return the first node out of the nodeset, if this expression is |
| a nodeset expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>the first node out of the nodeset, or DTM.NULL.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="asIterator(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
|
| asIterator</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>asIterator</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Given an select expression and a context, evaluate the XPath |
| and return the resulting iterator.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The execution context.<DD><CODE>contextNode</CODE> - The node that "." expresses.<DT><B>Returns:</B><DD>A valid DTMIterator.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - thrown if the active ProblemListener decides |
| the error condition is severe enough to halt processing.<DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - <DT><B>Usage:</B><DD><i><font size="-1" color="#0000FF"> **Experimental**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="asIteratorRaw(org.apache.xpath.XPathContext, int)"><!-- --></A><H3>
|
| asIteratorRaw</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>asIteratorRaw</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| int contextNode) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Given an select expression and a context, evaluate the XPath |
| and return the resulting iterator, but do not clone.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The execution context.<DD><CODE>contextNode</CODE> - The node that "." expresses.<DT><B>Returns:</B><DD>A valid DTMIterator.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - thrown if the active ProblemListener decides |
| the error condition is severe enough to halt processing.<DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - <DT><B>Usage:</B><DD><i><font size="-1" color="#0000FF"> **Experimental**</font></i></DD> |
| </DD>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="executeCharsToContentHandler(org.apache.xpath.XPathContext, org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| executeCharsToContentHandler</H3>
|
| <PRE>
|
| public void <B>executeCharsToContentHandler</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| <A HREF="../../../org/xml/sax/ContentHandler.html">ContentHandler</A> handler) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A>, |
| <A HREF="../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Execute an expression in the XPath runtime context, and return the |
| result of the expression.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context. |
| NEEDSDOC @param handler<DT><B>Returns:</B><DD>The result of the expression in the form of a <code>XObject</code>.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if a runtime exception |
| occurs.<DD><A HREF="../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isStableNumber()"><!-- --></A><H3>
|
| isStableNumber</H3>
|
| <PRE>
|
| public boolean <B>isStableNumber</B>()</PRE>
|
| <DL>
|
| <DD>Tell if this expression returns a stable number that will not change during |
| iterations within the expression. This is used to determine if a proximity |
| position predicate can indicate that no more searching has to occur.<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the expression represents a stable number.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="fixupVariables(java.util.Vector, int)"><!-- --></A><H3>
|
| fixupVariables</H3>
|
| <PRE>
|
| public abstract void <B>fixupVariables</B>(java.util.Vector vars, |
| int globalsSize)</PRE>
|
| <DL>
|
| <DD>This function is used to fixup variables from QNames to stack frame |
| indexes at stylesheet build time.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>vars</CODE> - 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</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="deepEquals(org.apache.xpath.Expression)"><!-- --></A><H3>
|
| deepEquals</H3>
|
| <PRE>
|
| public abstract boolean <B>deepEquals</B>(<A HREF="../../../org/apache/xpath/Expression.html">Expression</A> expr)</PRE>
|
| <DL>
|
| <DD>Compare this object with another object and see |
| if they are equal, include the sub heararchy.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>expr</CODE> - Another expression object.<DT><B>Returns:</B><DD>true if this objects class and the expr |
| object's class are the same, and the data contained |
| within both objects are considered equal.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="warn(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])"><!-- --></A><H3>
|
| warn</H3>
|
| <PRE>
|
| public void <B>warn</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| java.lang.String msg, |
| java.lang.Object[] args) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Warn the user of an problem.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>msg</CODE> - An error msgkey that corresponds to one of the conststants found |
| in <A HREF="../../../org/apache/xpath/res/XPATHErrorResources.html"><CODE>XPATHErrorResources</CODE></A>, which is |
| a key for a format string.<DD><CODE>args</CODE> - An array of arguments represented in the format string, which |
| may be null.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if the current ErrorListoner determines to |
| throw an exception.<DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="assertion(boolean, java.lang.String)"><!-- --></A><H3>
|
| assertion</H3>
|
| <PRE>
|
| public void <B>assertion</B>(boolean b, |
| java.lang.String msg)</PRE>
|
| <DL>
|
| <DD>Tell the user of an assertion error, and probably throw an |
| exception.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>b</CODE> - If false, a runtime exception will be thrown.<DD><CODE>msg</CODE> - The assertion message, which should be informative.<DT><B>Throws:</B><DD>java.lang.RuntimeException - if the b argument is false.<DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="error(org.apache.xpath.XPathContext, java.lang.String, java.lang.Object[])"><!-- --></A><H3>
|
| error</H3>
|
| <PRE>
|
| public void <B>error</B>(<A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt, |
| java.lang.String msg, |
| java.lang.Object[] args) |
| throws <A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A></PRE>
|
| <DL>
|
| <DD>Tell the user of an error, and probably throw an |
| exception.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>xctxt</CODE> - The XPath runtime context.<DD><CODE>msg</CODE> - An error msgkey that corresponds to one of the constants found |
| in <A HREF="../../../org/apache/xpath/res/XPATHErrorResources.html"><CODE>XPATHErrorResources</CODE></A>, which is |
| a key for a format string.<DD><CODE>args</CODE> - An array of arguments represented in the format string, which |
| may be null.<DT><B>Throws:</B><DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - if the current ErrorListoner determines to |
| throw an exception.<DD><A HREF="../../../javax/xml/transform/TransformerException.html">TransformerException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getExpressionOwner()"><!-- --></A><H3>
|
| getExpressionOwner</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> <B>getExpressionOwner</B>()</PRE>
|
| <DL>
|
| <DD>Get the first non-Expression parent of this node.<DD><DL>
|
| <DT><B>Returns:</B><DD>null or first ancestor that is not an Expression.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exprSetParent(org.apache.xpath.ExpressionNode)"><!-- --></A><H3>
|
| exprSetParent</H3>
|
| <PRE>
|
| public void <B>exprSetParent</B>(<A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> n)</PRE>
|
| <DL>
|
| <DD>This pair of methods are used to inform the node of its |
| parent.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/ExpressionNode.html#exprSetParent(org.apache.xpath.ExpressionNode)">exprSetParent</A> in interface <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exprGetParent()"><!-- --></A><H3>
|
| exprGetParent</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> <B>exprGetParent</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/ExpressionNode.html#exprGetParent()">exprGetParent</A> in interface <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exprAddChild(org.apache.xpath.ExpressionNode, int)"><!-- --></A><H3>
|
| exprAddChild</H3>
|
| <PRE>
|
| public void <B>exprAddChild</B>(<A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> n, |
| int i)</PRE>
|
| <DL>
|
| <DD>This method tells the node to add its argument to the node's |
| list of children.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/ExpressionNode.html#exprAddChild(org.apache.xpath.ExpressionNode, int)">exprAddChild</A> in interface <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exprGetChild(int)"><!-- --></A><H3>
|
| exprGetChild</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A> <B>exprGetChild</B>(int i)</PRE>
|
| <DL>
|
| <DD>This method returns a child node. The children are numbered |
| from zero, left to right.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/ExpressionNode.html#exprGetChild(int)">exprGetChild</A> in interface <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exprGetNumChildren()"><!-- --></A><H3>
|
| exprGetNumChildren</H3>
|
| <PRE>
|
| public int <B>exprGetNumChildren</B>()</PRE>
|
| <DL>
|
| <DD>Return the number of children the node has.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xpath/ExpressionNode.html#exprGetNumChildren()">exprGetNumChildren</A> in interface <A HREF="../../../org/apache/xpath/ExpressionNode.html">ExpressionNode</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getPublicId()"><!-- --></A><H3>
|
| getPublicId</H3>
|
| <PRE>
|
| public java.lang.String <B>getPublicId</B>()</PRE>
|
| <DL>
|
| <DD>Return the public identifier for the current document event. |
| |
| <p>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.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>A string containing the public identifier, or |
| null if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/apache/xpath/Expression.html#getSystemId()"><CODE>getSystemId()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getSystemId()"><!-- --></A><H3>
|
| getSystemId</H3>
|
| <PRE>
|
| public java.lang.String <B>getSystemId</B>()</PRE>
|
| <DL>
|
| <DD>Return the system identifier for the current document event. |
| |
| <p>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.</p> |
| |
| <p>If the system identifier is a URL, the parser must resolve it |
| fully before passing it to the application.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>A string containing the system identifier, or null |
| if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/apache/xpath/Expression.html#getPublicId()"><CODE>getPublicId()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLineNumber()"><!-- --></A><H3>
|
| getLineNumber</H3>
|
| <PRE>
|
| public int <B>getLineNumber</B>()</PRE>
|
| <DL>
|
| <DD>Return the line number where the current document event ends. |
| |
| <p><strong>Warning:</strong> 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.</p> |
| |
| <p>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.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>The line number, or -1 if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/apache/xpath/Expression.html#getColumnNumber()"><CODE>getColumnNumber()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getColumnNumber()"><!-- --></A><H3>
|
| getColumnNumber</H3>
|
| <PRE>
|
| public int <B>getColumnNumber</B>()</PRE>
|
| <DL>
|
| <DD>Return the character position where the current document event ends. |
| |
| <p><strong>Warning:</strong> 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.</p> |
| |
| <p>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.</p><DD><DL>
|
| <DT><B>Returns:</B><DD>The column number, or -1 if none is available.<DT><B>See Also: </B><DD><A HREF="../../../org/apache/xpath/Expression.html#getLineNumber()"><CODE>getLineNumber()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| <!-- ========== START OF NAVBAR ========== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
| <TR>
|
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
| <TR ALIGN="center" VALIGN="top">
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Expression.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../org/apache/xpath/CachedXPathAPI.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/apache/xpath/NodeSet.html"><B>NEXT CLASS</B></A></FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A>
|
| <A HREF="Expression.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|
