| <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: DTMNodeIterator.java 468653 2006-10-28 07:07:05Z minchau $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xml.dtm.ref;<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.DTM;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.xml.dtm.DTMDOMException;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.w3c.dom.DOMException;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.w3c.dom.Node;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.w3c.dom.traversal.NodeFilter;<a name="line.29"></a> |
| <FONT color="green">030</FONT> <a name="line.30"></a> |
| <FONT color="green">031</FONT> /**<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <code>DTMNodeIterator</code> gives us an implementation of the <a name="line.32"></a> |
| <FONT color="green">033</FONT> * DTMNodeIterator which returns DOM nodes.<a name="line.33"></a> |
| <FONT color="green">034</FONT> *<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Please note that this is not necessarily equivlaent to a DOM<a name="line.35"></a> |
| <FONT color="green">036</FONT> * NodeIterator operating over the same document. In particular:<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <ul><a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <li>If there are several Text nodes in logical succession (ie,<a name="line.39"></a> |
| <FONT color="green">040</FONT> * across CDATASection and EntityReference boundaries), we will return<a name="line.40"></a> |
| <FONT color="green">041</FONT> * only the first; the caller is responsible for stepping through<a name="line.41"></a> |
| <FONT color="green">042</FONT> * them.<a name="line.42"></a> |
| <FONT color="green">043</FONT> * (%REVIEW% Provide a convenience routine here to assist, pending<a name="line.43"></a> |
| <FONT color="green">044</FONT> * proposed DOM Level 3 getAdjacentText() operation?) </li><a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <li>Since the whole XPath/XSLT architecture assumes that the source<a name="line.46"></a> |
| <FONT color="green">047</FONT> * document is not altered while we're working with it, we do not<a name="line.47"></a> |
| <FONT color="green">048</FONT> * promise to implement the DOM NodeIterator's "maintain current<a name="line.48"></a> |
| <FONT color="green">049</FONT> * position" response to document mutation. </li><a name="line.49"></a> |
| <FONT color="green">050</FONT> *<a name="line.50"></a> |
| <FONT color="green">051</FONT> * <li>Since our design for XPath NodeIterators builds a stateful<a name="line.51"></a> |
| <FONT color="green">052</FONT> * filter directly into the traversal object, getNodeFilter() is not<a name="line.52"></a> |
| <FONT color="green">053</FONT> * supported.</li><a name="line.53"></a> |
| <FONT color="green">054</FONT> *<a name="line.54"></a> |
| <FONT color="green">055</FONT> * </ul><a name="line.55"></a> |
| <FONT color="green">056</FONT> *<a name="line.56"></a> |
| <FONT color="green">057</FONT> * <p>State: In progress!!</p><a name="line.57"></a> |
| <FONT color="green">058</FONT> * */<a name="line.58"></a> |
| <FONT color="green">059</FONT> public class DTMNodeIterator implements org.w3c.dom.traversal.NodeIterator<a name="line.59"></a> |
| <FONT color="green">060</FONT> {<a name="line.60"></a> |
| <FONT color="green">061</FONT> private DTMIterator dtm_iter;<a name="line.61"></a> |
| <FONT color="green">062</FONT> private boolean valid=true;<a name="line.62"></a> |
| <FONT color="green">063</FONT> <a name="line.63"></a> |
| <FONT color="green">064</FONT> //================================================================<a name="line.64"></a> |
| <FONT color="green">065</FONT> // Methods unique to this class<a name="line.65"></a> |
| <FONT color="green">066</FONT> <a name="line.66"></a> |
| <FONT color="green">067</FONT> /** Public constructor: Wrap a DTMNodeIterator around an existing<a name="line.67"></a> |
| <FONT color="green">068</FONT> * and preconfigured DTMIterator<a name="line.68"></a> |
| <FONT color="green">069</FONT> * */<a name="line.69"></a> |
| <FONT color="green">070</FONT> public DTMNodeIterator(DTMIterator dtmIterator)<a name="line.70"></a> |
| <FONT color="green">071</FONT> {<a name="line.71"></a> |
| <FONT color="green">072</FONT> try<a name="line.72"></a> |
| <FONT color="green">073</FONT> {<a name="line.73"></a> |
| <FONT color="green">074</FONT> dtm_iter=(DTMIterator)dtmIterator.clone();<a name="line.74"></a> |
| <FONT color="green">075</FONT> }<a name="line.75"></a> |
| <FONT color="green">076</FONT> catch(CloneNotSupportedException cnse)<a name="line.76"></a> |
| <FONT color="green">077</FONT> {<a name="line.77"></a> |
| <FONT color="green">078</FONT> throw new org.apache.xml.utils.WrappedRuntimeException(cnse);<a name="line.78"></a> |
| <FONT color="green">079</FONT> }<a name="line.79"></a> |
| <FONT color="green">080</FONT> }<a name="line.80"></a> |
| <FONT color="green">081</FONT> <a name="line.81"></a> |
| <FONT color="green">082</FONT> /** Access the wrapped DTMIterator. I'm not sure whether anyone will<a name="line.82"></a> |
| <FONT color="green">083</FONT> * need this or not, but let's write it and think about it.<a name="line.83"></a> |
| <FONT color="green">084</FONT> * */<a name="line.84"></a> |
| <FONT color="green">085</FONT> public DTMIterator getDTMIterator()<a name="line.85"></a> |
| <FONT color="green">086</FONT> {<a name="line.86"></a> |
| <FONT color="green">087</FONT> return dtm_iter;<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> <a name="line.90"></a> |
| <FONT color="green">091</FONT> //================================================================<a name="line.91"></a> |
| <FONT color="green">092</FONT> // org.w3c.dom.traversal.NodeFilter API follows<a name="line.92"></a> |
| <FONT color="green">093</FONT> <a name="line.93"></a> |
| <FONT color="green">094</FONT> /** Detaches the NodeIterator from the set which it iterated over,<a name="line.94"></a> |
| <FONT color="green">095</FONT> * releasing any computational resources and placing the iterator in<a name="line.95"></a> |
| <FONT color="green">096</FONT> * the INVALID state.<a name="line.96"></a> |
| <FONT color="green">097</FONT> * */<a name="line.97"></a> |
| <FONT color="green">098</FONT> public void detach() <a name="line.98"></a> |
| <FONT color="green">099</FONT> {<a name="line.99"></a> |
| <FONT color="green">100</FONT> // Theoretically, we could release dtm_iter at this point. But<a name="line.100"></a> |
| <FONT color="green">101</FONT> // some of the operations may still want to consult it even though<a name="line.101"></a> |
| <FONT color="green">102</FONT> // navigation is now invalid.<a name="line.102"></a> |
| <FONT color="green">103</FONT> valid=false;<a name="line.103"></a> |
| <FONT color="green">104</FONT> }<a name="line.104"></a> |
| <FONT color="green">105</FONT> <a name="line.105"></a> |
| <FONT color="green">106</FONT> /** The value of this flag determines whether the children<a name="line.106"></a> |
| <FONT color="green">107</FONT> * of entity reference nodes are visible to the iterator.<a name="line.107"></a> |
| <FONT color="green">108</FONT> *<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @return false, always (the DTM model flattens entity references)<a name="line.109"></a> |
| <FONT color="green">110</FONT> * */<a name="line.110"></a> |
| <FONT color="green">111</FONT> public boolean getExpandEntityReferences()<a name="line.111"></a> |
| <FONT color="green">112</FONT> {<a name="line.112"></a> |
| <FONT color="green">113</FONT> return false;<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> /** Return a handle to the filter used to screen nodes.<a name="line.116"></a> |
| <FONT color="green">117</FONT> *<a name="line.117"></a> |
| <FONT color="green">118</FONT> * This is ill-defined in Xalan's usage of Nodeiterator, where we have<a name="line.118"></a> |
| <FONT color="green">119</FONT> * built stateful XPath-based filtering directly into the traversal<a name="line.119"></a> |
| <FONT color="green">120</FONT> * object. We could return something which supports the NodeFilter interface<a name="line.120"></a> |
| <FONT color="green">121</FONT> * and allows querying whether a given node would be permitted if it appeared<a name="line.121"></a> |
| <FONT color="green">122</FONT> * as our next node, but in the current implementation that would be very<a name="line.122"></a> |
| <FONT color="green">123</FONT> * complex -- and just isn't all that useful.<a name="line.123"></a> |
| <FONT color="green">124</FONT> * <a name="line.124"></a> |
| <FONT color="green">125</FONT> * @throws DOMException -- NOT_SUPPORTED_ERROR because I can't think<a name="line.125"></a> |
| <FONT color="green">126</FONT> * of anything more useful to do in this case<a name="line.126"></a> |
| <FONT color="green">127</FONT> * */<a name="line.127"></a> |
| <FONT color="green">128</FONT> public NodeFilter getFilter() <a name="line.128"></a> |
| <FONT color="green">129</FONT> {<a name="line.129"></a> |
| <FONT color="green">130</FONT> throw new DTMDOMException(DOMException.NOT_SUPPORTED_ERR);<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> <a name="line.133"></a> |
| <FONT color="green">134</FONT> /** @return The root node of the NodeIterator, as specified<a name="line.134"></a> |
| <FONT color="green">135</FONT> * when it was created.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * */<a name="line.136"></a> |
| <FONT color="green">137</FONT> public Node getRoot()<a name="line.137"></a> |
| <FONT color="green">138</FONT> {<a name="line.138"></a> |
| <FONT color="green">139</FONT> int handle=dtm_iter.getRoot();<a name="line.139"></a> |
| <FONT color="green">140</FONT> return dtm_iter.getDTM(handle).getNode(handle);<a name="line.140"></a> |
| <FONT color="green">141</FONT> }<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> <a name="line.143"></a> |
| <FONT color="green">144</FONT> /** Return a mask describing which node types are presented via the<a name="line.144"></a> |
| <FONT color="green">145</FONT> * iterator.<a name="line.145"></a> |
| <FONT color="green">146</FONT> **/<a name="line.146"></a> |
| <FONT color="green">147</FONT> public int getWhatToShow()<a name="line.147"></a> |
| <FONT color="green">148</FONT> {<a name="line.148"></a> |
| <FONT color="green">149</FONT> return dtm_iter.getWhatToShow();<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<a name="line.150"></a> |
| <FONT color="green">151</FONT> <a name="line.151"></a> |
| <FONT color="green">152</FONT> /** @return the next node in the set and advance the position of the<a name="line.152"></a> |
| <FONT color="green">153</FONT> * iterator in the set.<a name="line.153"></a> |
| <FONT color="green">154</FONT> *<a name="line.154"></a> |
| <FONT color="green">155</FONT> * @throws DOMException - INVALID_STATE_ERR Raised if this method is<a name="line.155"></a> |
| <FONT color="green">156</FONT> * called after the detach method was invoked.<a name="line.156"></a> |
| <FONT color="green">157</FONT> * */<a name="line.157"></a> |
| <FONT color="green">158</FONT> public Node nextNode() throws DOMException<a name="line.158"></a> |
| <FONT color="green">159</FONT> {<a name="line.159"></a> |
| <FONT color="green">160</FONT> if(!valid)<a name="line.160"></a> |
| <FONT color="green">161</FONT> throw new DTMDOMException(DOMException.INVALID_STATE_ERR);<a name="line.161"></a> |
| <FONT color="green">162</FONT> <a name="line.162"></a> |
| <FONT color="green">163</FONT> int handle=dtm_iter.nextNode();<a name="line.163"></a> |
| <FONT color="green">164</FONT> if (handle==DTM.NULL)<a name="line.164"></a> |
| <FONT color="green">165</FONT> return null;<a name="line.165"></a> |
| <FONT color="green">166</FONT> return dtm_iter.getDTM(handle).getNode(handle);<a name="line.166"></a> |
| <FONT color="green">167</FONT> }<a name="line.167"></a> |
| <FONT color="green">168</FONT> <a name="line.168"></a> |
| <FONT color="green">169</FONT> <a name="line.169"></a> |
| <FONT color="green">170</FONT> /** @return the next previous in the set and advance the position of the<a name="line.170"></a> |
| <FONT color="green">171</FONT> * iterator in the set.<a name="line.171"></a> |
| <FONT color="green">172</FONT> *<a name="line.172"></a> |
| <FONT color="green">173</FONT> * @throws DOMException - INVALID_STATE_ERR Raised if this method is<a name="line.173"></a> |
| <FONT color="green">174</FONT> * called after the detach method was invoked.<a name="line.174"></a> |
| <FONT color="green">175</FONT> * */<a name="line.175"></a> |
| <FONT color="green">176</FONT> public Node previousNode() <a name="line.176"></a> |
| <FONT color="green">177</FONT> {<a name="line.177"></a> |
| <FONT color="green">178</FONT> if(!valid)<a name="line.178"></a> |
| <FONT color="green">179</FONT> throw new DTMDOMException(DOMException.INVALID_STATE_ERR);<a name="line.179"></a> |
| <FONT color="green">180</FONT> <a name="line.180"></a> |
| <FONT color="green">181</FONT> int handle=dtm_iter.previousNode();<a name="line.181"></a> |
| <FONT color="green">182</FONT> if (handle==DTM.NULL)<a name="line.182"></a> |
| <FONT color="green">183</FONT> return null; <a name="line.183"></a> |
| <FONT color="green">184</FONT> return dtm_iter.getDTM(handle).getNode(handle);<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
