blob: f3405f18c1407b9ab883bdcd97b6df0b9b625428 [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: IncrementalSAXSource_Filter.java 1225427 2011-12-29 04:33:32Z mrglavas $<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.xml.dtm.ref;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.io.IOException;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.apache.xml.res.XMLErrorResources;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xml.res.XMLMessages;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xml.utils.ThreadControllerWrapper;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> import org.xml.sax.Attributes;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.xml.sax.ContentHandler;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.xml.sax.DTDHandler;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.xml.sax.ErrorHandler;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.xml.sax.InputSource;<a name="line.34"></a>
<FONT color="green">035</FONT> import org.xml.sax.Locator;<a name="line.35"></a>
<FONT color="green">036</FONT> import org.xml.sax.SAXException;<a name="line.36"></a>
<FONT color="green">037</FONT> import org.xml.sax.SAXNotRecognizedException;<a name="line.37"></a>
<FONT color="green">038</FONT> import org.xml.sax.SAXNotSupportedException;<a name="line.38"></a>
<FONT color="green">039</FONT> import org.xml.sax.SAXParseException;<a name="line.39"></a>
<FONT color="green">040</FONT> import org.xml.sax.XMLReader;<a name="line.40"></a>
<FONT color="green">041</FONT> import org.xml.sax.ext.LexicalHandler;<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /** &lt;p&gt;IncrementalSAXSource_Filter implements IncrementalSAXSource, using a<a name="line.43"></a>
<FONT color="green">044</FONT> * standard SAX2 event source as its input and parcelling out those<a name="line.44"></a>
<FONT color="green">045</FONT> * events gradually in reponse to deliverMoreNodes() requests. Output from the<a name="line.45"></a>
<FONT color="green">046</FONT> * filter will be passed along to a SAX handler registered as our<a name="line.46"></a>
<FONT color="green">047</FONT> * listener, but those callbacks will pass through a counting stage<a name="line.47"></a>
<FONT color="green">048</FONT> * which periodically yields control back to the controller coroutine.<a name="line.48"></a>
<FONT color="green">049</FONT> * &lt;/p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT> *<a name="line.50"></a>
<FONT color="green">051</FONT> * &lt;p&gt;%REVIEW%: This filter is not currenly intended to be reusable<a name="line.51"></a>
<FONT color="green">052</FONT> * for parsing additional streams/documents. We may want to consider<a name="line.52"></a>
<FONT color="green">053</FONT> * making it resettable at some point in the future. But it's a <a name="line.53"></a>
<FONT color="green">054</FONT> * small object, so that'd be mostly a convenience issue; the cost<a name="line.54"></a>
<FONT color="green">055</FONT> * of allocating each time is trivial compared to the cost of processing<a name="line.55"></a>
<FONT color="green">056</FONT> * any nontrival stream.&lt;/p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT> *<a name="line.57"></a>
<FONT color="green">058</FONT> * &lt;p&gt;For a brief usage example, see the unit-test main() method.&lt;/p&gt;<a name="line.58"></a>
<FONT color="green">059</FONT> *<a name="line.59"></a>
<FONT color="green">060</FONT> * &lt;p&gt;This is a simplification of the old CoroutineSAXParser, focusing<a name="line.60"></a>
<FONT color="green">061</FONT> * specifically on filtering. The resulting controller protocol is _far_<a name="line.61"></a>
<FONT color="green">062</FONT> * simpler and less error-prone; the only controller operation is deliverMoreNodes(),<a name="line.62"></a>
<FONT color="green">063</FONT> * and the only requirement is that deliverMoreNodes(false) be called if you want to<a name="line.63"></a>
<FONT color="green">064</FONT> * discard the rest of the stream and the previous deliverMoreNodes() didn't return<a name="line.64"></a>
<FONT color="green">065</FONT> * false.<a name="line.65"></a>
<FONT color="green">066</FONT> * */<a name="line.66"></a>
<FONT color="green">067</FONT> public class IncrementalSAXSource_Filter<a name="line.67"></a>
<FONT color="green">068</FONT> implements IncrementalSAXSource, ContentHandler, DTDHandler, LexicalHandler, ErrorHandler, Runnable<a name="line.68"></a>
<FONT color="green">069</FONT> {<a name="line.69"></a>
<FONT color="green">070</FONT> boolean DEBUG=false; //Internal status report<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> // Data<a name="line.73"></a>
<FONT color="green">074</FONT> //<a name="line.74"></a>
<FONT color="green">075</FONT> private CoroutineManager fCoroutineManager = null;<a name="line.75"></a>
<FONT color="green">076</FONT> private int fControllerCoroutineID = -1;<a name="line.76"></a>
<FONT color="green">077</FONT> private int fSourceCoroutineID = -1;<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> private ContentHandler clientContentHandler=null; // %REVIEW% support multiple?<a name="line.79"></a>
<FONT color="green">080</FONT> private LexicalHandler clientLexicalHandler=null; // %REVIEW% support multiple?<a name="line.80"></a>
<FONT color="green">081</FONT> private DTDHandler clientDTDHandler=null; // %REVIEW% support multiple?<a name="line.81"></a>
<FONT color="green">082</FONT> private ErrorHandler clientErrorHandler=null; // %REVIEW% support multiple?<a name="line.82"></a>
<FONT color="green">083</FONT> private int eventcounter;<a name="line.83"></a>
<FONT color="green">084</FONT> private int frequency=5;<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> // Flag indicating that no more events should be delivered -- either<a name="line.86"></a>
<FONT color="green">087</FONT> // because input stream ran to completion (endDocument), or because<a name="line.87"></a>
<FONT color="green">088</FONT> // the user requested an early stop via deliverMoreNodes(false).<a name="line.88"></a>
<FONT color="green">089</FONT> private boolean fNoMoreEvents=false;<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> // Support for startParse()<a name="line.91"></a>
<FONT color="green">092</FONT> private XMLReader fXMLReader=null;<a name="line.92"></a>
<FONT color="green">093</FONT> private InputSource fXMLReaderInputSource=null;<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> // Constructors<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> public IncrementalSAXSource_Filter() {<a name="line.99"></a>
<FONT color="green">100</FONT> this.init( new CoroutineManager(), -1, -1);<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> /** Create a IncrementalSAXSource_Filter which is not yet bound to a specific<a name="line.103"></a>
<FONT color="green">104</FONT> * SAX event source.<a name="line.104"></a>
<FONT color="green">105</FONT> * */<a name="line.105"></a>
<FONT color="green">106</FONT> public IncrementalSAXSource_Filter(CoroutineManager co, int controllerCoroutineID)<a name="line.106"></a>
<FONT color="green">107</FONT> {<a name="line.107"></a>
<FONT color="green">108</FONT> this.init( co, controllerCoroutineID, -1 );<a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> //<a name="line.111"></a>
<FONT color="green">112</FONT> // Factories<a name="line.112"></a>
<FONT color="green">113</FONT> //<a name="line.113"></a>
<FONT color="green">114</FONT> static public IncrementalSAXSource createIncrementalSAXSource(CoroutineManager co, int controllerCoroutineID) {<a name="line.114"></a>
<FONT color="green">115</FONT> return new IncrementalSAXSource_Filter(co, controllerCoroutineID);<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> //<a name="line.118"></a>
<FONT color="green">119</FONT> // Public methods<a name="line.119"></a>
<FONT color="green">120</FONT> //<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> public void init( CoroutineManager co, int controllerCoroutineID,<a name="line.122"></a>
<FONT color="green">123</FONT> int sourceCoroutineID)<a name="line.123"></a>
<FONT color="green">124</FONT> {<a name="line.124"></a>
<FONT color="green">125</FONT> if(co==null)<a name="line.125"></a>
<FONT color="green">126</FONT> co = new CoroutineManager();<a name="line.126"></a>
<FONT color="green">127</FONT> fCoroutineManager = co;<a name="line.127"></a>
<FONT color="green">128</FONT> fControllerCoroutineID = co.co_joinCoroutineSet(controllerCoroutineID);<a name="line.128"></a>
<FONT color="green">129</FONT> fSourceCoroutineID = co.co_joinCoroutineSet(sourceCoroutineID);<a name="line.129"></a>
<FONT color="green">130</FONT> if (fControllerCoroutineID == -1 || fSourceCoroutineID == -1)<a name="line.130"></a>
<FONT color="green">131</FONT> throw new RuntimeException(XMLMessages.createXMLMessage(XMLErrorResources.ER_COJOINROUTINESET_FAILED, null)); //"co_joinCoroutineSet() failed");<a name="line.131"></a>
<FONT color="green">132</FONT> <a name="line.132"></a>
<FONT color="green">133</FONT> fNoMoreEvents=false;<a name="line.133"></a>
<FONT color="green">134</FONT> eventcounter=frequency;<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> /** Bind our input streams to an XMLReader.<a name="line.137"></a>
<FONT color="green">138</FONT> *<a name="line.138"></a>
<FONT color="green">139</FONT> * Just a convenience routine; obviously you can explicitly register<a name="line.139"></a>
<FONT color="green">140</FONT> * this as a listener with the same effect.<a name="line.140"></a>
<FONT color="green">141</FONT> * */<a name="line.141"></a>
<FONT color="green">142</FONT> public void setXMLReader(XMLReader eventsource)<a name="line.142"></a>
<FONT color="green">143</FONT> {<a name="line.143"></a>
<FONT color="green">144</FONT> fXMLReader=eventsource;<a name="line.144"></a>
<FONT color="green">145</FONT> eventsource.setContentHandler(this);<a name="line.145"></a>
<FONT color="green">146</FONT> eventsource.setDTDHandler(this);<a name="line.146"></a>
<FONT color="green">147</FONT> eventsource.setErrorHandler(this); // to report fatal errors in filtering mode<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> // Not supported by all SAX2 filters:<a name="line.149"></a>
<FONT color="green">150</FONT> try <a name="line.150"></a>
<FONT color="green">151</FONT> {<a name="line.151"></a>
<FONT color="green">152</FONT> eventsource.<a name="line.152"></a>
<FONT color="green">153</FONT> setProperty("http://xml.org/sax/properties/lexical-handler",<a name="line.153"></a>
<FONT color="green">154</FONT> this);<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> catch(SAXNotRecognizedException e)<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> // Nothing we can do about it<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> catch(SAXNotSupportedException e)<a name="line.160"></a>
<FONT color="green">161</FONT> {<a name="line.161"></a>
<FONT color="green">162</FONT> // Nothing we can do about it<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> // Should we also bind as other varieties of handler?<a name="line.165"></a>
<FONT color="green">166</FONT> // (DTDHandler and so on)<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> // Register a content handler for us to output to<a name="line.169"></a>
<FONT color="green">170</FONT> public void setContentHandler(ContentHandler handler)<a name="line.170"></a>
<FONT color="green">171</FONT> {<a name="line.171"></a>
<FONT color="green">172</FONT> clientContentHandler=handler;<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> // Register a DTD handler for us to output to<a name="line.174"></a>
<FONT color="green">175</FONT> public void setDTDHandler(DTDHandler handler)<a name="line.175"></a>
<FONT color="green">176</FONT> {<a name="line.176"></a>
<FONT color="green">177</FONT> clientDTDHandler=handler;<a name="line.177"></a>
<FONT color="green">178</FONT> }<a name="line.178"></a>
<FONT color="green">179</FONT> // Register a lexical handler for us to output to<a name="line.179"></a>
<FONT color="green">180</FONT> // Not all filters support this...<a name="line.180"></a>
<FONT color="green">181</FONT> // ??? Should we register directly on the filter?<a name="line.181"></a>
<FONT color="green">182</FONT> // NOTE NAME -- subclassing issue in the Xerces version<a name="line.182"></a>
<FONT color="green">183</FONT> public void setLexicalHandler(LexicalHandler handler)<a name="line.183"></a>
<FONT color="green">184</FONT> {<a name="line.184"></a>
<FONT color="green">185</FONT> clientLexicalHandler=handler;<a name="line.185"></a>
<FONT color="green">186</FONT> }<a name="line.186"></a>
<FONT color="green">187</FONT> // Register an error handler for us to output to<a name="line.187"></a>
<FONT color="green">188</FONT> // NOTE NAME -- subclassing issue in the Xerces version<a name="line.188"></a>
<FONT color="green">189</FONT> public void setErrHandler(ErrorHandler handler)<a name="line.189"></a>
<FONT color="green">190</FONT> {<a name="line.190"></a>
<FONT color="green">191</FONT> clientErrorHandler=handler;<a name="line.191"></a>
<FONT color="green">192</FONT> }<a name="line.192"></a>
<FONT color="green">193</FONT> <a name="line.193"></a>
<FONT color="green">194</FONT> // Set the number of events between resumes of our coroutine<a name="line.194"></a>
<FONT color="green">195</FONT> // Immediately resets number of events before _next_ resume as well.<a name="line.195"></a>
<FONT color="green">196</FONT> public void setReturnFrequency(int events)<a name="line.196"></a>
<FONT color="green">197</FONT> {<a name="line.197"></a>
<FONT color="green">198</FONT> if(events&lt;1) events=1;<a name="line.198"></a>
<FONT color="green">199</FONT> frequency=eventcounter=events;<a name="line.199"></a>
<FONT color="green">200</FONT> }<a name="line.200"></a>
<FONT color="green">201</FONT> <a name="line.201"></a>
<FONT color="green">202</FONT> //<a name="line.202"></a>
<FONT color="green">203</FONT> // ContentHandler methods<a name="line.203"></a>
<FONT color="green">204</FONT> // These pass the data to our client ContentHandler...<a name="line.204"></a>
<FONT color="green">205</FONT> // but they also count the number of events passing through,<a name="line.205"></a>
<FONT color="green">206</FONT> // and resume our coroutine each time that counter hits zero and<a name="line.206"></a>
<FONT color="green">207</FONT> // is reset.<a name="line.207"></a>
<FONT color="green">208</FONT> //<a name="line.208"></a>
<FONT color="green">209</FONT> // Note that for everything except endDocument and fatalError, we do the count-and-yield<a name="line.209"></a>
<FONT color="green">210</FONT> // BEFORE passing the call along. I'm hoping that this will encourage JIT<a name="line.210"></a>
<FONT color="green">211</FONT> // compilers to realize that these are tail-calls, reducing the expense of<a name="line.211"></a>
<FONT color="green">212</FONT> // the additional layer of data flow.<a name="line.212"></a>
<FONT color="green">213</FONT> //<a name="line.213"></a>
<FONT color="green">214</FONT> // %REVIEW% Glenn suggests that pausing after endElement, endDocument,<a name="line.214"></a>
<FONT color="green">215</FONT> // and characters may be sufficient. I actually may not want to<a name="line.215"></a>
<FONT color="green">216</FONT> // stop after characters, since in our application these wind up being<a name="line.216"></a>
<FONT color="green">217</FONT> // concatenated before they're processed... but that risks huge blocks of<a name="line.217"></a>
<FONT color="green">218</FONT> // text causing greater than usual readahead. (Unlikely? Consider the<a name="line.218"></a>
<FONT color="green">219</FONT> // possibility of a large base-64 block in a SOAP stream.)<a name="line.219"></a>
<FONT color="green">220</FONT> //<a name="line.220"></a>
<FONT color="green">221</FONT> public void characters(char[] ch, int start, int length)<a name="line.221"></a>
<FONT color="green">222</FONT> throws org.xml.sax.SAXException<a name="line.222"></a>
<FONT color="green">223</FONT> {<a name="line.223"></a>
<FONT color="green">224</FONT> if(--eventcounter&lt;=0)<a name="line.224"></a>
<FONT color="green">225</FONT> {<a name="line.225"></a>
<FONT color="green">226</FONT> co_yield(true);<a name="line.226"></a>
<FONT color="green">227</FONT> eventcounter=frequency;<a name="line.227"></a>
<FONT color="green">228</FONT> }<a name="line.228"></a>
<FONT color="green">229</FONT> if(clientContentHandler!=null)<a name="line.229"></a>
<FONT color="green">230</FONT> clientContentHandler.characters(ch,start,length);<a name="line.230"></a>
<FONT color="green">231</FONT> }<a name="line.231"></a>
<FONT color="green">232</FONT> public void endDocument() <a name="line.232"></a>
<FONT color="green">233</FONT> throws org.xml.sax.SAXException<a name="line.233"></a>
<FONT color="green">234</FONT> {<a name="line.234"></a>
<FONT color="green">235</FONT> // EXCEPTION: In this case we need to run the event BEFORE we yield.<a name="line.235"></a>
<FONT color="green">236</FONT> if(clientContentHandler!=null)<a name="line.236"></a>
<FONT color="green">237</FONT> clientContentHandler.endDocument();<a name="line.237"></a>
<FONT color="green">238</FONT> <a name="line.238"></a>
<FONT color="green">239</FONT> eventcounter=0; <a name="line.239"></a>
<FONT color="green">240</FONT> co_yield(false);<a name="line.240"></a>
<FONT color="green">241</FONT> }<a name="line.241"></a>
<FONT color="green">242</FONT> public void endElement(java.lang.String namespaceURI, java.lang.String localName,<a name="line.242"></a>
<FONT color="green">243</FONT> java.lang.String qName) <a name="line.243"></a>
<FONT color="green">244</FONT> throws org.xml.sax.SAXException<a name="line.244"></a>
<FONT color="green">245</FONT> {<a name="line.245"></a>
<FONT color="green">246</FONT> if(--eventcounter&lt;=0)<a name="line.246"></a>
<FONT color="green">247</FONT> {<a name="line.247"></a>
<FONT color="green">248</FONT> co_yield(true);<a name="line.248"></a>
<FONT color="green">249</FONT> eventcounter=frequency;<a name="line.249"></a>
<FONT color="green">250</FONT> }<a name="line.250"></a>
<FONT color="green">251</FONT> if(clientContentHandler!=null)<a name="line.251"></a>
<FONT color="green">252</FONT> clientContentHandler.endElement(namespaceURI,localName,qName);<a name="line.252"></a>
<FONT color="green">253</FONT> }<a name="line.253"></a>
<FONT color="green">254</FONT> public void endPrefixMapping(java.lang.String prefix) <a name="line.254"></a>
<FONT color="green">255</FONT> throws org.xml.sax.SAXException<a name="line.255"></a>
<FONT color="green">256</FONT> {<a name="line.256"></a>
<FONT color="green">257</FONT> if(--eventcounter&lt;=0)<a name="line.257"></a>
<FONT color="green">258</FONT> {<a name="line.258"></a>
<FONT color="green">259</FONT> co_yield(true);<a name="line.259"></a>
<FONT color="green">260</FONT> eventcounter=frequency;<a name="line.260"></a>
<FONT color="green">261</FONT> }<a name="line.261"></a>
<FONT color="green">262</FONT> if(clientContentHandler!=null)<a name="line.262"></a>
<FONT color="green">263</FONT> clientContentHandler.endPrefixMapping(prefix);<a name="line.263"></a>
<FONT color="green">264</FONT> }<a name="line.264"></a>
<FONT color="green">265</FONT> public void ignorableWhitespace(char[] ch, int start, int length) <a name="line.265"></a>
<FONT color="green">266</FONT> throws org.xml.sax.SAXException<a name="line.266"></a>
<FONT color="green">267</FONT> {<a name="line.267"></a>
<FONT color="green">268</FONT> if(--eventcounter&lt;=0)<a name="line.268"></a>
<FONT color="green">269</FONT> {<a name="line.269"></a>
<FONT color="green">270</FONT> co_yield(true);<a name="line.270"></a>
<FONT color="green">271</FONT> eventcounter=frequency;<a name="line.271"></a>
<FONT color="green">272</FONT> }<a name="line.272"></a>
<FONT color="green">273</FONT> if(clientContentHandler!=null)<a name="line.273"></a>
<FONT color="green">274</FONT> clientContentHandler.ignorableWhitespace(ch,start,length);<a name="line.274"></a>
<FONT color="green">275</FONT> }<a name="line.275"></a>
<FONT color="green">276</FONT> public void processingInstruction(java.lang.String target, java.lang.String data) <a name="line.276"></a>
<FONT color="green">277</FONT> throws org.xml.sax.SAXException<a name="line.277"></a>
<FONT color="green">278</FONT> {<a name="line.278"></a>
<FONT color="green">279</FONT> if(--eventcounter&lt;=0)<a name="line.279"></a>
<FONT color="green">280</FONT> {<a name="line.280"></a>
<FONT color="green">281</FONT> co_yield(true);<a name="line.281"></a>
<FONT color="green">282</FONT> eventcounter=frequency;<a name="line.282"></a>
<FONT color="green">283</FONT> }<a name="line.283"></a>
<FONT color="green">284</FONT> if(clientContentHandler!=null)<a name="line.284"></a>
<FONT color="green">285</FONT> clientContentHandler.processingInstruction(target,data);<a name="line.285"></a>
<FONT color="green">286</FONT> }<a name="line.286"></a>
<FONT color="green">287</FONT> public void setDocumentLocator(Locator locator) <a name="line.287"></a>
<FONT color="green">288</FONT> {<a name="line.288"></a>
<FONT color="green">289</FONT> if(--eventcounter&lt;=0)<a name="line.289"></a>
<FONT color="green">290</FONT> {<a name="line.290"></a>
<FONT color="green">291</FONT> // This can cause a hang. -sb<a name="line.291"></a>
<FONT color="green">292</FONT> // co_yield(true);<a name="line.292"></a>
<FONT color="green">293</FONT> eventcounter=frequency;<a name="line.293"></a>
<FONT color="green">294</FONT> }<a name="line.294"></a>
<FONT color="green">295</FONT> if(clientContentHandler!=null)<a name="line.295"></a>
<FONT color="green">296</FONT> clientContentHandler.setDocumentLocator(locator);<a name="line.296"></a>
<FONT color="green">297</FONT> }<a name="line.297"></a>
<FONT color="green">298</FONT> public void skippedEntity(java.lang.String name) <a name="line.298"></a>
<FONT color="green">299</FONT> throws org.xml.sax.SAXException<a name="line.299"></a>
<FONT color="green">300</FONT> {<a name="line.300"></a>
<FONT color="green">301</FONT> if(--eventcounter&lt;=0)<a name="line.301"></a>
<FONT color="green">302</FONT> {<a name="line.302"></a>
<FONT color="green">303</FONT> co_yield(true);<a name="line.303"></a>
<FONT color="green">304</FONT> eventcounter=frequency;<a name="line.304"></a>
<FONT color="green">305</FONT> }<a name="line.305"></a>
<FONT color="green">306</FONT> if(clientContentHandler!=null)<a name="line.306"></a>
<FONT color="green">307</FONT> clientContentHandler.skippedEntity(name);<a name="line.307"></a>
<FONT color="green">308</FONT> }<a name="line.308"></a>
<FONT color="green">309</FONT> public void startDocument() <a name="line.309"></a>
<FONT color="green">310</FONT> throws org.xml.sax.SAXException<a name="line.310"></a>
<FONT color="green">311</FONT> {<a name="line.311"></a>
<FONT color="green">312</FONT> co_entry_pause();<a name="line.312"></a>
<FONT color="green">313</FONT> <a name="line.313"></a>
<FONT color="green">314</FONT> // Otherwise, begin normal event delivery<a name="line.314"></a>
<FONT color="green">315</FONT> if(--eventcounter&lt;=0)<a name="line.315"></a>
<FONT color="green">316</FONT> {<a name="line.316"></a>
<FONT color="green">317</FONT> co_yield(true);<a name="line.317"></a>
<FONT color="green">318</FONT> eventcounter=frequency;<a name="line.318"></a>
<FONT color="green">319</FONT> }<a name="line.319"></a>
<FONT color="green">320</FONT> if(clientContentHandler!=null)<a name="line.320"></a>
<FONT color="green">321</FONT> clientContentHandler.startDocument();<a name="line.321"></a>
<FONT color="green">322</FONT> }<a name="line.322"></a>
<FONT color="green">323</FONT> public void startElement(java.lang.String namespaceURI, java.lang.String localName,<a name="line.323"></a>
<FONT color="green">324</FONT> java.lang.String qName, Attributes atts) <a name="line.324"></a>
<FONT color="green">325</FONT> throws org.xml.sax.SAXException<a name="line.325"></a>
<FONT color="green">326</FONT> {<a name="line.326"></a>
<FONT color="green">327</FONT> if(--eventcounter&lt;=0)<a name="line.327"></a>
<FONT color="green">328</FONT> {<a name="line.328"></a>
<FONT color="green">329</FONT> co_yield(true);<a name="line.329"></a>
<FONT color="green">330</FONT> eventcounter=frequency;<a name="line.330"></a>
<FONT color="green">331</FONT> }<a name="line.331"></a>
<FONT color="green">332</FONT> if(clientContentHandler!=null)<a name="line.332"></a>
<FONT color="green">333</FONT> clientContentHandler.startElement(namespaceURI, localName, qName, atts);<a name="line.333"></a>
<FONT color="green">334</FONT> }<a name="line.334"></a>
<FONT color="green">335</FONT> public void startPrefixMapping(java.lang.String prefix, java.lang.String uri) <a name="line.335"></a>
<FONT color="green">336</FONT> throws org.xml.sax.SAXException<a name="line.336"></a>
<FONT color="green">337</FONT> {<a name="line.337"></a>
<FONT color="green">338</FONT> if(--eventcounter&lt;=0)<a name="line.338"></a>
<FONT color="green">339</FONT> {<a name="line.339"></a>
<FONT color="green">340</FONT> co_yield(true);<a name="line.340"></a>
<FONT color="green">341</FONT> eventcounter=frequency;<a name="line.341"></a>
<FONT color="green">342</FONT> }<a name="line.342"></a>
<FONT color="green">343</FONT> if(clientContentHandler!=null)<a name="line.343"></a>
<FONT color="green">344</FONT> clientContentHandler.startPrefixMapping(prefix,uri);<a name="line.344"></a>
<FONT color="green">345</FONT> }<a name="line.345"></a>
<FONT color="green">346</FONT> <a name="line.346"></a>
<FONT color="green">347</FONT> //<a name="line.347"></a>
<FONT color="green">348</FONT> // LexicalHandler support. Not all SAX2 filters support these events<a name="line.348"></a>
<FONT color="green">349</FONT> // but we may want to pass them through when they exist...<a name="line.349"></a>
<FONT color="green">350</FONT> //<a name="line.350"></a>
<FONT color="green">351</FONT> // %REVIEW% These do NOT currently affect the eventcounter; I'm asserting<a name="line.351"></a>
<FONT color="green">352</FONT> // that they're rare enough that it makes little or no sense to<a name="line.352"></a>
<FONT color="green">353</FONT> // pause after them. As such, it may make more sense for folks who<a name="line.353"></a>
<FONT color="green">354</FONT> // actually want to use them to register directly with the filter.<a name="line.354"></a>
<FONT color="green">355</FONT> // But I want 'em here for now, to remind us to recheck this assertion!<a name="line.355"></a>
<FONT color="green">356</FONT> //<a name="line.356"></a>
<FONT color="green">357</FONT> public void comment(char[] ch, int start, int length) <a name="line.357"></a>
<FONT color="green">358</FONT> throws org.xml.sax.SAXException<a name="line.358"></a>
<FONT color="green">359</FONT> {<a name="line.359"></a>
<FONT color="green">360</FONT> if(null!=clientLexicalHandler)<a name="line.360"></a>
<FONT color="green">361</FONT> clientLexicalHandler.comment(ch,start,length);<a name="line.361"></a>
<FONT color="green">362</FONT> }<a name="line.362"></a>
<FONT color="green">363</FONT> public void endCDATA() <a name="line.363"></a>
<FONT color="green">364</FONT> throws org.xml.sax.SAXException<a name="line.364"></a>
<FONT color="green">365</FONT> {<a name="line.365"></a>
<FONT color="green">366</FONT> if(null!=clientLexicalHandler)<a name="line.366"></a>
<FONT color="green">367</FONT> clientLexicalHandler.endCDATA();<a name="line.367"></a>
<FONT color="green">368</FONT> }<a name="line.368"></a>
<FONT color="green">369</FONT> public void endDTD() <a name="line.369"></a>
<FONT color="green">370</FONT> throws org.xml.sax.SAXException<a name="line.370"></a>
<FONT color="green">371</FONT> {<a name="line.371"></a>
<FONT color="green">372</FONT> if(null!=clientLexicalHandler)<a name="line.372"></a>
<FONT color="green">373</FONT> clientLexicalHandler.endDTD();<a name="line.373"></a>
<FONT color="green">374</FONT> }<a name="line.374"></a>
<FONT color="green">375</FONT> public void endEntity(java.lang.String name) <a name="line.375"></a>
<FONT color="green">376</FONT> throws org.xml.sax.SAXException<a name="line.376"></a>
<FONT color="green">377</FONT> {<a name="line.377"></a>
<FONT color="green">378</FONT> if(null!=clientLexicalHandler)<a name="line.378"></a>
<FONT color="green">379</FONT> clientLexicalHandler.endEntity(name);<a name="line.379"></a>
<FONT color="green">380</FONT> }<a name="line.380"></a>
<FONT color="green">381</FONT> public void startCDATA() <a name="line.381"></a>
<FONT color="green">382</FONT> throws org.xml.sax.SAXException<a name="line.382"></a>
<FONT color="green">383</FONT> {<a name="line.383"></a>
<FONT color="green">384</FONT> if(null!=clientLexicalHandler)<a name="line.384"></a>
<FONT color="green">385</FONT> clientLexicalHandler.startCDATA();<a name="line.385"></a>
<FONT color="green">386</FONT> }<a name="line.386"></a>
<FONT color="green">387</FONT> public void startDTD(java.lang.String name, java.lang.String publicId,<a name="line.387"></a>
<FONT color="green">388</FONT> java.lang.String systemId) <a name="line.388"></a>
<FONT color="green">389</FONT> throws org.xml.sax.SAXException<a name="line.389"></a>
<FONT color="green">390</FONT> {<a name="line.390"></a>
<FONT color="green">391</FONT> if(null!=clientLexicalHandler)<a name="line.391"></a>
<FONT color="green">392</FONT> clientLexicalHandler. startDTD(name, publicId, systemId);<a name="line.392"></a>
<FONT color="green">393</FONT> }<a name="line.393"></a>
<FONT color="green">394</FONT> public void startEntity(java.lang.String name) <a name="line.394"></a>
<FONT color="green">395</FONT> throws org.xml.sax.SAXException<a name="line.395"></a>
<FONT color="green">396</FONT> {<a name="line.396"></a>
<FONT color="green">397</FONT> if(null!=clientLexicalHandler)<a name="line.397"></a>
<FONT color="green">398</FONT> clientLexicalHandler.startEntity(name);<a name="line.398"></a>
<FONT color="green">399</FONT> }<a name="line.399"></a>
<FONT color="green">400</FONT> <a name="line.400"></a>
<FONT color="green">401</FONT> //<a name="line.401"></a>
<FONT color="green">402</FONT> // DTDHandler support.<a name="line.402"></a>
<FONT color="green">403</FONT> <a name="line.403"></a>
<FONT color="green">404</FONT> public void notationDecl(String a, String b, String c) throws SAXException<a name="line.404"></a>
<FONT color="green">405</FONT> {<a name="line.405"></a>
<FONT color="green">406</FONT> if(null!=clientDTDHandler)<a name="line.406"></a>
<FONT color="green">407</FONT> clientDTDHandler.notationDecl(a,b,c);<a name="line.407"></a>
<FONT color="green">408</FONT> }<a name="line.408"></a>
<FONT color="green">409</FONT> public void unparsedEntityDecl(String a, String b, String c, String d) throws SAXException<a name="line.409"></a>
<FONT color="green">410</FONT> {<a name="line.410"></a>
<FONT color="green">411</FONT> if(null!=clientDTDHandler)<a name="line.411"></a>
<FONT color="green">412</FONT> clientDTDHandler.unparsedEntityDecl(a,b,c,d);<a name="line.412"></a>
<FONT color="green">413</FONT> }<a name="line.413"></a>
<FONT color="green">414</FONT> <a name="line.414"></a>
<FONT color="green">415</FONT> //<a name="line.415"></a>
<FONT color="green">416</FONT> // ErrorHandler support.<a name="line.416"></a>
<FONT color="green">417</FONT> //<a name="line.417"></a>
<FONT color="green">418</FONT> // PROBLEM: Xerces is apparently _not_ calling the ErrorHandler for<a name="line.418"></a>
<FONT color="green">419</FONT> // exceptions thrown by the ContentHandler, which prevents us from<a name="line.419"></a>
<FONT color="green">420</FONT> // handling this properly when running in filtering mode with Xerces<a name="line.420"></a>
<FONT color="green">421</FONT> // as our event source. It's unclear whether this is a Xerces bug<a name="line.421"></a>
<FONT color="green">422</FONT> // or a SAX design flaw.<a name="line.422"></a>
<FONT color="green">423</FONT> // <a name="line.423"></a>
<FONT color="green">424</FONT> // %REVIEW% Current solution: In filtering mode, it is REQUIRED that<a name="line.424"></a>
<FONT color="green">425</FONT> // event source make sure this method is invoked if the event stream<a name="line.425"></a>
<FONT color="green">426</FONT> // abends before endDocument is delivered. If that means explicitly calling<a name="line.426"></a>
<FONT color="green">427</FONT> // us in the exception handling code because it won't be delivered as part<a name="line.427"></a>
<FONT color="green">428</FONT> // of the normal SAX ErrorHandler stream, that's fine; Not Our Problem.<a name="line.428"></a>
<FONT color="green">429</FONT> //<a name="line.429"></a>
<FONT color="green">430</FONT> public void error(SAXParseException exception) throws SAXException<a name="line.430"></a>
<FONT color="green">431</FONT> {<a name="line.431"></a>
<FONT color="green">432</FONT> if(null!=clientErrorHandler)<a name="line.432"></a>
<FONT color="green">433</FONT> clientErrorHandler.error(exception);<a name="line.433"></a>
<FONT color="green">434</FONT> }<a name="line.434"></a>
<FONT color="green">435</FONT> <a name="line.435"></a>
<FONT color="green">436</FONT> public void fatalError(SAXParseException exception) throws SAXException<a name="line.436"></a>
<FONT color="green">437</FONT> {<a name="line.437"></a>
<FONT color="green">438</FONT> // EXCEPTION: In this case we need to run the event BEFORE we yield --<a name="line.438"></a>
<FONT color="green">439</FONT> // just as with endDocument, this terminates the event stream.<a name="line.439"></a>
<FONT color="green">440</FONT> if(null!=clientErrorHandler)<a name="line.440"></a>
<FONT color="green">441</FONT> clientErrorHandler.error(exception);<a name="line.441"></a>
<FONT color="green">442</FONT> <a name="line.442"></a>
<FONT color="green">443</FONT> eventcounter=0; <a name="line.443"></a>
<FONT color="green">444</FONT> co_yield(false);<a name="line.444"></a>
<FONT color="green">445</FONT> <a name="line.445"></a>
<FONT color="green">446</FONT> }<a name="line.446"></a>
<FONT color="green">447</FONT> <a name="line.447"></a>
<FONT color="green">448</FONT> public void warning(SAXParseException exception) throws SAXException<a name="line.448"></a>
<FONT color="green">449</FONT> {<a name="line.449"></a>
<FONT color="green">450</FONT> if(null!=clientErrorHandler)<a name="line.450"></a>
<FONT color="green">451</FONT> clientErrorHandler.error(exception);<a name="line.451"></a>
<FONT color="green">452</FONT> }<a name="line.452"></a>
<FONT color="green">453</FONT> <a name="line.453"></a>
<FONT color="green">454</FONT> <a name="line.454"></a>
<FONT color="green">455</FONT> //<a name="line.455"></a>
<FONT color="green">456</FONT> // coroutine support<a name="line.456"></a>
<FONT color="green">457</FONT> //<a name="line.457"></a>
<FONT color="green">458</FONT> <a name="line.458"></a>
<FONT color="green">459</FONT> public int getSourceCoroutineID() {<a name="line.459"></a>
<FONT color="green">460</FONT> return fSourceCoroutineID;<a name="line.460"></a>
<FONT color="green">461</FONT> }<a name="line.461"></a>
<FONT color="green">462</FONT> public int getControllerCoroutineID() {<a name="line.462"></a>
<FONT color="green">463</FONT> return fControllerCoroutineID;<a name="line.463"></a>
<FONT color="green">464</FONT> }<a name="line.464"></a>
<FONT color="green">465</FONT> <a name="line.465"></a>
<FONT color="green">466</FONT> /** @return the CoroutineManager this CoroutineFilter object is bound to.<a name="line.466"></a>
<FONT color="green">467</FONT> * If you're using the do...() methods, applications should only<a name="line.467"></a>
<FONT color="green">468</FONT> * need to talk to the CoroutineManager once, to obtain the<a name="line.468"></a>
<FONT color="green">469</FONT> * application's Coroutine ID.<a name="line.469"></a>
<FONT color="green">470</FONT> * */<a name="line.470"></a>
<FONT color="green">471</FONT> public CoroutineManager getCoroutineManager()<a name="line.471"></a>
<FONT color="green">472</FONT> {<a name="line.472"></a>
<FONT color="green">473</FONT> return fCoroutineManager;<a name="line.473"></a>
<FONT color="green">474</FONT> }<a name="line.474"></a>
<FONT color="green">475</FONT> <a name="line.475"></a>
<FONT color="green">476</FONT> /** &lt;p&gt;In the SAX delegation code, I've inlined the count-down in<a name="line.476"></a>
<FONT color="green">477</FONT> * the hope of encouraging compilers to deliver better<a name="line.477"></a>
<FONT color="green">478</FONT> * performance. However, if we subclass (eg to directly connect the<a name="line.478"></a>
<FONT color="green">479</FONT> * output to a DTM builder), that would require calling super in<a name="line.479"></a>
<FONT color="green">480</FONT> * order to run that logic... which seems inelegant. Hence this<a name="line.480"></a>
<FONT color="green">481</FONT> * routine for the convenience of subclasses: every [frequency]<a name="line.481"></a>
<FONT color="green">482</FONT> * invocations, issue a co_yield.&lt;/p&gt;<a name="line.482"></a>
<FONT color="green">483</FONT> *<a name="line.483"></a>
<FONT color="green">484</FONT> * @param moreExepected Should always be true unless this is being called<a name="line.484"></a>
<FONT color="green">485</FONT> * at the end of endDocument() handling.<a name="line.485"></a>
<FONT color="green">486</FONT> * */<a name="line.486"></a>
<FONT color="green">487</FONT> protected void count_and_yield(boolean moreExpected) throws SAXException<a name="line.487"></a>
<FONT color="green">488</FONT> {<a name="line.488"></a>
<FONT color="green">489</FONT> if(!moreExpected) eventcounter=0;<a name="line.489"></a>
<FONT color="green">490</FONT> <a name="line.490"></a>
<FONT color="green">491</FONT> if(--eventcounter&lt;=0)<a name="line.491"></a>
<FONT color="green">492</FONT> {<a name="line.492"></a>
<FONT color="green">493</FONT> co_yield(true);<a name="line.493"></a>
<FONT color="green">494</FONT> eventcounter=frequency;<a name="line.494"></a>
<FONT color="green">495</FONT> }<a name="line.495"></a>
<FONT color="green">496</FONT> }<a name="line.496"></a>
<FONT color="green">497</FONT> <a name="line.497"></a>
<FONT color="green">498</FONT> /**<a name="line.498"></a>
<FONT color="green">499</FONT> * co_entry_pause is called in startDocument() before anything else<a name="line.499"></a>
<FONT color="green">500</FONT> * happens. It causes the filter to wait for a "go ahead" request<a name="line.500"></a>
<FONT color="green">501</FONT> * from the controller before delivering any events. Note that<a name="line.501"></a>
<FONT color="green">502</FONT> * the very first thing the controller tells us may be "I don't<a name="line.502"></a>
<FONT color="green">503</FONT> * need events after all"!<a name="line.503"></a>
<FONT color="green">504</FONT> */<a name="line.504"></a>
<FONT color="green">505</FONT> private void co_entry_pause() throws SAXException<a name="line.505"></a>
<FONT color="green">506</FONT> {<a name="line.506"></a>
<FONT color="green">507</FONT> if(fCoroutineManager==null)<a name="line.507"></a>
<FONT color="green">508</FONT> {<a name="line.508"></a>
<FONT color="green">509</FONT> // Nobody called init()? Do it now...<a name="line.509"></a>
<FONT color="green">510</FONT> init(null,-1,-1);<a name="line.510"></a>
<FONT color="green">511</FONT> }<a name="line.511"></a>
<FONT color="green">512</FONT> <a name="line.512"></a>
<FONT color="green">513</FONT> try<a name="line.513"></a>
<FONT color="green">514</FONT> {<a name="line.514"></a>
<FONT color="green">515</FONT> Object arg=fCoroutineManager.co_entry_pause(fSourceCoroutineID);<a name="line.515"></a>
<FONT color="green">516</FONT> if(arg==Boolean.FALSE)<a name="line.516"></a>
<FONT color="green">517</FONT> co_yield(false);<a name="line.517"></a>
<FONT color="green">518</FONT> }<a name="line.518"></a>
<FONT color="green">519</FONT> catch(NoSuchMethodException e)<a name="line.519"></a>
<FONT color="green">520</FONT> {<a name="line.520"></a>
<FONT color="green">521</FONT> // Coroutine system says we haven't registered. That's an<a name="line.521"></a>
<FONT color="green">522</FONT> // application coding error, and is unrecoverable.<a name="line.522"></a>
<FONT color="green">523</FONT> if(DEBUG) e.printStackTrace();<a name="line.523"></a>
<FONT color="green">524</FONT> throw new SAXException(e);<a name="line.524"></a>
<FONT color="green">525</FONT> }<a name="line.525"></a>
<FONT color="green">526</FONT> }<a name="line.526"></a>
<FONT color="green">527</FONT> <a name="line.527"></a>
<FONT color="green">528</FONT> /**<a name="line.528"></a>
<FONT color="green">529</FONT> * Co_Yield handles coroutine interactions while a parse is in progress.<a name="line.529"></a>
<FONT color="green">530</FONT> *<a name="line.530"></a>
<FONT color="green">531</FONT> * When moreRemains==true, we are pausing after delivering events, to<a name="line.531"></a>
<FONT color="green">532</FONT> * ask if more are needed. We will resume the controller thread with <a name="line.532"></a>
<FONT color="green">533</FONT> * co_resume(Boolean.TRUE, ...)<a name="line.533"></a>
<FONT color="green">534</FONT> * When control is passed back it may indicate<a name="line.534"></a>
<FONT color="green">535</FONT> * Boolean.TRUE indication to continue delivering events<a name="line.535"></a>
<FONT color="green">536</FONT> * Boolean.FALSE indication to discontinue events and shut down.<a name="line.536"></a>
<FONT color="green">537</FONT> * <a name="line.537"></a>
<FONT color="green">538</FONT> * When moreRemains==false, we shut down immediately without asking the<a name="line.538"></a>
<FONT color="green">539</FONT> * controller's permission. Normally this means end of document has been<a name="line.539"></a>
<FONT color="green">540</FONT> * reached.<a name="line.540"></a>
<FONT color="green">541</FONT> *<a name="line.541"></a>
<FONT color="green">542</FONT> * Shutting down a IncrementalSAXSource_Filter requires terminating the incoming<a name="line.542"></a>
<FONT color="green">543</FONT> * SAX event stream. If we are in control of that stream (if it came<a name="line.543"></a>
<FONT color="green">544</FONT> * from an XMLReader passed to our startReader() method), we can do so<a name="line.544"></a>
<FONT color="green">545</FONT> * very quickly by throwing a reserved exception to it. If the stream is<a name="line.545"></a>
<FONT color="green">546</FONT> * coming from another source, we can't do that because its caller may<a name="line.546"></a>
<FONT color="green">547</FONT> * not be prepared for this "normal abnormal exit", and instead we put<a name="line.547"></a>
<FONT color="green">548</FONT> * ourselves in a "spin" mode where events are discarded.<a name="line.548"></a>
<FONT color="green">549</FONT> */<a name="line.549"></a>
<FONT color="green">550</FONT> private void co_yield(boolean moreRemains) throws SAXException<a name="line.550"></a>
<FONT color="green">551</FONT> {<a name="line.551"></a>
<FONT color="green">552</FONT> // Horrendous kluge to run filter to completion. See below.<a name="line.552"></a>
<FONT color="green">553</FONT> if(fNoMoreEvents)<a name="line.553"></a>
<FONT color="green">554</FONT> return;<a name="line.554"></a>
<FONT color="green">555</FONT> <a name="line.555"></a>
<FONT color="green">556</FONT> try // Coroutine manager might throw no-such.<a name="line.556"></a>
<FONT color="green">557</FONT> {<a name="line.557"></a>
<FONT color="green">558</FONT> Object arg=Boolean.FALSE;<a name="line.558"></a>
<FONT color="green">559</FONT> if(moreRemains)<a name="line.559"></a>
<FONT color="green">560</FONT> {<a name="line.560"></a>
<FONT color="green">561</FONT> // Yield control, resume parsing when done<a name="line.561"></a>
<FONT color="green">562</FONT> arg = fCoroutineManager.co_resume(Boolean.TRUE, fSourceCoroutineID,<a name="line.562"></a>
<FONT color="green">563</FONT> fControllerCoroutineID);<a name="line.563"></a>
<FONT color="green">564</FONT> <a name="line.564"></a>
<FONT color="green">565</FONT> }<a name="line.565"></a>
<FONT color="green">566</FONT> <a name="line.566"></a>
<FONT color="green">567</FONT> // If we're at end of document or were told to stop early<a name="line.567"></a>
<FONT color="green">568</FONT> if(arg==Boolean.FALSE)<a name="line.568"></a>
<FONT color="green">569</FONT> {<a name="line.569"></a>
<FONT color="green">570</FONT> fNoMoreEvents=true;<a name="line.570"></a>
<FONT color="green">571</FONT> <a name="line.571"></a>
<FONT color="green">572</FONT> if(fXMLReader!=null) // Running under startParseThread()<a name="line.572"></a>
<FONT color="green">573</FONT> throw new StopException(); // We'll co_exit from there.<a name="line.573"></a>
<FONT color="green">574</FONT> <a name="line.574"></a>
<FONT color="green">575</FONT> // Yield control. We do NOT expect anyone to ever ask us again.<a name="line.575"></a>
<FONT color="green">576</FONT> fCoroutineManager.co_exit_to(Boolean.FALSE, fSourceCoroutineID,<a name="line.576"></a>
<FONT color="green">577</FONT> fControllerCoroutineID);<a name="line.577"></a>
<FONT color="green">578</FONT> }<a name="line.578"></a>
<FONT color="green">579</FONT> }<a name="line.579"></a>
<FONT color="green">580</FONT> catch(NoSuchMethodException e)<a name="line.580"></a>
<FONT color="green">581</FONT> {<a name="line.581"></a>
<FONT color="green">582</FONT> // Shouldn't happen unless we've miscoded our coroutine logic<a name="line.582"></a>
<FONT color="green">583</FONT> // "Shut down the garbage smashers on the detention level!"<a name="line.583"></a>
<FONT color="green">584</FONT> fNoMoreEvents=true;<a name="line.584"></a>
<FONT color="green">585</FONT> fCoroutineManager.co_exit(fSourceCoroutineID);<a name="line.585"></a>
<FONT color="green">586</FONT> throw new SAXException(e);<a name="line.586"></a>
<FONT color="green">587</FONT> }<a name="line.587"></a>
<FONT color="green">588</FONT> }<a name="line.588"></a>
<FONT color="green">589</FONT> <a name="line.589"></a>
<FONT color="green">590</FONT> //<a name="line.590"></a>
<FONT color="green">591</FONT> // Convenience: Run an XMLReader in a thread<a name="line.591"></a>
<FONT color="green">592</FONT> //<a name="line.592"></a>
<FONT color="green">593</FONT> <a name="line.593"></a>
<FONT color="green">594</FONT> /** Launch a thread that will run an XMLReader's parse() operation within<a name="line.594"></a>
<FONT color="green">595</FONT> * a thread, feeding events to this IncrementalSAXSource_Filter. Mostly a convenience<a name="line.595"></a>
<FONT color="green">596</FONT> * routine, but has the advantage that -- since we invoked parse() --<a name="line.596"></a>
<FONT color="green">597</FONT> * we can halt parsing quickly via a StopException rather than waiting<a name="line.597"></a>
<FONT color="green">598</FONT> * for the SAX stream to end by itself.<a name="line.598"></a>
<FONT color="green">599</FONT> *<a name="line.599"></a>
<FONT color="green">600</FONT> * @throws SAXException is parse thread is already in progress<a name="line.600"></a>
<FONT color="green">601</FONT> * or parsing can not be started.<a name="line.601"></a>
<FONT color="green">602</FONT> * */<a name="line.602"></a>
<FONT color="green">603</FONT> public void startParse(InputSource source) throws SAXException<a name="line.603"></a>
<FONT color="green">604</FONT> {<a name="line.604"></a>
<FONT color="green">605</FONT> if(fNoMoreEvents)<a name="line.605"></a>
<FONT color="green">606</FONT> throw new SAXException(XMLMessages.createXMLMessage(XMLErrorResources.ER_INCRSAXSRCFILTER_NOT_RESTARTABLE, null)); //"IncrmentalSAXSource_Filter not currently restartable.");<a name="line.606"></a>
<FONT color="green">607</FONT> if(fXMLReader==null)<a name="line.607"></a>
<FONT color="green">608</FONT> throw new SAXException(XMLMessages.createXMLMessage(XMLErrorResources.ER_XMLRDR_NOT_BEFORE_STARTPARSE, null)); //"XMLReader not before startParse request");<a name="line.608"></a>
<FONT color="green">609</FONT> <a name="line.609"></a>
<FONT color="green">610</FONT> fXMLReaderInputSource=source;<a name="line.610"></a>
<FONT color="green">611</FONT> <a name="line.611"></a>
<FONT color="green">612</FONT> // Xalan thread pooling...<a name="line.612"></a>
<FONT color="green">613</FONT> // org.apache.xalan.transformer.TransformerImpl.runTransformThread(this);<a name="line.613"></a>
<FONT color="green">614</FONT> ThreadControllerWrapper.runThread(this, -1);<a name="line.614"></a>
<FONT color="green">615</FONT> }<a name="line.615"></a>
<FONT color="green">616</FONT> <a name="line.616"></a>
<FONT color="green">617</FONT> /* Thread logic to support startParseThread()<a name="line.617"></a>
<FONT color="green">618</FONT> */<a name="line.618"></a>
<FONT color="green">619</FONT> public void run()<a name="line.619"></a>
<FONT color="green">620</FONT> {<a name="line.620"></a>
<FONT color="green">621</FONT> // Guard against direct invocation of start().<a name="line.621"></a>
<FONT color="green">622</FONT> if(fXMLReader==null) return;<a name="line.622"></a>
<FONT color="green">623</FONT> <a name="line.623"></a>
<FONT color="green">624</FONT> if(DEBUG)System.out.println("IncrementalSAXSource_Filter parse thread launched");<a name="line.624"></a>
<FONT color="green">625</FONT> <a name="line.625"></a>
<FONT color="green">626</FONT> // Initially assume we'll run successfully.<a name="line.626"></a>
<FONT color="green">627</FONT> Object arg=Boolean.FALSE;<a name="line.627"></a>
<FONT color="green">628</FONT> <a name="line.628"></a>
<FONT color="green">629</FONT> // For the duration of this operation, all coroutine handshaking<a name="line.629"></a>
<FONT color="green">630</FONT> // will occur in the co_yield method. That's the nice thing about<a name="line.630"></a>
<FONT color="green">631</FONT> // coroutines; they give us a way to hand off control from the<a name="line.631"></a>
<FONT color="green">632</FONT> // middle of a synchronous method.<a name="line.632"></a>
<FONT color="green">633</FONT> try<a name="line.633"></a>
<FONT color="green">634</FONT> {<a name="line.634"></a>
<FONT color="green">635</FONT> fXMLReader.parse(fXMLReaderInputSource);<a name="line.635"></a>
<FONT color="green">636</FONT> }<a name="line.636"></a>
<FONT color="green">637</FONT> catch(IOException ex)<a name="line.637"></a>
<FONT color="green">638</FONT> {<a name="line.638"></a>
<FONT color="green">639</FONT> arg=ex;<a name="line.639"></a>
<FONT color="green">640</FONT> }<a name="line.640"></a>
<FONT color="green">641</FONT> catch(StopException ex)<a name="line.641"></a>
<FONT color="green">642</FONT> {<a name="line.642"></a>
<FONT color="green">643</FONT> // Expected and harmless<a name="line.643"></a>
<FONT color="green">644</FONT> if(DEBUG)System.out.println("Active IncrementalSAXSource_Filter normal stop exception");<a name="line.644"></a>
<FONT color="green">645</FONT> }<a name="line.645"></a>
<FONT color="green">646</FONT> catch (SAXException ex)<a name="line.646"></a>
<FONT color="green">647</FONT> {<a name="line.647"></a>
<FONT color="green">648</FONT> Exception inner=ex.getException();<a name="line.648"></a>
<FONT color="green">649</FONT> if(inner instanceof StopException){<a name="line.649"></a>
<FONT color="green">650</FONT> // Expected and harmless<a name="line.650"></a>
<FONT color="green">651</FONT> if(DEBUG)System.out.println("Active IncrementalSAXSource_Filter normal stop exception");<a name="line.651"></a>
<FONT color="green">652</FONT> }<a name="line.652"></a>
<FONT color="green">653</FONT> else<a name="line.653"></a>
<FONT color="green">654</FONT> {<a name="line.654"></a>
<FONT color="green">655</FONT> // Unexpected malfunction<a name="line.655"></a>
<FONT color="green">656</FONT> if(DEBUG)<a name="line.656"></a>
<FONT color="green">657</FONT> {<a name="line.657"></a>
<FONT color="green">658</FONT> System.out.println("Active IncrementalSAXSource_Filter UNEXPECTED SAX exception: "+inner);<a name="line.658"></a>
<FONT color="green">659</FONT> inner.printStackTrace();<a name="line.659"></a>
<FONT color="green">660</FONT> } <a name="line.660"></a>
<FONT color="green">661</FONT> arg=ex;<a name="line.661"></a>
<FONT color="green">662</FONT> }<a name="line.662"></a>
<FONT color="green">663</FONT> } // end parse<a name="line.663"></a>
<FONT color="green">664</FONT> <a name="line.664"></a>
<FONT color="green">665</FONT> // Mark as no longer running in thread.<a name="line.665"></a>
<FONT color="green">666</FONT> fXMLReader=null;<a name="line.666"></a>
<FONT color="green">667</FONT> <a name="line.667"></a>
<FONT color="green">668</FONT> try<a name="line.668"></a>
<FONT color="green">669</FONT> {<a name="line.669"></a>
<FONT color="green">670</FONT> // Mark as done and yield control to the controller coroutine<a name="line.670"></a>
<FONT color="green">671</FONT> fNoMoreEvents=true;<a name="line.671"></a>
<FONT color="green">672</FONT> fCoroutineManager.co_exit_to(arg, fSourceCoroutineID,<a name="line.672"></a>
<FONT color="green">673</FONT> fControllerCoroutineID);<a name="line.673"></a>
<FONT color="green">674</FONT> }<a name="line.674"></a>
<FONT color="green">675</FONT> catch(java.lang.NoSuchMethodException e)<a name="line.675"></a>
<FONT color="green">676</FONT> {<a name="line.676"></a>
<FONT color="green">677</FONT> // Shouldn't happen unless we've miscoded our coroutine logic<a name="line.677"></a>
<FONT color="green">678</FONT> // "CPO, shut down the garbage smashers on the detention level!"<a name="line.678"></a>
<FONT color="green">679</FONT> e.printStackTrace(System.err);<a name="line.679"></a>
<FONT color="green">680</FONT> fCoroutineManager.co_exit(fSourceCoroutineID);<a name="line.680"></a>
<FONT color="green">681</FONT> }<a name="line.681"></a>
<FONT color="green">682</FONT> }<a name="line.682"></a>
<FONT color="green">683</FONT> <a name="line.683"></a>
<FONT color="green">684</FONT> /** Used to quickly terminate parse when running under a<a name="line.684"></a>
<FONT color="green">685</FONT> startParse() thread. Only its type is important. */<a name="line.685"></a>
<FONT color="green">686</FONT> static class StopException extends RuntimeException<a name="line.686"></a>
<FONT color="green">687</FONT> {<a name="line.687"></a>
<FONT color="green">688</FONT> static final long serialVersionUID = -1129245796185754956L;<a name="line.688"></a>
<FONT color="green">689</FONT> }<a name="line.689"></a>
<FONT color="green">690</FONT> <a name="line.690"></a>
<FONT color="green">691</FONT> /** deliverMoreNodes() is a simple API which tells the coroutine<a name="line.691"></a>
<FONT color="green">692</FONT> * parser that we need more nodes. This is intended to be called<a name="line.692"></a>
<FONT color="green">693</FONT> * from one of our partner routines, and serves to encapsulate the<a name="line.693"></a>
<FONT color="green">694</FONT> * details of how incremental parsing has been achieved.<a name="line.694"></a>
<FONT color="green">695</FONT> *<a name="line.695"></a>
<FONT color="green">696</FONT> * @param parsemore If true, tells the incremental filter to generate<a name="line.696"></a>
<FONT color="green">697</FONT> * another chunk of output. If false, tells the filter that we're<a name="line.697"></a>
<FONT color="green">698</FONT> * satisfied and it can terminate parsing of this document.<a name="line.698"></a>
<FONT color="green">699</FONT> *<a name="line.699"></a>
<FONT color="green">700</FONT> * @return Boolean.TRUE if there may be more events available by invoking<a name="line.700"></a>
<FONT color="green">701</FONT> * deliverMoreNodes() again. Boolean.FALSE if parsing has run to completion (or been<a name="line.701"></a>
<FONT color="green">702</FONT> * terminated by deliverMoreNodes(false). Or an exception object if something<a name="line.702"></a>
<FONT color="green">703</FONT> * malfunctioned. %REVIEW% We _could_ actually throw the exception, but<a name="line.703"></a>
<FONT color="green">704</FONT> * that would require runinng deliverMoreNodes() in a try/catch... and for many<a name="line.704"></a>
<FONT color="green">705</FONT> * applications, exception will be simply be treated as "not TRUE" in<a name="line.705"></a>
<FONT color="green">706</FONT> * any case.<a name="line.706"></a>
<FONT color="green">707</FONT> * */<a name="line.707"></a>
<FONT color="green">708</FONT> public Object deliverMoreNodes(boolean parsemore)<a name="line.708"></a>
<FONT color="green">709</FONT> {<a name="line.709"></a>
<FONT color="green">710</FONT> // If parsing is already done, we can immediately say so<a name="line.710"></a>
<FONT color="green">711</FONT> if(fNoMoreEvents)<a name="line.711"></a>
<FONT color="green">712</FONT> return Boolean.FALSE;<a name="line.712"></a>
<FONT color="green">713</FONT> <a name="line.713"></a>
<FONT color="green">714</FONT> try <a name="line.714"></a>
<FONT color="green">715</FONT> {<a name="line.715"></a>
<FONT color="green">716</FONT> Object result =<a name="line.716"></a>
<FONT color="green">717</FONT> fCoroutineManager.co_resume(parsemore?Boolean.TRUE:Boolean.FALSE,<a name="line.717"></a>
<FONT color="green">718</FONT> fControllerCoroutineID, fSourceCoroutineID);<a name="line.718"></a>
<FONT color="green">719</FONT> if(result==Boolean.FALSE)<a name="line.719"></a>
<FONT color="green">720</FONT> fCoroutineManager.co_exit(fControllerCoroutineID);<a name="line.720"></a>
<FONT color="green">721</FONT> <a name="line.721"></a>
<FONT color="green">722</FONT> return result;<a name="line.722"></a>
<FONT color="green">723</FONT> }<a name="line.723"></a>
<FONT color="green">724</FONT> <a name="line.724"></a>
<FONT color="green">725</FONT> // SHOULD NEVER OCCUR, since the coroutine number and coroutine manager<a name="line.725"></a>
<FONT color="green">726</FONT> // are those previously established for this IncrementalSAXSource_Filter...<a name="line.726"></a>
<FONT color="green">727</FONT> // So I'm just going to return it as a parsing exception, for now.<a name="line.727"></a>
<FONT color="green">728</FONT> catch(NoSuchMethodException e)<a name="line.728"></a>
<FONT color="green">729</FONT> {<a name="line.729"></a>
<FONT color="green">730</FONT> return e;<a name="line.730"></a>
<FONT color="green">731</FONT> }<a name="line.731"></a>
<FONT color="green">732</FONT> }<a name="line.732"></a>
<FONT color="green">733</FONT> <a name="line.733"></a>
<FONT color="green">734</FONT> <a name="line.734"></a>
<FONT color="green">735</FONT> //================================================================<a name="line.735"></a>
<FONT color="green">736</FONT> /** Simple unit test. Attempt coroutine parsing of document indicated<a name="line.736"></a>
<FONT color="green">737</FONT> * by first argument (as a URI), report progress.<a name="line.737"></a>
<FONT color="green">738</FONT> */<a name="line.738"></a>
<FONT color="green">739</FONT> /*<a name="line.739"></a>
<FONT color="green">740</FONT> public static void main(String args[])<a name="line.740"></a>
<FONT color="green">741</FONT> {<a name="line.741"></a>
<FONT color="green">742</FONT> System.out.println("Starting...");<a name="line.742"></a>
<FONT color="green">743</FONT> <a name="line.743"></a>
<FONT color="green">744</FONT> org.xml.sax.XMLReader theSAXParser=<a name="line.744"></a>
<FONT color="green">745</FONT> new org.apache.xerces.parsers.SAXParser();<a name="line.745"></a>
<FONT color="green">746</FONT> <a name="line.746"></a>
<FONT color="green">747</FONT> <a name="line.747"></a>
<FONT color="green">748</FONT> for(int arg=0;arg&lt;args.length;++arg)<a name="line.748"></a>
<FONT color="green">749</FONT> {<a name="line.749"></a>
<FONT color="green">750</FONT> // The filter is not currently designed to be restartable<a name="line.750"></a>
<FONT color="green">751</FONT> // after a parse has ended. Generate a new one each time.<a name="line.751"></a>
<FONT color="green">752</FONT> IncrementalSAXSource_Filter filter=<a name="line.752"></a>
<FONT color="green">753</FONT> new IncrementalSAXSource_Filter();<a name="line.753"></a>
<FONT color="green">754</FONT> // Use a serializer as our sample output<a name="line.754"></a>
<FONT color="green">755</FONT> org.apache.xml.serialize.XMLSerializer trace;<a name="line.755"></a>
<FONT color="green">756</FONT> trace=new org.apache.xml.serialize.XMLSerializer(System.out,null);<a name="line.756"></a>
<FONT color="green">757</FONT> filter.setContentHandler(trace);<a name="line.757"></a>
<FONT color="green">758</FONT> filter.setLexicalHandler(trace);<a name="line.758"></a>
<FONT color="green">759</FONT> <a name="line.759"></a>
<FONT color="green">760</FONT> try<a name="line.760"></a>
<FONT color="green">761</FONT> {<a name="line.761"></a>
<FONT color="green">762</FONT> InputSource source = new InputSource(args[arg]);<a name="line.762"></a>
<FONT color="green">763</FONT> Object result=null;<a name="line.763"></a>
<FONT color="green">764</FONT> boolean more=true;<a name="line.764"></a>
<FONT color="green">765</FONT> <a name="line.765"></a>
<FONT color="green">766</FONT> // init not issued; we _should_ automagically Do The Right Thing<a name="line.766"></a>
<FONT color="green">767</FONT> <a name="line.767"></a>
<FONT color="green">768</FONT> // Bind parser, kick off parsing in a thread<a name="line.768"></a>
<FONT color="green">769</FONT> filter.setXMLReader(theSAXParser);<a name="line.769"></a>
<FONT color="green">770</FONT> filter.startParse(source);<a name="line.770"></a>
<FONT color="green">771</FONT> <a name="line.771"></a>
<FONT color="green">772</FONT> for(result = filter.deliverMoreNodes(more);<a name="line.772"></a>
<FONT color="green">773</FONT> (result instanceof Boolean &amp;&amp; ((Boolean)result)==Boolean.TRUE);<a name="line.773"></a>
<FONT color="green">774</FONT> result = filter.deliverMoreNodes(more))<a name="line.774"></a>
<FONT color="green">775</FONT> {<a name="line.775"></a>
<FONT color="green">776</FONT> System.out.println("\nSome parsing successful, trying more.\n");<a name="line.776"></a>
<FONT color="green">777</FONT> <a name="line.777"></a>
<FONT color="green">778</FONT> // Special test: Terminate parsing early.<a name="line.778"></a>
<FONT color="green">779</FONT> if(arg+1&lt;args.length &amp;&amp; "!".equals(args[arg+1]))<a name="line.779"></a>
<FONT color="green">780</FONT> {<a name="line.780"></a>
<FONT color="green">781</FONT> ++arg;<a name="line.781"></a>
<FONT color="green">782</FONT> more=false;<a name="line.782"></a>
<FONT color="green">783</FONT> }<a name="line.783"></a>
<FONT color="green">784</FONT> <a name="line.784"></a>
<FONT color="green">785</FONT> }<a name="line.785"></a>
<FONT color="green">786</FONT> <a name="line.786"></a>
<FONT color="green">787</FONT> if (result instanceof Boolean &amp;&amp; ((Boolean)result)==Boolean.FALSE)<a name="line.787"></a>
<FONT color="green">788</FONT> {<a name="line.788"></a>
<FONT color="green">789</FONT> System.out.println("\nFilter ended (EOF or on request).\n");<a name="line.789"></a>
<FONT color="green">790</FONT> }<a name="line.790"></a>
<FONT color="green">791</FONT> else if (result == null) {<a name="line.791"></a>
<FONT color="green">792</FONT> System.out.println("\nUNEXPECTED: Filter says shut down prematurely.\n");<a name="line.792"></a>
<FONT color="green">793</FONT> }<a name="line.793"></a>
<FONT color="green">794</FONT> else if (result instanceof Exception) {<a name="line.794"></a>
<FONT color="green">795</FONT> System.out.println("\nFilter threw exception:");<a name="line.795"></a>
<FONT color="green">796</FONT> ((Exception)result).printStackTrace();<a name="line.796"></a>
<FONT color="green">797</FONT> }<a name="line.797"></a>
<FONT color="green">798</FONT> <a name="line.798"></a>
<FONT color="green">799</FONT> }<a name="line.799"></a>
<FONT color="green">800</FONT> catch(SAXException e)<a name="line.800"></a>
<FONT color="green">801</FONT> {<a name="line.801"></a>
<FONT color="green">802</FONT> e.printStackTrace();<a name="line.802"></a>
<FONT color="green">803</FONT> }<a name="line.803"></a>
<FONT color="green">804</FONT> } // end for<a name="line.804"></a>
<FONT color="green">805</FONT> }<a name="line.805"></a>
<FONT color="green">806</FONT> */ <a name="line.806"></a>
<FONT color="green">807</FONT> } // class IncrementalSAXSource_Filter<a name="line.807"></a>
</PRE>
</BODY>
</HTML>