blob: 414d8e3b98e5522d36c13912d9c93f5ca9603689 [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: ForwardPositionIterator.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.runtime.BasisLibrary;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xml.dtm.DTMAxisIterator;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.dtm.ref.DTMAxisIteratorBase;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * This iterator is a wrapper that always returns the position of<a name="line.29"></a>
<FONT color="green">030</FONT> * a node in document order. It is needed for the case where <a name="line.30"></a>
<FONT color="green">031</FONT> * a call to position() occurs in the context of an XSLT element<a name="line.31"></a>
<FONT color="green">032</FONT> * such as xsl:for-each, xsl:apply-templates, etc. <a name="line.32"></a>
<FONT color="green">033</FONT> *<a name="line.33"></a>
<FONT color="green">034</FONT> * The getPosition() methods in DTMAxisIterators defined<a name="line.34"></a>
<FONT color="green">035</FONT> * in DTMDefaultBaseIterators always return the position<a name="line.35"></a>
<FONT color="green">036</FONT> * in document order, which is backwards for XPath in the<a name="line.36"></a>
<FONT color="green">037</FONT> * case of the ancestor, ancestor-or-self, previous and<a name="line.37"></a>
<FONT color="green">038</FONT> * previous-sibling.<a name="line.38"></a>
<FONT color="green">039</FONT> *<a name="line.39"></a>
<FONT color="green">040</FONT> * XSLTC implements position() with the<a name="line.40"></a>
<FONT color="green">041</FONT> * BasisLibrary.positionF() method, and uses the<a name="line.41"></a>
<FONT color="green">042</FONT> * DTMAxisIterator.isReverse() method to determine<a name="line.42"></a>
<FONT color="green">043</FONT> * whether the result of getPosition() should be<a name="line.43"></a>
<FONT color="green">044</FONT> * interpreted as being equal to position().<a name="line.44"></a>
<FONT color="green">045</FONT> * But when the expression appears in apply-templates of<a name="line.45"></a>
<FONT color="green">046</FONT> * for-each, the position() function operates in document<a name="line.46"></a>
<FONT color="green">047</FONT> * order.<a name="line.47"></a>
<FONT color="green">048</FONT> *<a name="line.48"></a>
<FONT color="green">049</FONT> * The only effect of the ForwardPositionIterator is to force<a name="line.49"></a>
<FONT color="green">050</FONT> * the result of isReverse() to false, so that<a name="line.50"></a>
<FONT color="green">051</FONT> * BasisLibrary.positionF() calculates position() in a way<a name="line.51"></a>
<FONT color="green">052</FONT> * that's consistent with the context in which the<a name="line.52"></a>
<FONT color="green">053</FONT> * iterator is being used."<a name="line.53"></a>
<FONT color="green">054</FONT> *<a name="line.54"></a>
<FONT color="green">055</FONT> * (Apparently the correction of isReverse() occurs<a name="line.55"></a>
<FONT color="green">056</FONT> * implicitly, by inheritance. This class also appears<a name="line.56"></a>
<FONT color="green">057</FONT> * to maintain its own position counter, which seems<a name="line.57"></a>
<FONT color="green">058</FONT> * redundant.)<a name="line.58"></a>
<FONT color="green">059</FONT> *<a name="line.59"></a>
<FONT color="green">060</FONT> * @deprecated This class exists only for backwards compatibility with old<a name="line.60"></a>
<FONT color="green">061</FONT> * translets. New code should not reference it.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> public final class ForwardPositionIterator extends DTMAxisIteratorBase {<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> private DTMAxisIterator _source;<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> public ForwardPositionIterator(DTMAxisIterator source) {<a name="line.67"></a>
<FONT color="green">068</FONT> _source = source;<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> public DTMAxisIterator cloneIterator() {<a name="line.71"></a>
<FONT color="green">072</FONT> try {<a name="line.72"></a>
<FONT color="green">073</FONT> final ForwardPositionIterator clone = <a name="line.73"></a>
<FONT color="green">074</FONT> (ForwardPositionIterator) super.clone();<a name="line.74"></a>
<FONT color="green">075</FONT> clone._source = _source.cloneIterator();<a name="line.75"></a>
<FONT color="green">076</FONT> clone._isRestartable = false;<a name="line.76"></a>
<FONT color="green">077</FONT> return clone.reset();<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> catch (CloneNotSupportedException e) {<a name="line.79"></a>
<FONT color="green">080</FONT> BasisLibrary.runTimeError(BasisLibrary.ITERATOR_CLONE_ERR,<a name="line.80"></a>
<FONT color="green">081</FONT> e.toString());<a name="line.81"></a>
<FONT color="green">082</FONT> return null;<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> <a name="line.85"></a>
<FONT color="green">086</FONT> public int next() {<a name="line.86"></a>
<FONT color="green">087</FONT> return returnNode(_source.next());<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> public DTMAxisIterator setStartNode(int node) {<a name="line.90"></a>
<FONT color="green">091</FONT> _source.setStartNode(node);<a name="line.91"></a>
<FONT color="green">092</FONT> return this;<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> <a name="line.94"></a>
<FONT color="green">095</FONT> public DTMAxisIterator reset() {<a name="line.95"></a>
<FONT color="green">096</FONT> _source.reset();<a name="line.96"></a>
<FONT color="green">097</FONT> return resetPosition();<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> public void setMark() {<a name="line.100"></a>
<FONT color="green">101</FONT> _source.setMark();<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> public void gotoMark() {<a name="line.104"></a>
<FONT color="green">105</FONT> _source.gotoMark();<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> }<a name="line.107"></a>
</PRE>
</BODY>
</HTML>