| <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: ContextNodeList.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xpath.axes;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.w3c.dom.Node;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.w3c.dom.traversal.NodeIterator;<a name="line.24"></a> |
| <FONT color="green">025</FONT> <a name="line.25"></a> |
| <FONT color="green">026</FONT> /**<a name="line.26"></a> |
| <FONT color="green">027</FONT> * Classes who implement this interface can be a<a name="line.27"></a> |
| <FONT color="green">028</FONT> * <a href="http://www.w3.org/TR/xslt#dt-current-node-list">current node list</a>,<a name="line.28"></a> |
| <FONT color="green">029</FONT> * also refered to here as a <term>context node list</term>.<a name="line.29"></a> |
| <FONT color="green">030</FONT> * @xsl.usage advanced<a name="line.30"></a> |
| <FONT color="green">031</FONT> */<a name="line.31"></a> |
| <FONT color="green">032</FONT> public interface ContextNodeList<a name="line.32"></a> |
| <FONT color="green">033</FONT> {<a name="line.33"></a> |
| <FONT color="green">034</FONT> <a name="line.34"></a> |
| <FONT color="green">035</FONT> /**<a name="line.35"></a> |
| <FONT color="green">036</FONT> * Get the <a href="http://www.w3.org/TR/xslt#dt-current-node">current node</a>.<a name="line.36"></a> |
| <FONT color="green">037</FONT> *<a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * @return The current node, or null.<a name="line.39"></a> |
| <FONT color="green">040</FONT> */<a name="line.40"></a> |
| <FONT color="green">041</FONT> public Node getCurrentNode();<a name="line.41"></a> |
| <FONT color="green">042</FONT> <a name="line.42"></a> |
| <FONT color="green">043</FONT> /**<a name="line.43"></a> |
| <FONT color="green">044</FONT> * Get the current position, which is one less than<a name="line.44"></a> |
| <FONT color="green">045</FONT> * the next nextNode() call will retrieve. i.e. if<a name="line.45"></a> |
| <FONT color="green">046</FONT> * you call getCurrentPos() and the return is 0, the next<a name="line.46"></a> |
| <FONT color="green">047</FONT> * fetch will take place at index 1.<a name="line.47"></a> |
| <FONT color="green">048</FONT> *<a name="line.48"></a> |
| <FONT color="green">049</FONT> * @return The position of the<a name="line.49"></a> |
| <FONT color="green">050</FONT> * <a href="http://www.w3.org/TR/xslt#dt-current-node">current node</a><a name="line.50"></a> |
| <FONT color="green">051</FONT> * in the <a href="http://www.w3.org/TR/xslt#dt-current-node-list">current node list</a>.<a name="line.51"></a> |
| <FONT color="green">052</FONT> */<a name="line.52"></a> |
| <FONT color="green">053</FONT> public int getCurrentPos();<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> /**<a name="line.55"></a> |
| <FONT color="green">056</FONT> * Reset the iterator.<a name="line.56"></a> |
| <FONT color="green">057</FONT> */<a name="line.57"></a> |
| <FONT color="green">058</FONT> public void reset();<a name="line.58"></a> |
| <FONT color="green">059</FONT> <a name="line.59"></a> |
| <FONT color="green">060</FONT> /**<a name="line.60"></a> |
| <FONT color="green">061</FONT> * If setShouldCacheNodes(true) is called, then nodes will<a name="line.61"></a> |
| <FONT color="green">062</FONT> * be cached. They are not cached by default.<a name="line.62"></a> |
| <FONT color="green">063</FONT> *<a name="line.63"></a> |
| <FONT color="green">064</FONT> * @param b true if the nodes should be cached.<a name="line.64"></a> |
| <FONT color="green">065</FONT> */<a name="line.65"></a> |
| <FONT color="green">066</FONT> public void setShouldCacheNodes(boolean b);<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> * If an index is requested, NodeSetDTM will call this method<a name="line.69"></a> |
| <FONT color="green">070</FONT> * to run the iterator to the index. By default this sets<a name="line.70"></a> |
| <FONT color="green">071</FONT> * m_next to the index. If the index argument is -1, this<a name="line.71"></a> |
| <FONT color="green">072</FONT> * signals that the iterator should be run to the end.<a name="line.72"></a> |
| <FONT color="green">073</FONT> *<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @param index The index to run to, or -1 if the iterator should be run<a name="line.74"></a> |
| <FONT color="green">075</FONT> * to the end.<a name="line.75"></a> |
| <FONT color="green">076</FONT> */<a name="line.76"></a> |
| <FONT color="green">077</FONT> public void runTo(int index);<a name="line.77"></a> |
| <FONT color="green">078</FONT> <a name="line.78"></a> |
| <FONT color="green">079</FONT> /**<a name="line.79"></a> |
| <FONT color="green">080</FONT> * Set the current position in the node set.<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @param i Must be a valid index.<a name="line.81"></a> |
| <FONT color="green">082</FONT> */<a name="line.82"></a> |
| <FONT color="green">083</FONT> public void setCurrentPos(int i);<a name="line.83"></a> |
| <FONT color="green">084</FONT> <a name="line.84"></a> |
| <FONT color="green">085</FONT> /**<a name="line.85"></a> |
| <FONT color="green">086</FONT> * Get the length of the list.<a name="line.86"></a> |
| <FONT color="green">087</FONT> *<a name="line.87"></a> |
| <FONT color="green">088</FONT> * @return The number of nodes in this node list.<a name="line.88"></a> |
| <FONT color="green">089</FONT> */<a name="line.89"></a> |
| <FONT color="green">090</FONT> public int size();<a name="line.90"></a> |
| <FONT color="green">091</FONT> <a name="line.91"></a> |
| <FONT color="green">092</FONT> /**<a name="line.92"></a> |
| <FONT color="green">093</FONT> * Tells if this NodeSetDTM is "fresh", in other words, if<a name="line.93"></a> |
| <FONT color="green">094</FONT> * the first nextNode() that is called will return the<a name="line.94"></a> |
| <FONT color="green">095</FONT> * first node in the set.<a name="line.95"></a> |
| <FONT color="green">096</FONT> *<a name="line.96"></a> |
| <FONT color="green">097</FONT> * @return true if the iteration of this list has not yet begun.<a name="line.97"></a> |
| <FONT color="green">098</FONT> */<a name="line.98"></a> |
| <FONT color="green">099</FONT> public boolean isFresh();<a name="line.99"></a> |
| <FONT color="green">100</FONT> <a name="line.100"></a> |
| <FONT color="green">101</FONT> /**<a name="line.101"></a> |
| <FONT color="green">102</FONT> * Get a cloned Iterator that is reset to the start of the iteration.<a name="line.102"></a> |
| <FONT color="green">103</FONT> *<a name="line.103"></a> |
| <FONT color="green">104</FONT> * @return A clone of this iteration that has been reset.<a name="line.104"></a> |
| <FONT color="green">105</FONT> *<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @throws CloneNotSupportedException<a name="line.106"></a> |
| <FONT color="green">107</FONT> */<a name="line.107"></a> |
| <FONT color="green">108</FONT> public NodeIterator cloneWithReset() throws CloneNotSupportedException;<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> /**<a name="line.110"></a> |
| <FONT color="green">111</FONT> * Get a clone of this iterator. Be aware that this operation may be<a name="line.111"></a> |
| <FONT color="green">112</FONT> * somewhat expensive.<a name="line.112"></a> |
| <FONT color="green">113</FONT> *<a name="line.113"></a> |
| <FONT color="green">114</FONT> *<a name="line.114"></a> |
| <FONT color="green">115</FONT> * @return A clone of this object.<a name="line.115"></a> |
| <FONT color="green">116</FONT> *<a name="line.116"></a> |
| <FONT color="green">117</FONT> * @throws CloneNotSupportedException<a name="line.117"></a> |
| <FONT color="green">118</FONT> */<a name="line.118"></a> |
| <FONT color="green">119</FONT> public Object clone() throws CloneNotSupportedException;<a name="line.119"></a> |
| <FONT color="green">120</FONT> <a name="line.120"></a> |
| <FONT color="green">121</FONT> /**<a name="line.121"></a> |
| <FONT color="green">122</FONT> * Get the index of the last node in this list.<a name="line.122"></a> |
| <FONT color="green">123</FONT> *<a name="line.123"></a> |
| <FONT color="green">124</FONT> *<a name="line.124"></a> |
| <FONT color="green">125</FONT> * @return the index of the last node in this list.<a name="line.125"></a> |
| <FONT color="green">126</FONT> */<a name="line.126"></a> |
| <FONT color="green">127</FONT> public int getLast();<a name="line.127"></a> |
| <FONT color="green">128</FONT> <a name="line.128"></a> |
| <FONT color="green">129</FONT> /**<a name="line.129"></a> |
| <FONT color="green">130</FONT> * Set the index of the last node in this list.<a name="line.130"></a> |
| <FONT color="green">131</FONT> *<a name="line.131"></a> |
| <FONT color="green">132</FONT> *<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @param last the index of the last node in this list.<a name="line.133"></a> |
| <FONT color="green">134</FONT> */<a name="line.134"></a> |
| <FONT color="green">135</FONT> public void setLast(int last);<a name="line.135"></a> |
| <FONT color="green">136</FONT> }<a name="line.136"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
