| <HTML> |
| <BODY BGCOLOR="white"> |
| <PRE> |
| <FONT color="green">001</FONT> /*<a name="line.1"></a> |
| <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a> |
| <FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a> |
| <FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a> |
| <FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a> |
| <FONT color="green">009</FONT> *<a name="line.9"></a> |
| <FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <FONT color="green">011</FONT> *<a name="line.11"></a> |
| <FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a> |
| <FONT color="green">017</FONT> */<a name="line.17"></a> |
| <FONT color="green">018</FONT> /*<a name="line.18"></a> |
| <FONT color="green">019</FONT> * $Id: DTMIterator.java 468653 2006-10-28 07:07:05Z minchau $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xml.dtm;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> /**<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> * <code>DTMIterators</code> are used to step through a (possibly<a name="line.25"></a> |
| <FONT color="green">026</FONT> * filtered) set of nodes. Their API is modeled largely after the DOM<a name="line.26"></a> |
| <FONT color="green">027</FONT> * NodeIterator.<a name="line.27"></a> |
| <FONT color="green">028</FONT> * <a name="line.28"></a> |
| <FONT color="green">029</FONT> * <p>A DTMIterator is a somewhat unusual type of iterator, in that it <a name="line.29"></a> |
| <FONT color="green">030</FONT> * can serve both single node iteration and random access.</p><a name="line.30"></a> |
| <FONT color="green">031</FONT> * <a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p>The DTMIterator's traversal semantics, i.e. how it walks the tree,<a name="line.32"></a> |
| <FONT color="green">033</FONT> * are specified when it is created, possibly and probably by an XPath<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or <a name="line.34"></a> |
| <FONT color="green">035</FONT> * a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.</p><a name="line.35"></a> |
| <FONT color="green">036</FONT> * <a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p>A DTMIterator is meant to be created once as a master static object, and <a name="line.37"></a> |
| <FONT color="green">038</FONT> * then cloned many times for runtime use. Or the master object itself may <a name="line.38"></a> |
| <FONT color="green">039</FONT> * be used for simpler use cases.</p><a name="line.39"></a> |
| <FONT color="green">040</FONT> *<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <p>At this time, we do not expect DTMIterator to emulate<a name="line.41"></a> |
| <FONT color="green">042</FONT> * NodeIterator's "maintain relative position" semantics under<a name="line.42"></a> |
| <FONT color="green">043</FONT> * document mutation. It's likely to respond more like the<a name="line.43"></a> |
| <FONT color="green">044</FONT> * TreeWalker's "current node" semantics. However, since the base DTM<a name="line.44"></a> |
| <FONT color="green">045</FONT> * is immutable, this issue currently makes no practical<a name="line.45"></a> |
| <FONT color="green">046</FONT> * difference.</p><a name="line.46"></a> |
| <FONT color="green">047</FONT> *<a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p>State: In progress!!</p> */<a name="line.48"></a> |
| <FONT color="green">049</FONT> public interface DTMIterator<a name="line.49"></a> |
| <FONT color="green">050</FONT> {<a name="line.50"></a> |
| <FONT color="green">051</FONT> <a name="line.51"></a> |
| <FONT color="green">052</FONT> // Constants returned by acceptNode, borrowed from the DOM Traversal chapter<a name="line.52"></a> |
| <FONT color="green">053</FONT> // %REVIEW% Should we explicitly initialize them from, eg,<a name="line.53"></a> |
| <FONT color="green">054</FONT> // org.w3c.dom.traversal.NodeFilter.FILTER_ACCEPT?<a name="line.54"></a> |
| <FONT color="green">055</FONT> <a name="line.55"></a> |
| <FONT color="green">056</FONT> /**<a name="line.56"></a> |
| <FONT color="green">057</FONT> * Accept the node.<a name="line.57"></a> |
| <FONT color="green">058</FONT> */<a name="line.58"></a> |
| <FONT color="green">059</FONT> public static final short FILTER_ACCEPT = 1;<a name="line.59"></a> |
| <FONT color="green">060</FONT> <a name="line.60"></a> |
| <FONT color="green">061</FONT> /**<a name="line.61"></a> |
| <FONT color="green">062</FONT> * Reject the node. Same behavior as FILTER_SKIP. (In the DOM these<a name="line.62"></a> |
| <FONT color="green">063</FONT> * differ when applied to a TreeWalker but have the same result when<a name="line.63"></a> |
| <FONT color="green">064</FONT> * applied to a NodeIterator).<a name="line.64"></a> |
| <FONT color="green">065</FONT> */<a name="line.65"></a> |
| <FONT color="green">066</FONT> public static final short FILTER_REJECT = 2;<a name="line.66"></a> |
| <FONT color="green">067</FONT> <a name="line.67"></a> |
| <FONT color="green">068</FONT> /**<a name="line.68"></a> |
| <FONT color="green">069</FONT> * Skip this single node. <a name="line.69"></a> |
| <FONT color="green">070</FONT> */<a name="line.70"></a> |
| <FONT color="green">071</FONT> public static final short FILTER_SKIP = 3;<a name="line.71"></a> |
| <FONT color="green">072</FONT> <a name="line.72"></a> |
| <FONT color="green">073</FONT> /**<a name="line.73"></a> |
| <FONT color="green">074</FONT> * Get an instance of a DTM that "owns" a node handle. Since a node <a name="line.74"></a> |
| <FONT color="green">075</FONT> * iterator may be passed without a DTMManager, this allows the <a name="line.75"></a> |
| <FONT color="green">076</FONT> * caller to easily get the DTM using just the iterator.<a name="line.76"></a> |
| <FONT color="green">077</FONT> *<a name="line.77"></a> |
| <FONT color="green">078</FONT> * @param nodeHandle the nodeHandle.<a name="line.78"></a> |
| <FONT color="green">079</FONT> *<a name="line.79"></a> |
| <FONT color="green">080</FONT> * @return a non-null DTM reference.<a name="line.80"></a> |
| <FONT color="green">081</FONT> */<a name="line.81"></a> |
| <FONT color="green">082</FONT> public DTM getDTM(int nodeHandle);<a name="line.82"></a> |
| <FONT color="green">083</FONT> <a name="line.83"></a> |
| <FONT color="green">084</FONT> /**<a name="line.84"></a> |
| <FONT color="green">085</FONT> * Get an instance of the DTMManager. Since a node <a name="line.85"></a> |
| <FONT color="green">086</FONT> * iterator may be passed without a DTMManager, this allows the <a name="line.86"></a> |
| <FONT color="green">087</FONT> * caller to easily get the DTMManager using just the iterator.<a name="line.87"></a> |
| <FONT color="green">088</FONT> *<a name="line.88"></a> |
| <FONT color="green">089</FONT> * @return a non-null DTMManager reference.<a name="line.89"></a> |
| <FONT color="green">090</FONT> */<a name="line.90"></a> |
| <FONT color="green">091</FONT> public DTMManager getDTMManager();<a name="line.91"></a> |
| <FONT color="green">092</FONT> <a name="line.92"></a> |
| <FONT color="green">093</FONT> /**<a name="line.93"></a> |
| <FONT color="green">094</FONT> * The root node of the <code>DTMIterator</code>, as specified when it<a name="line.94"></a> |
| <FONT color="green">095</FONT> * was created. Note the root node is not the root node of the <a name="line.95"></a> |
| <FONT color="green">096</FONT> * document tree, but the context node from where the iteration <a name="line.96"></a> |
| <FONT color="green">097</FONT> * begins and ends.<a name="line.97"></a> |
| <FONT color="green">098</FONT> *<a name="line.98"></a> |
| <FONT color="green">099</FONT> * @return nodeHandle int Handle of the context node.<a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> public int getRoot();<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> /**<a name="line.103"></a> |
| <FONT color="green">104</FONT> * Reset the root node of the <code>DTMIterator</code>, overriding<a name="line.104"></a> |
| <FONT color="green">105</FONT> * the value specified when it was created. Note the root node is<a name="line.105"></a> |
| <FONT color="green">106</FONT> * not the root node of the document tree, but the context node from<a name="line.106"></a> |
| <FONT color="green">107</FONT> * where the iteration begins.<a name="line.107"></a> |
| <FONT color="green">108</FONT> *<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @param nodeHandle int Handle of the context node.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @param environment The environment object. <a name="line.110"></a> |
| <FONT color="green">111</FONT> * The environment in which this iterator operates, which should provide:<a name="line.111"></a> |
| <FONT color="green">112</FONT> * <ul><a name="line.112"></a> |
| <FONT color="green">113</FONT> * <li>a node (the context node... same value as "root" defined below) </li><a name="line.113"></a> |
| <FONT color="green">114</FONT> * <li>a pair of non-zero positive integers (the context position and the context size) </li><a name="line.114"></a> |
| <FONT color="green">115</FONT> * <li>a set of variable bindings </li><a name="line.115"></a> |
| <FONT color="green">116</FONT> * <li>a function library </li><a name="line.116"></a> |
| <FONT color="green">117</FONT> * <li>the set of namespace declarations in scope for the expression.</li><a name="line.117"></a> |
| <FONT color="green">118</FONT> * <ul><a name="line.118"></a> |
| <FONT color="green">119</FONT> * <a name="line.119"></a> |
| <FONT color="green">120</FONT> * <p>At this time the exact implementation of this environment is application <a name="line.120"></a> |
| <FONT color="green">121</FONT> * dependent. Probably a proper interface will be created fairly soon.</p><a name="line.121"></a> |
| <FONT color="green">122</FONT> * <a name="line.122"></a> |
| <FONT color="green">123</FONT> */<a name="line.123"></a> |
| <FONT color="green">124</FONT> public void setRoot(int nodeHandle, Object environment);<a name="line.124"></a> |
| <FONT color="green">125</FONT> <a name="line.125"></a> |
| <FONT color="green">126</FONT> /**<a name="line.126"></a> |
| <FONT color="green">127</FONT> * Reset the iterator to the start. After resetting, the next node returned<a name="line.127"></a> |
| <FONT color="green">128</FONT> * will be the root node -- or, if that's filtered out, the first node<a name="line.128"></a> |
| <FONT color="green">129</FONT> * within the root's subtree which is _not_ skipped by the filters.<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> public void reset();<a name="line.131"></a> |
| <FONT color="green">132</FONT> <a name="line.132"></a> |
| <FONT color="green">133</FONT> /**<a name="line.133"></a> |
| <FONT color="green">134</FONT> * This attribute determines which node types are presented via the<a name="line.134"></a> |
| <FONT color="green">135</FONT> * iterator. The available set of constants is defined above. <a name="line.135"></a> |
| <FONT color="green">136</FONT> * Nodes not accepted by<a name="line.136"></a> |
| <FONT color="green">137</FONT> * <code>whatToShow</code> will be skipped, but their children may still<a name="line.137"></a> |
| <FONT color="green">138</FONT> * be considered.<a name="line.138"></a> |
| <FONT color="green">139</FONT> *<a name="line.139"></a> |
| <FONT color="green">140</FONT> * @return one of the SHOW_XXX constants, or several ORed together.<a name="line.140"></a> |
| <FONT color="green">141</FONT> */<a name="line.141"></a> |
| <FONT color="green">142</FONT> public int getWhatToShow();<a name="line.142"></a> |
| <FONT color="green">143</FONT> <a name="line.143"></a> |
| <FONT color="green">144</FONT> /**<a name="line.144"></a> |
| <FONT color="green">145</FONT> * <p>The value of this flag determines whether the children of entity<a name="line.145"></a> |
| <FONT color="green">146</FONT> * reference nodes are visible to the iterator. If false, they and<a name="line.146"></a> |
| <FONT color="green">147</FONT> * their descendants will be rejected. Note that this rejection takes<a name="line.147"></a> |
| <FONT color="green">148</FONT> * precedence over <code>whatToShow</code> and the filter. </p><a name="line.148"></a> |
| <FONT color="green">149</FONT> * <a name="line.149"></a> |
| <FONT color="green">150</FONT> * <p> To produce a view of the document that has entity references<a name="line.150"></a> |
| <FONT color="green">151</FONT> * expanded and does not expose the entity reference node itself, use<a name="line.151"></a> |
| <FONT color="green">152</FONT> * the <code>whatToShow</code> flags to hide the entity reference node<a name="line.152"></a> |
| <FONT color="green">153</FONT> * and set <code>expandEntityReferences</code> to true when creating the<a name="line.153"></a> |
| <FONT color="green">154</FONT> * iterator. To produce a view of the document that has entity reference<a name="line.154"></a> |
| <FONT color="green">155</FONT> * nodes but no entity expansion, use the <code>whatToShow</code> flags<a name="line.155"></a> |
| <FONT color="green">156</FONT> * to show the entity reference node and set<a name="line.156"></a> |
| <FONT color="green">157</FONT> * <code>expandEntityReferences</code> to false.</p><a name="line.157"></a> |
| <FONT color="green">158</FONT> *<a name="line.158"></a> |
| <FONT color="green">159</FONT> * <p>NOTE: In Xalan's use of DTM we will generally have fully expanded<a name="line.159"></a> |
| <FONT color="green">160</FONT> * entity references when the document tree was built, and thus this<a name="line.160"></a> |
| <FONT color="green">161</FONT> * flag will have no effect.</p><a name="line.161"></a> |
| <FONT color="green">162</FONT> *<a name="line.162"></a> |
| <FONT color="green">163</FONT> * @return true if entity references will be expanded. */<a name="line.163"></a> |
| <FONT color="green">164</FONT> public boolean getExpandEntityReferences();<a name="line.164"></a> |
| <FONT color="green">165</FONT> <a name="line.165"></a> |
| <FONT color="green">166</FONT> /**<a name="line.166"></a> |
| <FONT color="green">167</FONT> * Returns the next node in the set and advances the position of the<a name="line.167"></a> |
| <FONT color="green">168</FONT> * iterator in the set. After a <code>DTMIterator</code> has setRoot called,<a name="line.168"></a> |
| <FONT color="green">169</FONT> * the first call to <code>nextNode()</code> returns that root or (if it<a name="line.169"></a> |
| <FONT color="green">170</FONT> * is rejected by the filters) the first node within its subtree which is<a name="line.170"></a> |
| <FONT color="green">171</FONT> * not filtered out.<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @return The next node handle in the set being iterated over, or<a name="line.172"></a> |
| <FONT color="green">173</FONT> * <code>DTM.NULL</code> if there are no more members in that set.<a name="line.173"></a> |
| <FONT color="green">174</FONT> */<a name="line.174"></a> |
| <FONT color="green">175</FONT> public int nextNode();<a name="line.175"></a> |
| <FONT color="green">176</FONT> <a name="line.176"></a> |
| <FONT color="green">177</FONT> /**<a name="line.177"></a> |
| <FONT color="green">178</FONT> * Returns the previous node in the set and moves the position of the<a name="line.178"></a> |
| <FONT color="green">179</FONT> * <code>DTMIterator</code> backwards in the set.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @return The previous node handle in the set being iterated over,<a name="line.180"></a> |
| <FONT color="green">181</FONT> * or <code>DTM.NULL</code> if there are no more members in that set.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> public int previousNode();<a name="line.183"></a> |
| <FONT color="green">184</FONT> <a name="line.184"></a> |
| <FONT color="green">185</FONT> /**<a name="line.185"></a> |
| <FONT color="green">186</FONT> * Detaches the <code>DTMIterator</code> from the set which it iterated<a name="line.186"></a> |
| <FONT color="green">187</FONT> * over, releasing any computational resources and placing the iterator<a name="line.187"></a> |
| <FONT color="green">188</FONT> * in the INVALID state. After <code>detach</code> has been invoked,<a name="line.188"></a> |
| <FONT color="green">189</FONT> * calls to <code>nextNode</code> or <code>previousNode</code> will<a name="line.189"></a> |
| <FONT color="green">190</FONT> * raise a runtime exception.<a name="line.190"></a> |
| <FONT color="green">191</FONT> */<a name="line.191"></a> |
| <FONT color="green">192</FONT> public void detach();<a name="line.192"></a> |
| <FONT color="green">193</FONT> <a name="line.193"></a> |
| <FONT color="green">194</FONT> /**<a name="line.194"></a> |
| <FONT color="green">195</FONT> * Specify if it's OK for detach to release the iterator for reuse.<a name="line.195"></a> |
| <FONT color="green">196</FONT> * <a name="line.196"></a> |
| <FONT color="green">197</FONT> * @param allowRelease true if it is OK for detach to release this iterator <a name="line.197"></a> |
| <FONT color="green">198</FONT> * for pooling.<a name="line.198"></a> |
| <FONT color="green">199</FONT> */<a name="line.199"></a> |
| <FONT color="green">200</FONT> public void allowDetachToRelease(boolean allowRelease);<a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> /**<a name="line.202"></a> |
| <FONT color="green">203</FONT> * Get the current node in the iterator. Note that this differs from<a name="line.203"></a> |
| <FONT color="green">204</FONT> * the DOM's NodeIterator, where the current position lies between two<a name="line.204"></a> |
| <FONT color="green">205</FONT> * nodes (as part of the maintain-relative-position semantic).<a name="line.205"></a> |
| <FONT color="green">206</FONT> *<a name="line.206"></a> |
| <FONT color="green">207</FONT> * @return The current node handle, or -1.<a name="line.207"></a> |
| <FONT color="green">208</FONT> */<a name="line.208"></a> |
| <FONT color="green">209</FONT> public int getCurrentNode();<a name="line.209"></a> |
| <FONT color="green">210</FONT> <a name="line.210"></a> |
| <FONT color="green">211</FONT> /**<a name="line.211"></a> |
| <FONT color="green">212</FONT> * Tells if this NodeSetDTM is "fresh", in other words, if<a name="line.212"></a> |
| <FONT color="green">213</FONT> * the first nextNode() that is called will return the<a name="line.213"></a> |
| <FONT color="green">214</FONT> * first node in the set.<a name="line.214"></a> |
| <FONT color="green">215</FONT> *<a name="line.215"></a> |
| <FONT color="green">216</FONT> * @return true if the iteration of this list has not yet begun.<a name="line.216"></a> |
| <FONT color="green">217</FONT> */<a name="line.217"></a> |
| <FONT color="green">218</FONT> public boolean isFresh();<a name="line.218"></a> |
| <FONT color="green">219</FONT> <a name="line.219"></a> |
| <FONT color="green">220</FONT> //========= Random Access ==========<a name="line.220"></a> |
| <FONT color="green">221</FONT> <a name="line.221"></a> |
| <FONT color="green">222</FONT> /**<a name="line.222"></a> |
| <FONT color="green">223</FONT> * If setShouldCacheNodes(true) is called, then nodes will<a name="line.223"></a> |
| <FONT color="green">224</FONT> * be cached, enabling random access, and giving the ability to do <a name="line.224"></a> |
| <FONT color="green">225</FONT> * sorts and the like. They are not cached by default.<a name="line.225"></a> |
| <FONT color="green">226</FONT> *<a name="line.226"></a> |
| <FONT color="green">227</FONT> * %REVIEW% Shouldn't the other random-access methods throw an exception<a name="line.227"></a> |
| <FONT color="green">228</FONT> * if they're called on a DTMIterator with this flag set false?<a name="line.228"></a> |
| <FONT color="green">229</FONT> *<a name="line.229"></a> |
| <FONT color="green">230</FONT> * @param b true if the nodes should be cached.<a name="line.230"></a> |
| <FONT color="green">231</FONT> */<a name="line.231"></a> |
| <FONT color="green">232</FONT> public void setShouldCacheNodes(boolean b);<a name="line.232"></a> |
| <FONT color="green">233</FONT> <a name="line.233"></a> |
| <FONT color="green">234</FONT> /**<a name="line.234"></a> |
| <FONT color="green">235</FONT> * Tells if this iterator can have nodes added to it or set via <a name="line.235"></a> |
| <FONT color="green">236</FONT> * the <code>setItem(int node, int index)</code> method.<a name="line.236"></a> |
| <FONT color="green">237</FONT> * <a name="line.237"></a> |
| <FONT color="green">238</FONT> * @return True if the nodelist can be mutated.<a name="line.238"></a> |
| <FONT color="green">239</FONT> */<a name="line.239"></a> |
| <FONT color="green">240</FONT> public boolean isMutable();<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> /** Get the current position within the cached list, which is one<a name="line.242"></a> |
| <FONT color="green">243</FONT> * less than the next nextNode() call will retrieve. i.e. if you<a name="line.243"></a> |
| <FONT color="green">244</FONT> * call getCurrentPos() and the return is 0, the next fetch will<a name="line.244"></a> |
| <FONT color="green">245</FONT> * take place at index 1.<a name="line.245"></a> |
| <FONT color="green">246</FONT> *<a name="line.246"></a> |
| <FONT color="green">247</FONT> * @return The position of the iteration.<a name="line.247"></a> |
| <FONT color="green">248</FONT> */<a name="line.248"></a> |
| <FONT color="green">249</FONT> public int getCurrentPos();<a name="line.249"></a> |
| <FONT color="green">250</FONT> <a name="line.250"></a> |
| <FONT color="green">251</FONT> /**<a name="line.251"></a> |
| <FONT color="green">252</FONT> * If an index is requested, NodeSetDTM will call this method<a name="line.252"></a> |
| <FONT color="green">253</FONT> * to run the iterator to the index. By default this sets<a name="line.253"></a> |
| <FONT color="green">254</FONT> * m_next to the index. If the index argument is -1, this<a name="line.254"></a> |
| <FONT color="green">255</FONT> * signals that the iterator should be run to the end and<a name="line.255"></a> |
| <FONT color="green">256</FONT> * completely fill the cache.<a name="line.256"></a> |
| <FONT color="green">257</FONT> *<a name="line.257"></a> |
| <FONT color="green">258</FONT> * @param index The index to run to, or -1 if the iterator should be run<a name="line.258"></a> |
| <FONT color="green">259</FONT> * to the end.<a name="line.259"></a> |
| <FONT color="green">260</FONT> */<a name="line.260"></a> |
| <FONT color="green">261</FONT> public void runTo(int index);<a name="line.261"></a> |
| <FONT color="green">262</FONT> <a name="line.262"></a> |
| <FONT color="green">263</FONT> /**<a name="line.263"></a> |
| <FONT color="green">264</FONT> * Set the current position in the node set.<a name="line.264"></a> |
| <FONT color="green">265</FONT> * <a name="line.265"></a> |
| <FONT color="green">266</FONT> * @param i Must be a valid index.<a name="line.266"></a> |
| <FONT color="green">267</FONT> */<a name="line.267"></a> |
| <FONT color="green">268</FONT> public void setCurrentPos(int i);<a name="line.268"></a> |
| <FONT color="green">269</FONT> <a name="line.269"></a> |
| <FONT color="green">270</FONT> /**<a name="line.270"></a> |
| <FONT color="green">271</FONT> * Returns the <code>node handle</code> of an item in the collection. If<a name="line.271"></a> |
| <FONT color="green">272</FONT> * <code>index</code> is greater than or equal to the number of nodes in<a name="line.272"></a> |
| <FONT color="green">273</FONT> * the list, this returns <code>null</code>.<a name="line.273"></a> |
| <FONT color="green">274</FONT> *<a name="line.274"></a> |
| <FONT color="green">275</FONT> * @param index of the item.<a name="line.275"></a> |
| <FONT color="green">276</FONT> * @return The node handle at the <code>index</code>th position in the<a name="line.276"></a> |
| <FONT color="green">277</FONT> * <code>DTMIterator</code>, or <code>-1</code> if that is not a valid<a name="line.277"></a> |
| <FONT color="green">278</FONT> * index.<a name="line.278"></a> |
| <FONT color="green">279</FONT> */<a name="line.279"></a> |
| <FONT color="green">280</FONT> public int item(int index);<a name="line.280"></a> |
| <FONT color="green">281</FONT> <a name="line.281"></a> |
| <FONT color="green">282</FONT> /**<a name="line.282"></a> |
| <FONT color="green">283</FONT> * Sets the node at the specified index of this vector to be the<a name="line.283"></a> |
| <FONT color="green">284</FONT> * specified node. The previous component at that position is discarded.<a name="line.284"></a> |
| <FONT color="green">285</FONT> *<a name="line.285"></a> |
| <FONT color="green">286</FONT> * <p>The index must be a value greater than or equal to 0 and less<a name="line.286"></a> |
| <FONT color="green">287</FONT> * than the current size of the vector. <a name="line.287"></a> |
| <FONT color="green">288</FONT> * The iterator must be in cached mode.</p><a name="line.288"></a> |
| <FONT color="green">289</FONT> * <a name="line.289"></a> |
| <FONT color="green">290</FONT> * <p>Meant to be used for sorted iterators.</p><a name="line.290"></a> |
| <FONT color="green">291</FONT> *<a name="line.291"></a> |
| <FONT color="green">292</FONT> * @param node Node to set<a name="line.292"></a> |
| <FONT color="green">293</FONT> * @param index Index of where to set the node<a name="line.293"></a> |
| <FONT color="green">294</FONT> */<a name="line.294"></a> |
| <FONT color="green">295</FONT> public void setItem(int node, int index);<a name="line.295"></a> |
| <FONT color="green">296</FONT> <a name="line.296"></a> |
| <FONT color="green">297</FONT> /**<a name="line.297"></a> |
| <FONT color="green">298</FONT> * The number of nodes in the list. The range of valid child node indices<a name="line.298"></a> |
| <FONT color="green">299</FONT> * is 0 to <code>length-1</code> inclusive. Note that this requires running<a name="line.299"></a> |
| <FONT color="green">300</FONT> * the iterator to completion, and presumably filling the cache.<a name="line.300"></a> |
| <FONT color="green">301</FONT> *<a name="line.301"></a> |
| <FONT color="green">302</FONT> * @return The number of nodes in the list.<a name="line.302"></a> |
| <FONT color="green">303</FONT> */<a name="line.303"></a> |
| <FONT color="green">304</FONT> public int getLength();<a name="line.304"></a> |
| <FONT color="green">305</FONT> <a name="line.305"></a> |
| <FONT color="green">306</FONT> //=========== Cloning operations. ============<a name="line.306"></a> |
| <FONT color="green">307</FONT> <a name="line.307"></a> |
| <FONT color="green">308</FONT> /**<a name="line.308"></a> |
| <FONT color="green">309</FONT> * Get a cloned Iterator that is reset to the start of the iteration.<a name="line.309"></a> |
| <FONT color="green">310</FONT> *<a name="line.310"></a> |
| <FONT color="green">311</FONT> * @return A clone of this iteration that has been reset.<a name="line.311"></a> |
| <FONT color="green">312</FONT> *<a name="line.312"></a> |
| <FONT color="green">313</FONT> * @throws CloneNotSupportedException<a name="line.313"></a> |
| <FONT color="green">314</FONT> */<a name="line.314"></a> |
| <FONT color="green">315</FONT> public DTMIterator cloneWithReset() throws CloneNotSupportedException;<a name="line.315"></a> |
| <FONT color="green">316</FONT> <a name="line.316"></a> |
| <FONT color="green">317</FONT> /**<a name="line.317"></a> |
| <FONT color="green">318</FONT> * Get a clone of this iterator, but don't reset the iteration in the <a name="line.318"></a> |
| <FONT color="green">319</FONT> * process, so that it may be used from the current position.<a name="line.319"></a> |
| <FONT color="green">320</FONT> *<a name="line.320"></a> |
| <FONT color="green">321</FONT> * @return A clone of this object.<a name="line.321"></a> |
| <FONT color="green">322</FONT> *<a name="line.322"></a> |
| <FONT color="green">323</FONT> * @throws CloneNotSupportedException<a name="line.323"></a> |
| <FONT color="green">324</FONT> */<a name="line.324"></a> |
| <FONT color="green">325</FONT> public Object clone() throws CloneNotSupportedException;<a name="line.325"></a> |
| <FONT color="green">326</FONT> <a name="line.326"></a> |
| <FONT color="green">327</FONT> /**<a name="line.327"></a> |
| <FONT color="green">328</FONT> * Returns true if all the nodes in the iteration well be returned in document <a name="line.328"></a> |
| <FONT color="green">329</FONT> * order.<a name="line.329"></a> |
| <FONT color="green">330</FONT> * <a name="line.330"></a> |
| <FONT color="green">331</FONT> * @return true if all the nodes in the iteration well be returned in document <a name="line.331"></a> |
| <FONT color="green">332</FONT> * order.<a name="line.332"></a> |
| <FONT color="green">333</FONT> */<a name="line.333"></a> |
| <FONT color="green">334</FONT> public boolean isDocOrdered();<a name="line.334"></a> |
| <FONT color="green">335</FONT> <a name="line.335"></a> |
| <FONT color="green">336</FONT> /**<a name="line.336"></a> |
| <FONT color="green">337</FONT> * Returns the axis being iterated, if it is known.<a name="line.337"></a> |
| <FONT color="green">338</FONT> * <a name="line.338"></a> |
| <FONT color="green">339</FONT> * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple <a name="line.339"></a> |
| <FONT color="green">340</FONT> * types.<a name="line.340"></a> |
| <FONT color="green">341</FONT> */<a name="line.341"></a> |
| <FONT color="green">342</FONT> public int getAxis();<a name="line.342"></a> |
| <FONT color="green">343</FONT> <a name="line.343"></a> |
| <FONT color="green">344</FONT> }<a name="line.344"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |