| <!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 NodeSetDTM
|
| </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/NodeSetDTM.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/NodeSet.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/apache/xpath/SourceTree.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="NodeSetDTM.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 NodeSetDTM</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<A HREF="../../../org/apache/xml/utils/NodeVector.html">org.apache.xml.utils.NodeVector</A>
|
| |
|
| +--<B>org.apache.xpath.NodeSetDTM</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/xpath/axes/RTFIterator.html">RTFIterator</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>NodeSetDTM</B><DT>extends <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A><DT>implements <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A>, java.lang.Cloneable</DL>
|
|
|
| <P>
|
| <p>The NodeSetDTM class can act as either a NodeVector, |
| NodeList, or NodeIterator. However, in order for it to |
| act as a NodeVector or NodeList, it's required that |
| setShouldCacheNodes(true) be called before the first |
| nextNode() is called, in order that nodes can be added |
| as they are fetched. Derived classes that implement iterators |
| must override runTo(int index), in order that they may |
| run the iteration to the given index. </p> |
| |
| <p>Note that we directly implement the DOM's NodeIterator |
| interface. We do not emulate all the behavior of the |
| standard NodeIterator. In particular, we do not guarantee |
| to present a "live view" of the document ... but in XSLT, |
| the source document should never be mutated, so this should |
| never be an issue.</p> |
| |
| <p>Thought: Should NodeSetDTM really implement NodeList and NodeIterator, |
| or should there be specific subclasses of it which do so? The |
| advantage of doing it all here is that all NodeSetDTMs will respond |
| to the same calls; the disadvantage is that some of them may return |
| less-than-enlightening results when you do so.</p>
|
| <P>
|
| <DL>
|
| <DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#org.apache.xpath.NodeSetDTM">Serialized Form</A><DT><B>Usage:</B><DD><i><font size="-1" color="#00FF00"> **For advanced use only**</font></i></DD> |
| </DD>
|
| </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/NodeSetDTM.html#NodeSetDTM(org.apache.xml.dtm.DTMIterator)">NodeSetDTM</A></B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> ni)</CODE>
|
|
|
| <BR>
|
| Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(org.apache.xml.dtm.DTMManager)">NodeSetDTM</A></B>(<A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</CODE>
|
|
|
| <BR>
|
| Create an empty nodelist.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(int, org.apache.xml.dtm.DTMManager)">NodeSetDTM</A></B>(int node, |
| <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</CODE>
|
|
|
| <BR>
|
| Create a NodeSetDTM which contains the given Node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(int, int, org.apache.xml.dtm.DTMManager)">NodeSetDTM</A></B>(int blocksize, |
| int dummy, |
| <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</CODE>
|
|
|
| <BR>
|
| Create an empty, using the given block size.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(org.w3c.dom.traversal.NodeIterator, org.apache.xpath.XPathContext)">NodeSetDTM</A></B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(org.w3c.dom.NodeList, org.apache.xpath.XPathContext)">NodeSetDTM</A></B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodeList, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</CODE>
|
|
|
| <BR>
|
| Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#NodeSetDTM(org.apache.xpath.NodeSetDTM)">NodeSetDTM</A></B>(<A HREF="../../../org/apache/xpath/NodeSetDTM.html">NodeSetDTM</A> nodelist)</CODE>
|
|
|
| <BR>
|
| Create a NodeSetDTM, and copy the members of the |
| given NodeSetDTM into it.</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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#addElement(int)">addElement</A></B>(int value)</CODE>
|
|
|
| <BR>
|
| Append a Node onto the vector.</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/NodeSetDTM.html#addNode(int)">addNode</A></B>(int n)</CODE>
|
|
|
| <BR>
|
| Add a node to the NodeSetDTM.</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/NodeSetDTM.html#addNodeInDocOrder(int, boolean, org.apache.xpath.XPathContext)">addNodeInDocOrder</A></B>(int node, |
| boolean test, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
|
|
|
| <BR>
|
| Add the node into a vector of nodes where it should occur in |
| document order.</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/NodeSetDTM.html#addNodeInDocOrder(int, org.apache.xpath.XPathContext)">addNodeInDocOrder</A></B>(int node, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
|
|
|
| <BR>
|
| Add the node into a vector of nodes where it should occur in |
| document order.</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/NodeSetDTM.html#addNodes(org.apache.xml.dtm.DTMIterator)">addNodes</A></B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> iterator)</CODE>
|
|
|
| <BR>
|
| Copy NodeList members into this nodelist, adding in |
| document order.</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/NodeSetDTM.html#addNodesInDocOrder(org.apache.xml.dtm.DTMIterator, org.apache.xpath.XPathContext)">addNodesInDocOrder</A></B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> iterator, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</CODE>
|
|
|
| <BR>
|
| Copy NodeList members into this nodelist, adding in |
| document order.</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/NodeSetDTM.html#allowDetachToRelease(boolean)">allowDetachToRelease</A></B>(boolean allowRelease)</CODE>
|
|
|
| <BR>
|
| Specify if it's OK for detach to release the iterator for reuse.</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/NodeSetDTM.html#appendNodes(org.apache.xml.utils.NodeVector)">appendNodes</A></B>(<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A> nodes)</CODE>
|
|
|
| <BR>
|
| Append the nodes to the list.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.Object</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#clone()">clone</A></B>()</CODE>
|
|
|
| <BR>
|
| Clone this NodeSetDTM.</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/NodeSetDTM.html#cloneWithReset()">cloneWithReset</A></B>()</CODE>
|
|
|
| <BR>
|
| Get a cloned Iterator, and reset its state to the beginning of the |
| iteration.</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/NodeSetDTM.html#contains(int)">contains</A></B>(int s)</CODE>
|
|
|
| <BR>
|
| Tell if the table contains the given node.</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/NodeSetDTM.html#detach()">detach</A></B>()</CODE>
|
|
|
| <BR>
|
| Detaches the iterator from the set which it iterated over, releasing |
| any computational resources and placing the iterator in the INVALID |
| state.</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/NodeSetDTM.html#elementAt(int)">elementAt</A></B>(int i)</CODE>
|
|
|
| <BR>
|
| Get the nth element.</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/NodeSetDTM.html#getAxis()">getAxis</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the axis being iterated, if it is known.</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/NodeSetDTM.html#getCurrentNode()">getCurrentNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Return the last fetched 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/NodeSetDTM.html#getCurrentPos()">getCurrentPos</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the current position, which is one less than |
| the next nextNode() call will retrieve.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xml/dtm/DTM.html">DTM</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#getDTM(int)">getDTM</A></B>(int nodeHandle)</CODE>
|
|
|
| <BR>
|
| Get an instance of a DTM that "owns" a node handle.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#getDTMManager()">getDTMManager</A></B>()</CODE>
|
|
|
| <BR>
|
| Get an instance of the DTMManager.</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/NodeSetDTM.html#getExpandEntityReferences()">getExpandEntityReferences</A></B>()</CODE>
|
|
|
| <BR>
|
| The value of this flag determines whether the children of entity |
| reference nodes are visible to the 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/DTMFilter.html">DTMFilter</A></CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../org/apache/xpath/NodeSetDTM.html#getFilter()">getFilter</A></B>()</CODE>
|
|
|
| <BR>
|
| The filter object used to screen nodes.</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/NodeSetDTM.html#getLast()">getLast</A></B>()</CODE>
|
|
|
| <BR>
|
| </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/NodeSetDTM.html#getLength()">getLength</A></B>()</CODE>
|
|
|
| <BR>
|
| The number of nodes in the list.</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/NodeSetDTM.html#getRoot()">getRoot</A></B>()</CODE>
|
|
|
| <BR>
|
| </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/NodeSetDTM.html#getShouldCacheNodes()">getShouldCacheNodes</A></B>()</CODE>
|
|
|
| <BR>
|
| Get whether or not this is a cached node set.</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/NodeSetDTM.html#getWhatToShow()">getWhatToShow</A></B>()</CODE>
|
|
|
| <BR>
|
| This attribute determines which node types are presented via the |
| iterator.</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/NodeSetDTM.html#indexOf(int)">indexOf</A></B>(int elem)</CODE>
|
|
|
| <BR>
|
| Searches for the first occurence of the given argument, |
| beginning the search at index, and testing for equality |
| using the equals method.</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/NodeSetDTM.html#indexOf(int, int)">indexOf</A></B>(int elem, |
| int index)</CODE>
|
|
|
| <BR>
|
| Searches for the first occurence of the given argument, |
| beginning the search at index, and testing for equality |
| using the equals method.</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/NodeSetDTM.html#insertElementAt(int, int)">insertElementAt</A></B>(int value, |
| int at)</CODE>
|
|
|
| <BR>
|
| Inserts the specified node in this vector at the specified index.</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/NodeSetDTM.html#insertNode(int, int)">insertNode</A></B>(int n, |
| int pos)</CODE>
|
|
|
| <BR>
|
| Insert a node at a given position.</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/NodeSetDTM.html#isDocOrdered()">isDocOrdered</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns true if all the nodes in the iteration well be returned in document |
| order.</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/NodeSetDTM.html#isFresh()">isFresh</A></B>()</CODE>
|
|
|
| <BR>
|
| Tells if this NodeSetDTM is "fresh", in other words, if |
| the first nextNode() that is called will return the |
| first node in the set.</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/NodeSetDTM.html#isMutable()">isMutable</A></B>()</CODE>
|
|
|
| <BR>
|
| Tells if this iterator can have nodes added to it or set via |
| the <code>setItem(int node, int index)</code> method.</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/NodeSetDTM.html#item(int)">item</A></B>(int index)</CODE>
|
|
|
| <BR>
|
| Returns the <code>index</code>th item in the collection.</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/NodeSetDTM.html#nextNode()">nextNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the next node in the set and advances the position of the |
| iterator in the set.</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/NodeSetDTM.html#previousNode()">previousNode</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the previous node in the set and moves the position of the |
| iterator backwards in the set.</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/NodeSetDTM.html#removeAllElements()">removeAllElements</A></B>()</CODE>
|
|
|
| <BR>
|
| Inserts the specified node in this vector at the specified index.</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/NodeSetDTM.html#removeElement(int)">removeElement</A></B>(int s)</CODE>
|
|
|
| <BR>
|
| Removes the first occurrence of the argument from this vector.</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/NodeSetDTM.html#removeElementAt(int)">removeElementAt</A></B>(int i)</CODE>
|
|
|
| <BR>
|
| Deletes the component at the specified index.</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/NodeSetDTM.html#removeNode(int)">removeNode</A></B>(int n)</CODE>
|
|
|
| <BR>
|
| Remove a node.</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/NodeSetDTM.html#reset()">reset</A></B>()</CODE>
|
|
|
| <BR>
|
| Reset the iterator.</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/NodeSetDTM.html#runTo(int)">runTo</A></B>(int index)</CODE>
|
|
|
| <BR>
|
| If an index is requested, NodeSetDTM will call this method |
| to run the iterator to the index.</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/NodeSetDTM.html#setCurrentPos(int)">setCurrentPos</A></B>(int i)</CODE>
|
|
|
| <BR>
|
| Set the current position in the node set.</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/NodeSetDTM.html#setElementAt(int, int)">setElementAt</A></B>(int node, |
| int index)</CODE>
|
|
|
| <BR>
|
| Sets the component at the specified index of this vector to be the |
| specified object.</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/NodeSetDTM.html#setEnvironment(java.lang.Object)">setEnvironment</A></B>(java.lang.Object environment)</CODE>
|
|
|
| <BR>
|
| Set the environment in which this iterator operates, which should provide: |
| a node (the context node...</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/NodeSetDTM.html#setItem(int, int)">setItem</A></B>(int node, |
| int index)</CODE>
|
|
|
| <BR>
|
| Same as setElementAt.</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/NodeSetDTM.html#setLast(int)">setLast</A></B>(int last)</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/NodeSetDTM.html#setRoot(int, java.lang.Object)">setRoot</A></B>(int context, |
| java.lang.Object environment)</CODE>
|
|
|
| <BR>
|
| Initialize the context values for this expression |
| after it is cloned.</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/NodeSetDTM.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A></B>(boolean b)</CODE>
|
|
|
| <BR>
|
| If setShouldCacheNodes(true) is called, then nodes will |
| be cached.</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/NodeSetDTM.html#size()">size</A></B>()</CODE>
|
|
|
| <BR>
|
| Get the length of the list.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.xml.utils.NodeVector"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.xml.utils.<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../org/apache/xml/utils/NodeVector.html#insertInOrder(int)">insertInOrder</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#peepOrNull()">peepOrNull</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#peepTail()">peepTail</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#peepTailSub1()">peepTailSub1</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#pop()">pop</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#popAndTop()">popAndTop</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#popPair()">popPair</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#popQuick()">popQuick</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#push(int)">push</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#pushPair(int, int)">pushPair</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#RemoveAllNoClear()">RemoveAllNoClear</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#setTail(int)">setTail</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#setTailSub1(int)">setTailSub1</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#sort()">sort</A>,
|
| <A HREF="../../../org/apache/xml/utils/NodeVector.html#sort(int[], int, int)">sort</A></CODE></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="NodeSetDTM(org.apache.xml.dtm.DTMManager)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(<A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</PRE>
|
| <DL>
|
| <DD>Create an empty nodelist.</DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(int, int, org.apache.xml.dtm.DTMManager)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(int blocksize, |
| int dummy, |
| <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</PRE>
|
| <DL>
|
| <DD>Create an empty, using the given block size.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>blocksize</CODE> - Size of blocks to allocate<DD><CODE>dummy</CODE> - pass zero for right now...</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(org.apache.xpath.NodeSetDTM)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(<A HREF="../../../org/apache/xpath/NodeSetDTM.html">NodeSetDTM</A> nodelist)</PRE>
|
| <DL>
|
| <DD>Create a NodeSetDTM, and copy the members of the |
| given NodeSetDTM into it.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodelist</CODE> - Set of Nodes to be made members of the new set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(org.apache.xml.dtm.DTMIterator)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> ni)</PRE>
|
| <DL>
|
| <DD>Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>ni</CODE> - Iterator which yields Nodes to be made members of the new set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(org.w3c.dom.traversal.NodeIterator, org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(<A HREF="../../../org/w3c/dom/traversal/NodeIterator.html">NodeIterator</A> iterator, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</PRE>
|
| <DL>
|
| <DD>Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>iterator</CODE> - Iterator which yields Nodes to be made members of the new set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(org.w3c.dom.NodeList, org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(<A HREF="../../../org/w3c/dom/NodeList.html">NodeList</A> nodeList, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> xctxt)</PRE>
|
| <DL>
|
| <DD>Create a NodeSetDTM, and copy the members of the |
| given DTMIterator into it.</DL>
|
| <HR>
|
|
|
| <A NAME="NodeSetDTM(int, org.apache.xml.dtm.DTMManager)"><!-- --></A><H3>
|
| NodeSetDTM</H3>
|
| <PRE>
|
| public <B>NodeSetDTM</B>(int node, |
| <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> dtmManager)</PRE>
|
| <DL>
|
| <DD>Create a NodeSetDTM which contains the given Node.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - Single node to be added to the new set.</DL>
|
| </DD>
|
| </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="setEnvironment(java.lang.Object)"><!-- --></A><H3>
|
| setEnvironment</H3>
|
| <PRE>
|
| public void <B>setEnvironment</B>(java.lang.Object environment)</PRE>
|
| <DL>
|
| <DD>Set the environment in which this iterator operates, which should provide: |
| a node (the context node... same value as "root" defined below) |
| a pair of non-zero positive integers (the context position and the context size) |
| a set of variable bindings |
| a function library |
| the set of namespace declarations in scope for the expression. |
| |
| <p>At this time the exact implementation of this environment is application |
| dependent. Probably a proper interface will be created fairly soon.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>environment</CODE> - The environment object.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getRoot()"><!-- --></A><H3>
|
| getRoot</H3>
|
| <PRE>
|
| public int <B>getRoot</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getRoot()">getRoot</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The root node of the Iterator, as specified when it was created. |
| For non-Iterator NodeSetDTMs, this will be null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setRoot(int, java.lang.Object)"><!-- --></A><H3>
|
| setRoot</H3>
|
| <PRE>
|
| public void <B>setRoot</B>(int context, |
| java.lang.Object environment)</PRE>
|
| <DL>
|
| <DD>Initialize the context values for this expression |
| after it is cloned.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#setRoot(int, java.lang.Object)">setRoot</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>context</CODE> - The XPath runtime context for this |
| transformation.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="clone()"><!-- --></A><H3>
|
| clone</H3>
|
| <PRE>
|
| public java.lang.Object <B>clone</B>() |
| throws java.lang.CloneNotSupportedException</PRE>
|
| <DL>
|
| <DD>Clone this NodeSetDTM. |
| At this time, we only expect this to be used with LocPathIterators; |
| it may not work with other kinds of NodeSetDTMs.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#clone()">clone</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>a new NodeSetDTM of the same type, having the same state... |
| though unless overridden in the subclasses, it may not copy all |
| the state information.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - if this subclass of NodeSetDTM |
| does not support the clone() operation.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#clone()">clone</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="cloneWithReset()"><!-- --></A><H3>
|
| cloneWithReset</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> <B>cloneWithReset</B>() |
| throws java.lang.CloneNotSupportedException</PRE>
|
| <DL>
|
| <DD>Get a cloned Iterator, and reset its state to the beginning of the |
| iteration.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#cloneWithReset()">cloneWithReset</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>a new NodeSetDTM of the same type, having the same state... |
| except that the reset() operation has been called.<DT><B>Throws:</B><DD>java.lang.CloneNotSupportedException - if this subclass of NodeSetDTM |
| does not support the clone() operation.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="reset()"><!-- --></A><H3>
|
| reset</H3>
|
| <PRE>
|
| public void <B>reset</B>()</PRE>
|
| <DL>
|
| <DD>Reset the iterator. May have no effect on non-iterator Nodesets.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#reset()">reset</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getWhatToShow()"><!-- --></A><H3>
|
| getWhatToShow</H3>
|
| <PRE>
|
| public int <B>getWhatToShow</B>()</PRE>
|
| <DL>
|
| <DD>This attribute determines which node types are presented via the |
| iterator. The available set of constants is defined in the |
| <code>DTMFilter</code> interface. For NodeSetDTMs, the mask has been |
| hardcoded to show all nodes except EntityReference nodes, which have |
| no equivalent in the XPath data model.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getWhatToShow()">getWhatToShow</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>integer used as a bit-array, containing flags defined in |
| the DOM's DTMFilter class. The value will be |
| <code>SHOW_ALL & ~SHOW_ENTITY_REFERENCE</code>, meaning that |
| only entity references are suppressed.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getFilter()"><!-- --></A><H3>
|
| getFilter</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTMFilter.html">DTMFilter</A> <B>getFilter</B>()</PRE>
|
| <DL>
|
| <DD>The filter object used to screen nodes. Filters are applied to |
| further reduce (and restructure) the DTMIterator's view of the |
| document. In our case, we will be using hardcoded filters built |
| into our iterators... but getFilter() is part of the DOM's |
| DTMIterator interface, so we have to support it.<DD><DL>
|
| <DT><B>Returns:</B><DD>null, which is slightly misleading. True, there is no |
| user-written filter object, but in fact we are doing some very |
| sophisticated custom filtering. A DOM purist might suggest |
| returning a placeholder object just to indicate that this is |
| not going to return all nodes selected by whatToShow.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getExpandEntityReferences()"><!-- --></A><H3>
|
| getExpandEntityReferences</H3>
|
| <PRE>
|
| public boolean <B>getExpandEntityReferences</B>()</PRE>
|
| <DL>
|
| <DD>The value of this flag determines whether the children of entity |
| reference nodes are visible to the iterator. If false, they will be |
| skipped over. |
| <br> To produce a view of the document that has entity references |
| expanded and does not expose the entity reference node itself, use the |
| whatToShow flags to hide the entity reference node and set |
| expandEntityReferences to true when creating the iterator. To produce |
| a view of the document that has entity reference nodes but no entity |
| expansion, use the whatToShow flags to show the entity reference node |
| and set expandEntityReferences to false.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getExpandEntityReferences()">getExpandEntityReferences</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>true for all iterators based on NodeSetDTM, meaning that the |
| contents of EntityRefrence nodes may be returned (though whatToShow |
| says that the EntityReferences themselves are not shown.)</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTM(int)"><!-- --></A><H3>
|
| getDTM</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTM.html">DTM</A> <B>getDTM</B>(int nodeHandle)</PRE>
|
| <DL>
|
| <DD>Get an instance of a DTM that "owns" a node handle. Since a node |
| iterator may be passed without a DTMManager, this allows the |
| caller to easily get the DTM using just the iterator.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getDTM(int)">getDTM</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>nodeHandle</CODE> - the nodeHandle.<DT><B>Returns:</B><DD>a non-null DTM reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDTMManager()"><!-- --></A><H3>
|
| getDTMManager</H3>
|
| <PRE>
|
| public <A HREF="../../../org/apache/xml/dtm/DTMManager.html">DTMManager</A> <B>getDTMManager</B>()</PRE>
|
| <DL>
|
| <DD>Get an instance of the DTMManager. Since a node |
| iterator may be passed without a DTMManager, this allows the |
| caller to easily get the DTMManager using just the iterator.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getDTMManager()">getDTMManager</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>a non-null DTMManager reference.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="nextNode()"><!-- --></A><H3>
|
| nextNode</H3>
|
| <PRE>
|
| public int <B>nextNode</B>()</PRE>
|
| <DL>
|
| <DD>Returns the next node in the set and advances the position of the |
| iterator in the set. After a DTMIterator is created, the first call |
| to nextNode() returns the first node in the set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#nextNode()">nextNode</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The next <code>Node</code> in the set being iterated over, or |
| <code>DTM.NULL</code> if there are no more members in that set.<DT><B>Throws:</B><DD>DOMException - INVALID_STATE_ERR: Raised if this method is called after the |
| <code>detach</code> method was invoked.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="previousNode()"><!-- --></A><H3>
|
| previousNode</H3>
|
| <PRE>
|
| public int <B>previousNode</B>()</PRE>
|
| <DL>
|
| <DD>Returns the previous node in the set and moves the position of the |
| iterator backwards in the set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#previousNode()">previousNode</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The previous <code>Node</code> in the set being iterated over, |
| or<code>DTM.NULL</code> if there are no more members in that set.<DT><B>Throws:</B><DD>DOMException - INVALID_STATE_ERR: Raised if this method is called after the |
| <code>detach</code> method was invoked.<DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a cached type, and hence doesn't know what the previous node was.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="detach()"><!-- --></A><H3>
|
| detach</H3>
|
| <PRE>
|
| public void <B>detach</B>()</PRE>
|
| <DL>
|
| <DD>Detaches the iterator from the set which it iterated over, releasing |
| any computational resources and placing the iterator in the INVALID |
| state. After<code>detach</code> has been invoked, calls to |
| <code>nextNode</code> or<code>previousNode</code> will raise the |
| exception INVALID_STATE_ERR. |
| <p> |
| This operation is a no-op in NodeSetDTM, and will not cause |
| INVALID_STATE_ERR to be raised by later operations. |
| </p><DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#detach()">detach</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="allowDetachToRelease(boolean)"><!-- --></A><H3>
|
| allowDetachToRelease</H3>
|
| <PRE>
|
| public void <B>allowDetachToRelease</B>(boolean allowRelease)</PRE>
|
| <DL>
|
| <DD>Specify if it's OK for detach to release the iterator for reuse.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#allowDetachToRelease(boolean)">allowDetachToRelease</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>allowRelease</CODE> - true if it is OK for detach to release this iterator |
| for pooling.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isFresh()"><!-- --></A><H3>
|
| isFresh</H3>
|
| <PRE>
|
| public boolean <B>isFresh</B>()</PRE>
|
| <DL>
|
| <DD>Tells if this NodeSetDTM is "fresh", in other words, if |
| the first nextNode() that is called will return the |
| first node in the set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#isFresh()">isFresh</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>true if nextNode() would return the first node in the set, |
| false if it would return a later one.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="runTo(int)"><!-- --></A><H3>
|
| runTo</H3>
|
| <PRE>
|
| public void <B>runTo</B>(int index)</PRE>
|
| <DL>
|
| <DD>If an index is requested, NodeSetDTM will call this method |
| to run the iterator to the index. By default this sets |
| m_next to the index. If the index argument is -1, this |
| signals that the iterator should be run to the end.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#runTo(int)">runTo</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - Position to advance (or retreat) to, with |
| 0 requesting the reset ("fresh") position and -1 (or indeed |
| any out-of-bounds value) requesting the final position.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not |
| one of the types which supports indexing/counting.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="item(int)"><!-- --></A><H3>
|
| item</H3>
|
| <PRE>
|
| public int <B>item</B>(int index)</PRE>
|
| <DL>
|
| <DD>Returns the <code>index</code>th item in the collection. If |
| <code>index</code> is greater than or equal to the number of nodes in |
| the list, this returns <code>null</code>. |
| |
| TODO: What happens if index is out of range?<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#item(int)">item</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>index</CODE> - Index into the collection.<DT><B>Returns:</B><DD>The node at the <code>index</code>th position in the |
| <code>NodeList</code>, or <code>null</code> if that is not a valid |
| index.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLength()"><!-- --></A><H3>
|
| getLength</H3>
|
| <PRE>
|
| public int <B>getLength</B>()</PRE>
|
| <DL>
|
| <DD>The number of nodes in the list. The range of valid child node indices is |
| 0 to <code>length-1</code> inclusive. Note that this operation requires |
| finding all the matching nodes, which may defeat attempts to defer |
| that work.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getLength()">getLength</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>integer indicating how many nodes are represented by this list.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addNode(int)"><!-- --></A><H3>
|
| addNode</H3>
|
| <PRE>
|
| public void <B>addNode</B>(int n)</PRE>
|
| <DL>
|
| <DD>Add a node to the NodeSetDTM. Not all types of NodeSetDTMs support this |
| operation<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="insertNode(int, int)"><!-- --></A><H3>
|
| insertNode</H3>
|
| <PRE>
|
| public void <B>insertNode</B>(int n, |
| int pos)</PRE>
|
| <DL>
|
| <DD>Insert a node at a given position.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DD><CODE>pos</CODE> - Offset at which the node is to be inserted, |
| with 0 being the first position.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="removeNode(int)"><!-- --></A><H3>
|
| removeNode</H3>
|
| <PRE>
|
| public void <B>removeNode</B>(int n)</PRE>
|
| <DL>
|
| <DD>Remove a node.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>n</CODE> - Node to be added<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addNodes(org.apache.xml.dtm.DTMIterator)"><!-- --></A><H3>
|
| addNodes</H3>
|
| <PRE>
|
| public void <B>addNodes</B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> iterator)</PRE>
|
| <DL>
|
| <DD>Copy NodeList members into this nodelist, adding in |
| document order. Null references are not added.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>iterator</CODE> - DTMIterator which yields the nodes to be added.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addNodesInDocOrder(org.apache.xml.dtm.DTMIterator, org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| addNodesInDocOrder</H3>
|
| <PRE>
|
| public void <B>addNodesInDocOrder</B>(<A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A> iterator, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
|
| <DL>
|
| <DD>Copy NodeList members into this nodelist, adding in |
| document order. If a node is null, don't add it.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>iterator</CODE> - DTMIterator which yields the nodes to be added.<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addNodeInDocOrder(int, boolean, org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| addNodeInDocOrder</H3>
|
| <PRE>
|
| public int <B>addNodeInDocOrder</B>(int node, |
| boolean test, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
|
| <DL>
|
| <DD>Add the node into a vector of nodes where it should occur in |
| document order.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be added.<DD><CODE>test</CODE> - true if we should test for doc order<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>insertIndex.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addNodeInDocOrder(int, org.apache.xpath.XPathContext)"><!-- --></A><H3>
|
| addNodeInDocOrder</H3>
|
| <PRE>
|
| public int <B>addNodeInDocOrder</B>(int node, |
| <A HREF="../../../org/apache/xpath/XPathContext.html">XPathContext</A> support)</PRE>
|
| <DL>
|
| <DD>Add the node into a vector of nodes where it should occur in |
| document order.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be added.<DD><CODE>support</CODE> - The XPath runtime context.<DT><B>Returns:</B><DD>The index where it was inserted.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="size()"><!-- --></A><H3>
|
| size</H3>
|
| <PRE>
|
| public int <B>size</B>()</PRE>
|
| <DL>
|
| <DD>Get the length of the list.<DD><DL>
|
| <DT><B>Returns:</B><DD>The size of this node set.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#size()">size</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addElement(int)"><!-- --></A><H3>
|
| addElement</H3>
|
| <PRE>
|
| public void <B>addElement</B>(int value)</PRE>
|
| <DL>
|
| <DD>Append a Node onto the vector.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - The node to be added.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#addElement(int)">addElement</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="insertElementAt(int, int)"><!-- --></A><H3>
|
| insertElementAt</H3>
|
| <PRE>
|
| public void <B>insertElementAt</B>(int value, |
| int at)</PRE>
|
| <DL>
|
| <DD>Inserts the specified node in this vector at the specified index. |
| Each component in this vector with an index greater or equal to |
| the specified index is shifted upward to have an index one greater |
| than the value it had previously.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - The node to be inserted.<DD><CODE>at</CODE> - The index where the insert should occur.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#insertElementAt(int, int)">insertElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="appendNodes(org.apache.xml.utils.NodeVector)"><!-- --></A><H3>
|
| appendNodes</H3>
|
| <PRE>
|
| public void <B>appendNodes</B>(<A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A> nodes)</PRE>
|
| <DL>
|
| <DD>Append the nodes to the list.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>nodes</CODE> - The nodes to be appended to this node set.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#appendNodes(org.apache.xml.utils.NodeVector)">appendNodes</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="removeAllElements()"><!-- --></A><H3>
|
| removeAllElements</H3>
|
| <PRE>
|
| public void <B>removeAllElements</B>()</PRE>
|
| <DL>
|
| <DD>Inserts the specified node in this vector at the specified index. |
| Each component in this vector with an index greater or equal to |
| the specified index is shifted upward to have an index one greater |
| than the value it had previously.<DD><DL>
|
| <DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeAllElements()">removeAllElements</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="removeElement(int)"><!-- --></A><H3>
|
| removeElement</H3>
|
| <PRE>
|
| public boolean <B>removeElement</B>(int s)</PRE>
|
| <DL>
|
| <DD>Removes the first occurrence of the argument from this vector. |
| If the object is found in this vector, each component in the vector |
| with an index greater or equal to the object's index is shifted |
| downward to have an index one smaller than the value it had |
| previously.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>s</CODE> - The node to be removed.<DT><B>Returns:</B><DD>True if the node was successfully removed<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeElement(int)">removeElement</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="removeElementAt(int)"><!-- --></A><H3>
|
| removeElementAt</H3>
|
| <PRE>
|
| public void <B>removeElementAt</B>(int i)</PRE>
|
| <DL>
|
| <DD>Deletes the component at the specified index. Each component in |
| this vector with an index greater or equal to the specified |
| index is shifted downward to have an index one smaller than |
| the value it had previously.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>i</CODE> - The index of the node to be removed.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#removeElementAt(int)">removeElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setElementAt(int, int)"><!-- --></A><H3>
|
| setElementAt</H3>
|
| <PRE>
|
| public void <B>setElementAt</B>(int node, |
| int index)</PRE>
|
| <DL>
|
| <DD>Sets the component at the specified index of this vector to be the |
| specified object. The previous component at that position is discarded. |
| |
| The index must be a value greater than or equal to 0 and less |
| than the current size of the vector.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be set.<DD><CODE>index</CODE> - The index of the node to be replaced.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#setElementAt(int, int)">setElementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setItem(int, int)"><!-- --></A><H3>
|
| setItem</H3>
|
| <PRE>
|
| public void <B>setItem</B>(int node, |
| int index)</PRE>
|
| <DL>
|
| <DD>Same as setElementAt.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#setItem(int, int)">setItem</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>node</CODE> - The node to be set.<DD><CODE>index</CODE> - The index of the node to be replaced.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a mutable type.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="elementAt(int)"><!-- --></A><H3>
|
| elementAt</H3>
|
| <PRE>
|
| public int <B>elementAt</B>(int i)</PRE>
|
| <DL>
|
| <DD>Get the nth element.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>i</CODE> - The index of the requested node.<DT><B>Returns:</B><DD>Node at specified index.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#elementAt(int)">elementAt</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="contains(int)"><!-- --></A><H3>
|
| contains</H3>
|
| <PRE>
|
| public boolean <B>contains</B>(int s)</PRE>
|
| <DL>
|
| <DD>Tell if the table contains the given node.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>s</CODE> - Node to look for<DT><B>Returns:</B><DD>True if the given node was found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#contains(int)">contains</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(int, int)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(int elem, |
| int index)</PRE>
|
| <DL>
|
| <DD>Searches for the first occurence of the given argument, |
| beginning the search at index, and testing for equality |
| using the equals method.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>elem</CODE> - Node to look for<DD><CODE>index</CODE> - Index of where to start the search<DT><B>Returns:</B><DD>the index of the first occurrence of the object |
| argument in this vector at position index or later in the |
| vector; returns -1 if the object is not found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#indexOf(int, int)">indexOf</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="indexOf(int)"><!-- --></A><H3>
|
| indexOf</H3>
|
| <PRE>
|
| public int <B>indexOf</B>(int elem)</PRE>
|
| <DL>
|
| <DD>Searches for the first occurence of the given argument, |
| beginning the search at index, and testing for equality |
| using the equals method.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>elem</CODE> - Node to look for<DT><B>Returns:</B><DD>the index of the first occurrence of the object |
| argument in this vector at position index or later in the |
| vector; returns -1 if the object is not found.<DT><B>Overrides:</B><DD><A HREF="../../../org/apache/xml/utils/NodeVector.html#indexOf(int)">indexOf</A> in class <A HREF="../../../org/apache/xml/utils/NodeVector.html">NodeVector</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentPos()"><!-- --></A><H3>
|
| getCurrentPos</H3>
|
| <PRE>
|
| public int <B>getCurrentPos</B>()</PRE>
|
| <DL>
|
| <DD>Get the current position, which is one less than |
| the next nextNode() call will retrieve. i.e. if |
| you call getCurrentPos() and the return is 0, the next |
| fetch will take place at index 1.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getCurrentPos()">getCurrentPos</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>The the current position index.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setCurrentPos(int)"><!-- --></A><H3>
|
| setCurrentPos</H3>
|
| <PRE>
|
| public void <B>setCurrentPos</B>(int i)</PRE>
|
| <DL>
|
| <DD>Set the current position in the node set.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#setCurrentPos(int)">setCurrentPos</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>i</CODE> - Must be a valid index.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a cached type, and thus doesn't permit indexed access.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getCurrentNode()"><!-- --></A><H3>
|
| getCurrentNode</H3>
|
| <PRE>
|
| public int <B>getCurrentNode</B>()</PRE>
|
| <DL>
|
| <DD>Return the last fetched node. Needed to support the UnionPathIterator.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getCurrentNode()">getCurrentNode</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>the last fetched node.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if this NodeSetDTM is not of |
| a cached type, and thus doesn't permit indexed access.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getShouldCacheNodes()"><!-- --></A><H3>
|
| getShouldCacheNodes</H3>
|
| <PRE>
|
| public boolean <B>getShouldCacheNodes</B>()</PRE>
|
| <DL>
|
| <DD>Get whether or not this is a cached node set.<DD><DL>
|
| <DT><B>Returns:</B><DD>True if this list is cached.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setShouldCacheNodes(boolean)"><!-- --></A><H3>
|
| setShouldCacheNodes</H3>
|
| <PRE>
|
| public void <B>setShouldCacheNodes</B>(boolean b)</PRE>
|
| <DL>
|
| <DD>If setShouldCacheNodes(true) is called, then nodes will |
| be cached. They are not cached by default. This switch must |
| be set before the first call to nextNode is made, to ensure |
| that all nodes are cached.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#setShouldCacheNodes(boolean)">setShouldCacheNodes</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Parameters:</B><DD><CODE>b</CODE> - true if this node set should be cached.<DT><B>Throws:</B><DD>java.lang.RuntimeException - thrown if an attempt is made to |
| request caching after we've already begun stepping through the |
| nodes in this set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isMutable()"><!-- --></A><H3>
|
| isMutable</H3>
|
| <PRE>
|
| public boolean <B>isMutable</B>()</PRE>
|
| <DL>
|
| <DD>Tells if this iterator can have nodes added to it or set via |
| the <code>setItem(int node, int index)</code> method.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#isMutable()">isMutable</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>True if the nodelist can be mutated.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getLast()"><!-- --></A><H3>
|
| getLast</H3>
|
| <PRE>
|
| public int <B>getLast</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setLast(int)"><!-- --></A><H3>
|
| setLast</H3>
|
| <PRE>
|
| public void <B>setLast</B>(int last)</PRE>
|
| <DL>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="isDocOrdered()"><!-- --></A><H3>
|
| isDocOrdered</H3>
|
| <PRE>
|
| public boolean <B>isDocOrdered</B>()</PRE>
|
| <DL>
|
| <DD>Returns true if all the nodes in the iteration well be returned in document |
| order.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#isDocOrdered()">isDocOrdered</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>true as a default.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getAxis()"><!-- --></A><H3>
|
| getAxis</H3>
|
| <PRE>
|
| public int <B>getAxis</B>()</PRE>
|
| <DL>
|
| <DD>Returns the axis being iterated, if it is known.<DD><DL>
|
| <DT><B>Specified by: </B><DD><A HREF="../../../org/apache/xml/dtm/DTMIterator.html#getAxis()">getAxis</A> in interface <A HREF="../../../org/apache/xml/dtm/DTMIterator.html">DTMIterator</A><DT><B>Returns:</B><DD>Axis.CHILD, etc., or -1 if the axis is not known or is of multiple |
| types.</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/NodeSetDTM.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/NodeSet.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../org/apache/xpath/SourceTree.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="NodeSetDTM.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>
|
