blob: bf2524bf58597605940629a7ea7d999dddcfc4c4 [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: ChildTestIterator.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.apache.xml.dtm.Axis;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xml.dtm.DTM;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xml.dtm.DTMAxisTraverser;<a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xpath.compiler.Compiler;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * This class implements an optimized iterator for<a name="line.30"></a>
<FONT color="green">031</FONT> * children patterns that have a node test, and possibly a predicate.<a name="line.31"></a>
<FONT color="green">032</FONT> * @see org.apache.xpath.axes.BasicTestIterator<a name="line.32"></a>
<FONT color="green">033</FONT> * @xsl.usage advanced<a name="line.33"></a>
<FONT color="green">034</FONT> */<a name="line.34"></a>
<FONT color="green">035</FONT> public class ChildTestIterator extends BasicTestIterator<a name="line.35"></a>
<FONT color="green">036</FONT> {<a name="line.36"></a>
<FONT color="green">037</FONT> static final long serialVersionUID = -7936835957960705722L;<a name="line.37"></a>
<FONT color="green">038</FONT> /** The traverser to use to navigate over the descendants. */<a name="line.38"></a>
<FONT color="green">039</FONT> transient protected DTMAxisTraverser m_traverser;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /** The extended type ID, not set until setRoot. */<a name="line.41"></a>
<FONT color="green">042</FONT> // protected int m_extendedTypeID;<a name="line.42"></a>
<FONT color="green">043</FONT> <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> * Create a ChildTestIterator object.<a name="line.46"></a>
<FONT color="green">047</FONT> *<a name="line.47"></a>
<FONT color="green">048</FONT> * @param compiler A reference to the Compiler that contains the op map.<a name="line.48"></a>
<FONT color="green">049</FONT> * @param opPos The position within the op map, which contains the<a name="line.49"></a>
<FONT color="green">050</FONT> * location path expression for this itterator.<a name="line.50"></a>
<FONT color="green">051</FONT> *<a name="line.51"></a>
<FONT color="green">052</FONT> * @throws javax.xml.transform.TransformerException<a name="line.52"></a>
<FONT color="green">053</FONT> */<a name="line.53"></a>
<FONT color="green">054</FONT> ChildTestIterator(Compiler compiler, int opPos, int analysis)<a name="line.54"></a>
<FONT color="green">055</FONT> throws javax.xml.transform.TransformerException<a name="line.55"></a>
<FONT color="green">056</FONT> {<a name="line.56"></a>
<FONT color="green">057</FONT> super(compiler, opPos, analysis);<a name="line.57"></a>
<FONT color="green">058</FONT> }<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> * Create a ChildTestIterator object.<a name="line.61"></a>
<FONT color="green">062</FONT> *<a name="line.62"></a>
<FONT color="green">063</FONT> * @param traverser Traverser that tells how the KeyIterator is to be handled.<a name="line.63"></a>
<FONT color="green">064</FONT> *<a name="line.64"></a>
<FONT color="green">065</FONT> * @throws javax.xml.transform.TransformerException<a name="line.65"></a>
<FONT color="green">066</FONT> */<a name="line.66"></a>
<FONT color="green">067</FONT> public ChildTestIterator(DTMAxisTraverser traverser)<a name="line.67"></a>
<FONT color="green">068</FONT> {<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> super(null);<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> m_traverser = traverser;<a name="line.72"></a>
<FONT color="green">073</FONT> }<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> /**<a name="line.75"></a>
<FONT color="green">076</FONT> * Get the next node via getNextXXX. Bottlenecked for derived class override.<a name="line.76"></a>
<FONT color="green">077</FONT> * @return The next node on the axis, or DTM.NULL.<a name="line.77"></a>
<FONT color="green">078</FONT> */<a name="line.78"></a>
<FONT color="green">079</FONT> protected int getNextNode()<a name="line.79"></a>
<FONT color="green">080</FONT> { <a name="line.80"></a>
<FONT color="green">081</FONT> if(true /* 0 == m_extendedTypeID */)<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> m_lastFetched = (DTM.NULL == m_lastFetched)<a name="line.83"></a>
<FONT color="green">084</FONT> ? m_traverser.first(m_context)<a name="line.84"></a>
<FONT color="green">085</FONT> : m_traverser.next(m_context, m_lastFetched);<a name="line.85"></a>
<FONT color="green">086</FONT> }<a name="line.86"></a>
<FONT color="green">087</FONT> // else<a name="line.87"></a>
<FONT color="green">088</FONT> // {<a name="line.88"></a>
<FONT color="green">089</FONT> // m_lastFetched = (DTM.NULL == m_lastFetched)<a name="line.89"></a>
<FONT color="green">090</FONT> // ? m_traverser.first(m_context, m_extendedTypeID)<a name="line.90"></a>
<FONT color="green">091</FONT> // : m_traverser.next(m_context, m_lastFetched, <a name="line.91"></a>
<FONT color="green">092</FONT> // m_extendedTypeID);<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> return m_lastFetched;<a name="line.95"></a>
<FONT color="green">096</FONT> }<a name="line.96"></a>
<FONT color="green">097</FONT> <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> * Get a cloned Iterator that is reset to the beginning<a name="line.100"></a>
<FONT color="green">101</FONT> * of the query.<a name="line.101"></a>
<FONT color="green">102</FONT> * <a name="line.102"></a>
<FONT color="green">103</FONT> * @return A cloned NodeIterator set of the start of the query.<a name="line.103"></a>
<FONT color="green">104</FONT> * <a name="line.104"></a>
<FONT color="green">105</FONT> * @throws CloneNotSupportedException<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> public DTMIterator cloneWithReset() throws CloneNotSupportedException<a name="line.107"></a>
<FONT color="green">108</FONT> {<a name="line.108"></a>
<FONT color="green">109</FONT> <a name="line.109"></a>
<FONT color="green">110</FONT> ChildTestIterator clone = (ChildTestIterator) super.cloneWithReset();<a name="line.110"></a>
<FONT color="green">111</FONT> clone.m_traverser = m_traverser;<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> return clone;<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> /**<a name="line.117"></a>
<FONT color="green">118</FONT> * Initialize the context values for this expression<a name="line.118"></a>
<FONT color="green">119</FONT> * after it is cloned.<a name="line.119"></a>
<FONT color="green">120</FONT> *<a name="line.120"></a>
<FONT color="green">121</FONT> * @param context The XPath runtime context for this<a name="line.121"></a>
<FONT color="green">122</FONT> * transformation.<a name="line.122"></a>
<FONT color="green">123</FONT> */<a name="line.123"></a>
<FONT color="green">124</FONT> public void setRoot(int context, Object environment)<a name="line.124"></a>
<FONT color="green">125</FONT> {<a name="line.125"></a>
<FONT color="green">126</FONT> super.setRoot(context, environment);<a name="line.126"></a>
<FONT color="green">127</FONT> m_traverser = m_cdtm.getAxisTraverser(Axis.CHILD);<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> // String localName = getLocalName();<a name="line.129"></a>
<FONT color="green">130</FONT> // String namespace = getNamespace();<a name="line.130"></a>
<FONT color="green">131</FONT> // int what = m_whatToShow;<a name="line.131"></a>
<FONT color="green">132</FONT> // // System.out.println("what: ");<a name="line.132"></a>
<FONT color="green">133</FONT> // // NodeTest.debugWhatToShow(what);<a name="line.133"></a>
<FONT color="green">134</FONT> // if(DTMFilter.SHOW_ALL == what ||<a name="line.134"></a>
<FONT color="green">135</FONT> // ((DTMFilter.SHOW_ELEMENT &amp; what) == 0)<a name="line.135"></a>
<FONT color="green">136</FONT> // || localName == NodeTest.WILD<a name="line.136"></a>
<FONT color="green">137</FONT> // || namespace == NodeTest.WILD)<a name="line.137"></a>
<FONT color="green">138</FONT> // {<a name="line.138"></a>
<FONT color="green">139</FONT> // m_extendedTypeID = 0;<a name="line.139"></a>
<FONT color="green">140</FONT> // }<a name="line.140"></a>
<FONT color="green">141</FONT> // else<a name="line.141"></a>
<FONT color="green">142</FONT> // {<a name="line.142"></a>
<FONT color="green">143</FONT> // int type = getNodeTypeTest(what);<a name="line.143"></a>
<FONT color="green">144</FONT> // m_extendedTypeID = m_cdtm.getExpandedTypeID(namespace, localName, type);<a name="line.144"></a>
<FONT color="green">145</FONT> // }<a name="line.145"></a>
<FONT color="green">146</FONT> <a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * Returns the axis being iterated, if it is known.<a name="line.150"></a>
<FONT color="green">151</FONT> * <a name="line.151"></a>
<FONT color="green">152</FONT> * @return Axis.CHILD, etc., or -1 if the axis is not known or is of multiple <a name="line.152"></a>
<FONT color="green">153</FONT> * types.<a name="line.153"></a>
<FONT color="green">154</FONT> */<a name="line.154"></a>
<FONT color="green">155</FONT> public int getAxis()<a name="line.155"></a>
<FONT color="green">156</FONT> {<a name="line.156"></a>
<FONT color="green">157</FONT> return org.apache.xml.dtm.Axis.CHILD;<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> /**<a name="line.160"></a>
<FONT color="green">161</FONT> * Detaches the iterator from the set which it iterated over, releasing<a name="line.161"></a>
<FONT color="green">162</FONT> * any computational resources and placing the iterator in the INVALID<a name="line.162"></a>
<FONT color="green">163</FONT> * state. After&lt;code&gt;detach&lt;/code&gt; has been invoked, calls to<a name="line.163"></a>
<FONT color="green">164</FONT> * &lt;code&gt;nextNode&lt;/code&gt; or&lt;code&gt;previousNode&lt;/code&gt; will raise the<a name="line.164"></a>
<FONT color="green">165</FONT> * exception INVALID_STATE_ERR.<a name="line.165"></a>
<FONT color="green">166</FONT> */<a name="line.166"></a>
<FONT color="green">167</FONT> public void detach()<a name="line.167"></a>
<FONT color="green">168</FONT> { <a name="line.168"></a>
<FONT color="green">169</FONT> if(m_allowDetach)<a name="line.169"></a>
<FONT color="green">170</FONT> {<a name="line.170"></a>
<FONT color="green">171</FONT> m_traverser = null;<a name="line.171"></a>
<FONT color="green">172</FONT> <a name="line.172"></a>
<FONT color="green">173</FONT> // Always call the superclass detach last!<a name="line.173"></a>
<FONT color="green">174</FONT> super.detach();<a name="line.174"></a>
<FONT color="green">175</FONT> }<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> }<a name="line.178"></a>
</PRE>
</BODY>
</HTML>