Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xpath / axes / WalkingIteratorSorted.html
blob: 8239c5f2ee96c6ee773eded919f79aaea7bcb3b9 [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: WalkingIteratorSorted.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.utils.PrefixResolver;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xpath.compiler.Compiler;<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> * This class iterates over set of nodes that needs to be sorted.<a name="line.28"></a>
<FONT color="green">029</FONT> * @xsl.usage internal<a name="line.29"></a>
<FONT color="green">030</FONT> */<a name="line.30"></a>
<FONT color="green">031</FONT> public class WalkingIteratorSorted extends WalkingIterator<a name="line.31"></a>
<FONT color="green">032</FONT> {<a name="line.32"></a>
<FONT color="green">033</FONT> static final long serialVersionUID = -4512512007542368213L;<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> // /** True if the nodes will be found in document order */<a name="line.35"></a>
<FONT color="green">036</FONT> // protected boolean m_inNaturalOrder = false;<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /** True if the nodes will be found in document order, and this can <a name="line.38"></a>
<FONT color="green">039</FONT> * be determined statically. */<a name="line.39"></a>
<FONT color="green">040</FONT> protected boolean m_inNaturalOrderStatic = false;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * Create a WalkingIteratorSorted object.<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @param nscontext The namespace context for this iterator,<a name="line.45"></a>
<FONT color="green">046</FONT> * should be OK if null.<a name="line.46"></a>
<FONT color="green">047</FONT> */<a name="line.47"></a>
<FONT color="green">048</FONT> public WalkingIteratorSorted(PrefixResolver nscontext)<a name="line.48"></a>
<FONT color="green">049</FONT> {<a name="line.49"></a>
<FONT color="green">050</FONT> super(nscontext);<a name="line.50"></a>
<FONT color="green">051</FONT> }<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * Create a WalkingIterator iterator, including creation<a name="line.54"></a>
<FONT color="green">055</FONT> * of step walkers from the opcode list, and call back<a name="line.55"></a>
<FONT color="green">056</FONT> * into the Compiler to create predicate expressions.<a name="line.56"></a>
<FONT color="green">057</FONT> *<a name="line.57"></a>
<FONT color="green">058</FONT> * @param compiler The Compiler which is creating<a name="line.58"></a>
<FONT color="green">059</FONT> * this expression.<a name="line.59"></a>
<FONT color="green">060</FONT> * @param opPos The position of this iterator in the<a name="line.60"></a>
<FONT color="green">061</FONT> * opcode list from the compiler.<a name="line.61"></a>
<FONT color="green">062</FONT> * @param shouldLoadWalkers True if walkers should be<a name="line.62"></a>
<FONT color="green">063</FONT> * loaded, or false if this is a derived iterator and<a name="line.63"></a>
<FONT color="green">064</FONT> * it doesn't wish to load child walkers.<a name="line.64"></a>
<FONT color="green">065</FONT> *<a name="line.65"></a>
<FONT color="green">066</FONT> * @throws javax.xml.transform.TransformerException<a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> WalkingIteratorSorted(<a name="line.68"></a>
<FONT color="green">069</FONT> Compiler compiler, int opPos, int analysis, boolean shouldLoadWalkers)<a name="line.69"></a>
<FONT color="green">070</FONT> throws javax.xml.transform.TransformerException<a name="line.70"></a>
<FONT color="green">071</FONT> {<a name="line.71"></a>
<FONT color="green">072</FONT> super(compiler, opPos, analysis, shouldLoadWalkers);<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> * Returns true if all the nodes in the iteration well be returned in document <a name="line.76"></a>
<FONT color="green">077</FONT> * order.<a name="line.77"></a>
<FONT color="green">078</FONT> * <a name="line.78"></a>
<FONT color="green">079</FONT> * @return true as a default.<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> public boolean isDocOrdered()<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> return m_inNaturalOrderStatic;<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> <a name="line.86"></a>
<FONT color="green">087</FONT> /**<a name="line.87"></a>
<FONT color="green">088</FONT> * Tell if the nodeset can be walked in doc order, via static analysis. <a name="line.88"></a>
<FONT color="green">089</FONT> *<a name="line.89"></a>
<FONT color="green">090</FONT> *<a name="line.90"></a>
<FONT color="green">091</FONT> * @return true if the nodeset can be walked in doc order, without sorting.<a name="line.91"></a>
<FONT color="green">092</FONT> */<a name="line.92"></a>
<FONT color="green">093</FONT> boolean canBeWalkedInNaturalDocOrderStatic()<a name="line.93"></a>
<FONT color="green">094</FONT> {<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> if (null != m_firstWalker)<a name="line.96"></a>
<FONT color="green">097</FONT> {<a name="line.97"></a>
<FONT color="green">098</FONT> AxesWalker walker = m_firstWalker;<a name="line.98"></a>
<FONT color="green">099</FONT> int prevAxis = -1;<a name="line.99"></a>
<FONT color="green">100</FONT> boolean prevIsSimpleDownAxis = true;<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> for(int i = 0; null != walker; i++)<a name="line.102"></a>
<FONT color="green">103</FONT> {<a name="line.103"></a>
<FONT color="green">104</FONT> int axis = walker.getAxis();<a name="line.104"></a>
<FONT color="green">105</FONT> <a name="line.105"></a>
<FONT color="green">106</FONT> if(walker.isDocOrdered())<a name="line.106"></a>
<FONT color="green">107</FONT> {<a name="line.107"></a>
<FONT color="green">108</FONT> boolean isSimpleDownAxis = ((axis == Axis.CHILD)<a name="line.108"></a>
<FONT color="green">109</FONT> || (axis == Axis.SELF)<a name="line.109"></a>
<FONT color="green">110</FONT> || (axis == Axis.ROOT));<a name="line.110"></a>
<FONT color="green">111</FONT> // Catching the filtered list here is only OK because<a name="line.111"></a>
<FONT color="green">112</FONT> // FilterExprWalker#isDocOrdered() did the right thing.<a name="line.112"></a>
<FONT color="green">113</FONT> if(isSimpleDownAxis || (axis == -1))<a name="line.113"></a>
<FONT color="green">114</FONT> walker = walker.getNextWalker();<a name="line.114"></a>
<FONT color="green">115</FONT> else<a name="line.115"></a>
<FONT color="green">116</FONT> {<a name="line.116"></a>
<FONT color="green">117</FONT> boolean isLastWalker = (null == walker.getNextWalker());<a name="line.117"></a>
<FONT color="green">118</FONT> if(isLastWalker)<a name="line.118"></a>
<FONT color="green">119</FONT> {<a name="line.119"></a>
<FONT color="green">120</FONT> if(walker.isDocOrdered() &amp;&amp; (axis == Axis.DESCENDANT || <a name="line.120"></a>
<FONT color="green">121</FONT> axis == Axis.DESCENDANTORSELF || axis == Axis.DESCENDANTSFROMROOT<a name="line.121"></a>
<FONT color="green">122</FONT> || axis == Axis.DESCENDANTSORSELFFROMROOT) || (axis == Axis.ATTRIBUTE))<a name="line.122"></a>
<FONT color="green">123</FONT> return true;<a name="line.123"></a>
<FONT color="green">124</FONT> }<a name="line.124"></a>
<FONT color="green">125</FONT> return false;<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
<FONT color="green">128</FONT> else<a name="line.128"></a>
<FONT color="green">129</FONT> return false;<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
<FONT color="green">131</FONT> return true;<a name="line.131"></a>
<FONT color="green">132</FONT> }<a name="line.132"></a>
<FONT color="green">133</FONT> return false;<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> <a name="line.136"></a>
<FONT color="green">137</FONT> // /**<a name="line.137"></a>
<FONT color="green">138</FONT> // * NEEDSDOC Method canBeWalkedInNaturalDocOrder <a name="line.138"></a>
<FONT color="green">139</FONT> // *<a name="line.139"></a>
<FONT color="green">140</FONT> // *<a name="line.140"></a>
<FONT color="green">141</FONT> // * NEEDSDOC (canBeWalkedInNaturalDocOrder) @return<a name="line.141"></a>
<FONT color="green">142</FONT> // */<a name="line.142"></a>
<FONT color="green">143</FONT> // boolean canBeWalkedInNaturalDocOrder()<a name="line.143"></a>
<FONT color="green">144</FONT> // {<a name="line.144"></a>
<FONT color="green">145</FONT> //<a name="line.145"></a>
<FONT color="green">146</FONT> // if (null != m_firstWalker)<a name="line.146"></a>
<FONT color="green">147</FONT> // {<a name="line.147"></a>
<FONT color="green">148</FONT> // AxesWalker walker = m_firstWalker;<a name="line.148"></a>
<FONT color="green">149</FONT> // int prevAxis = -1;<a name="line.149"></a>
<FONT color="green">150</FONT> // boolean prevIsSimpleDownAxis = true;<a name="line.150"></a>
<FONT color="green">151</FONT> //<a name="line.151"></a>
<FONT color="green">152</FONT> // for(int i = 0; null != walker; i++)<a name="line.152"></a>
<FONT color="green">153</FONT> // {<a name="line.153"></a>
<FONT color="green">154</FONT> // int axis = walker.getAxis();<a name="line.154"></a>
<FONT color="green">155</FONT> // <a name="line.155"></a>
<FONT color="green">156</FONT> // if(walker.isDocOrdered())<a name="line.156"></a>
<FONT color="green">157</FONT> // {<a name="line.157"></a>
<FONT color="green">158</FONT> // boolean isSimpleDownAxis = ((axis == Axis.CHILD)<a name="line.158"></a>
<FONT color="green">159</FONT> // || (axis == Axis.SELF)<a name="line.159"></a>
<FONT color="green">160</FONT> // || (axis == Axis.ROOT));<a name="line.160"></a>
<FONT color="green">161</FONT> // // Catching the filtered list here is only OK because<a name="line.161"></a>
<FONT color="green">162</FONT> // // FilterExprWalker#isDocOrdered() did the right thing.<a name="line.162"></a>
<FONT color="green">163</FONT> // if(isSimpleDownAxis || (axis == -1))<a name="line.163"></a>
<FONT color="green">164</FONT> // walker = walker.getNextWalker();<a name="line.164"></a>
<FONT color="green">165</FONT> // else<a name="line.165"></a>
<FONT color="green">166</FONT> // {<a name="line.166"></a>
<FONT color="green">167</FONT> // boolean isLastWalker = (null == walker.getNextWalker());<a name="line.167"></a>
<FONT color="green">168</FONT> // if(isLastWalker)<a name="line.168"></a>
<FONT color="green">169</FONT> // {<a name="line.169"></a>
<FONT color="green">170</FONT> // if(walker.isDocOrdered() &amp;&amp; (axis == Axis.DESCENDANT || <a name="line.170"></a>
<FONT color="green">171</FONT> // axis == Axis.DESCENDANTORSELF || axis == Axis.DESCENDANTSFROMROOT<a name="line.171"></a>
<FONT color="green">172</FONT> // || axis == Axis.DESCENDANTSORSELFFROMROOT) || (axis == Axis.ATTRIBUTE))<a name="line.172"></a>
<FONT color="green">173</FONT> // return true;<a name="line.173"></a>
<FONT color="green">174</FONT> // }<a name="line.174"></a>
<FONT color="green">175</FONT> // return false;<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> // else<a name="line.178"></a>
<FONT color="green">179</FONT> // return false;<a name="line.179"></a>
<FONT color="green">180</FONT> // }<a name="line.180"></a>
<FONT color="green">181</FONT> // return true;<a name="line.181"></a>
<FONT color="green">182</FONT> // }<a name="line.182"></a>
<FONT color="green">183</FONT> // return false;<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> /**<a name="line.186"></a>
<FONT color="green">187</FONT> * This function is used to perform some extra analysis of the iterator.<a name="line.187"></a>
<FONT color="green">188</FONT> * <a name="line.188"></a>
<FONT color="green">189</FONT> * @param vars List of QNames that correspond to variables. This list <a name="line.189"></a>
<FONT color="green">190</FONT> * should be searched backwards for the first qualified name that <a name="line.190"></a>
<FONT color="green">191</FONT> * corresponds to the variable reference qname. The position of the <a name="line.191"></a>
<FONT color="green">192</FONT> * QName in the vector from the start of the vector will be its position <a name="line.192"></a>
<FONT color="green">193</FONT> * in the stack frame (but variables above the globalsTop value will need <a name="line.193"></a>
<FONT color="green">194</FONT> * to be offset to the current stack frame).<a name="line.194"></a>
<FONT color="green">195</FONT> */<a name="line.195"></a>
<FONT color="green">196</FONT> public void fixupVariables(java.util.Vector vars, int globalsSize)<a name="line.196"></a>
<FONT color="green">197</FONT> {<a name="line.197"></a>
<FONT color="green">198</FONT> super.fixupVariables(vars, globalsSize);<a name="line.198"></a>
<FONT color="green">199</FONT> <a name="line.199"></a>
<FONT color="green">200</FONT> int analysis = getAnalysisBits();<a name="line.200"></a>
<FONT color="green">201</FONT> if(WalkerFactory.isNaturalDocOrder(analysis))<a name="line.201"></a>
<FONT color="green">202</FONT> {<a name="line.202"></a>
<FONT color="green">203</FONT> m_inNaturalOrderStatic = true;<a name="line.203"></a>
<FONT color="green">204</FONT> }<a name="line.204"></a>
<FONT color="green">205</FONT> else<a name="line.205"></a>
<FONT color="green">206</FONT> {<a name="line.206"></a>
<FONT color="green">207</FONT> m_inNaturalOrderStatic = false;<a name="line.207"></a>
<FONT color="green">208</FONT> // System.out.println("Setting natural doc order to false: "+<a name="line.208"></a>
<FONT color="green">209</FONT> // WalkerFactory.getAnalysisString(analysis));<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> }<a name="line.212"></a>
<FONT color="green">213</FONT> <a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
</PRE>
</BODY>
</HTML>