Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / xsltc / dom / NodeIteratorBase.html
blob: cf8506d50fc98fb88fb0cc4555b62da5887032ec [file] [log] [blame]
<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: NodeIteratorBase.java 468651 2006-10-28 07:04:25Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xalan.xsltc.dom;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xalan.xsltc.NodeIterator;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xalan.xsltc.runtime.BasisLibrary;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * @author Jacek Ambroziak<a name="line.28"></a>
<FONT color="green">029</FONT> * @author Santiago Pericas-Geertsen<a name="line.29"></a>
<FONT color="green">030</FONT> * @author Morten Jorgensen<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public abstract class NodeIteratorBase implements NodeIterator {<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> * Cached computed value of last().<a name="line.35"></a>
<FONT color="green">036</FONT> */<a name="line.36"></a>
<FONT color="green">037</FONT> protected int _last = -1;<a name="line.37"></a>
<FONT color="green">038</FONT> <a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Value of position() in this iterator. Incremented in<a name="line.40"></a>
<FONT color="green">041</FONT> * returnNode().<a name="line.41"></a>
<FONT color="green">042</FONT> */<a name="line.42"></a>
<FONT color="green">043</FONT> protected int _position = 0;<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /**<a name="line.45"></a>
<FONT color="green">046</FONT> * Store node in call to setMark().<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> protected int _markedNode;<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * Store node in call to setStartNode().<a name="line.51"></a>
<FONT color="green">052</FONT> */<a name="line.52"></a>
<FONT color="green">053</FONT> protected int _startNode = NodeIterator.END;<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> * Flag indicating if "self" should be returned.<a name="line.56"></a>
<FONT color="green">057</FONT> */<a name="line.57"></a>
<FONT color="green">058</FONT> protected boolean _includeSelf = false;<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> * Flag indicating if iterator can be restarted.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> protected boolean _isRestartable = true;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> /**<a name="line.65"></a>
<FONT color="green">066</FONT> * Setter for _isRestartable flag. <a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> public void setRestartable(boolean isRestartable) {<a name="line.68"></a>
<FONT color="green">069</FONT> _isRestartable = isRestartable;<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> /**<a name="line.72"></a>
<FONT color="green">073</FONT> * Initialize iterator using a node. If iterator is not<a name="line.73"></a>
<FONT color="green">074</FONT> * restartable, then do nothing. If node is equal to END then<a name="line.74"></a>
<FONT color="green">075</FONT> * subsequent calls to next() must return END.<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> abstract public NodeIterator setStartNode(int node);<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> * Reset this iterator using state from last call to<a name="line.80"></a>
<FONT color="green">081</FONT> * setStartNode().<a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> public NodeIterator reset() {<a name="line.83"></a>
<FONT color="green">084</FONT> final boolean temp = _isRestartable;<a name="line.84"></a>
<FONT color="green">085</FONT> _isRestartable = true;<a name="line.85"></a>
<FONT color="green">086</FONT> // Must adjust _startNode if self is included<a name="line.86"></a>
<FONT color="green">087</FONT> setStartNode(_includeSelf ? _startNode + 1 : _startNode);<a name="line.87"></a>
<FONT color="green">088</FONT> _isRestartable = temp;<a name="line.88"></a>
<FONT color="green">089</FONT> return this;<a name="line.89"></a>
<FONT color="green">090</FONT> }<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> * Setter for _includeSelf flag.<a name="line.93"></a>
<FONT color="green">094</FONT> */<a name="line.94"></a>
<FONT color="green">095</FONT> public NodeIterator includeSelf() {<a name="line.95"></a>
<FONT color="green">096</FONT> _includeSelf = true;<a name="line.96"></a>
<FONT color="green">097</FONT> return this;<a name="line.97"></a>
<FONT color="green">098</FONT> }<a name="line.98"></a>
<FONT color="green">099</FONT> <a name="line.99"></a>
<FONT color="green">100</FONT> /**<a name="line.100"></a>
<FONT color="green">101</FONT> * Default implementation of getLast(). Stores current position<a name="line.101"></a>
<FONT color="green">102</FONT> * and current node, resets the iterator, counts all nodes and<a name="line.102"></a>
<FONT color="green">103</FONT> * restores iterator to original state.<a name="line.103"></a>
<FONT color="green">104</FONT> */<a name="line.104"></a>
<FONT color="green">105</FONT> public int getLast() {<a name="line.105"></a>
<FONT color="green">106</FONT> if (_last == -1) {<a name="line.106"></a>
<FONT color="green">107</FONT> final int temp = _position;<a name="line.107"></a>
<FONT color="green">108</FONT> setMark();<a name="line.108"></a>
<FONT color="green">109</FONT> reset();<a name="line.109"></a>
<FONT color="green">110</FONT> do {<a name="line.110"></a>
<FONT color="green">111</FONT> _last++;<a name="line.111"></a>
<FONT color="green">112</FONT> } while (next() != END);<a name="line.112"></a>
<FONT color="green">113</FONT> gotoMark();<a name="line.113"></a>
<FONT color="green">114</FONT> _position = temp;<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> return _last;<a name="line.116"></a>
<FONT color="green">117</FONT> }<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> /**<a name="line.119"></a>
<FONT color="green">120</FONT> * Returns the position() in this iterator.<a name="line.120"></a>
<FONT color="green">121</FONT> */<a name="line.121"></a>
<FONT color="green">122</FONT> public int getPosition() {<a name="line.122"></a>
<FONT color="green">123</FONT> return _position == 0 ? 1 : _position;<a name="line.123"></a>
<FONT color="green">124</FONT> }<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> * Indicates if position in this iterator is computed in reverse<a name="line.127"></a>
<FONT color="green">128</FONT> * document order. Note that nodes are always returned in document<a name="line.128"></a>
<FONT color="green">129</FONT> * order.<a name="line.129"></a>
<FONT color="green">130</FONT> */<a name="line.130"></a>
<FONT color="green">131</FONT> public boolean isReverse() {<a name="line.131"></a>
<FONT color="green">132</FONT> return false;<a name="line.132"></a>
<FONT color="green">133</FONT> }<a name="line.133"></a>
<FONT color="green">134</FONT> <a name="line.134"></a>
<FONT color="green">135</FONT> /**<a name="line.135"></a>
<FONT color="green">136</FONT> * Clones and resets this iterator. Note that the cloned iterator is <a name="line.136"></a>
<FONT color="green">137</FONT> * not restartable. This is because cloning is needed for variable <a name="line.137"></a>
<FONT color="green">138</FONT> * references, and the context node of the original variable <a name="line.138"></a>
<FONT color="green">139</FONT> * declaration must be preserved.<a name="line.139"></a>
<FONT color="green">140</FONT> */<a name="line.140"></a>
<FONT color="green">141</FONT> public NodeIterator cloneIterator() {<a name="line.141"></a>
<FONT color="green">142</FONT> try {<a name="line.142"></a>
<FONT color="green">143</FONT> final NodeIteratorBase clone = (NodeIteratorBase)super.clone();<a name="line.143"></a>
<FONT color="green">144</FONT> clone._isRestartable = false;<a name="line.144"></a>
<FONT color="green">145</FONT> return clone.reset();<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> catch (CloneNotSupportedException e) {<a name="line.147"></a>
<FONT color="green">148</FONT> BasisLibrary.runTimeError(BasisLibrary.ITERATOR_CLONE_ERR,<a name="line.148"></a>
<FONT color="green">149</FONT> e.toString());<a name="line.149"></a>
<FONT color="green">150</FONT> return null;<a name="line.150"></a>
<FONT color="green">151</FONT> }<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> /**<a name="line.154"></a>
<FONT color="green">155</FONT> * Utility method that increments position and returns its<a name="line.155"></a>
<FONT color="green">156</FONT> * argument.<a name="line.156"></a>
<FONT color="green">157</FONT> */<a name="line.157"></a>
<FONT color="green">158</FONT> protected final int returnNode(final int node) {<a name="line.158"></a>
<FONT color="green">159</FONT> _position++;<a name="line.159"></a>
<FONT color="green">160</FONT> return node;<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> <a name="line.162"></a>
<FONT color="green">163</FONT> /**<a name="line.163"></a>
<FONT color="green">164</FONT> * Reset the position in this iterator.<a name="line.164"></a>
<FONT color="green">165</FONT> */<a name="line.165"></a>
<FONT color="green">166</FONT> protected final NodeIterator resetPosition() {<a name="line.166"></a>
<FONT color="green">167</FONT> _position = 0;<a name="line.167"></a>
<FONT color="green">168</FONT> return this;<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
</PRE>
</BODY>
</HTML>