| <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: DTMManager.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;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.xml.res.XMLErrorResources;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.xml.res.XMLMessages;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.xml.utils.PrefixResolver;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.xml.utils.XMLStringFactory;<a name="line.26"></a> |
| <FONT color="green">027</FONT> <a name="line.27"></a> |
| <FONT color="green">028</FONT> /**<a name="line.28"></a> |
| <FONT color="green">029</FONT> * A DTMManager instance can be used to create DTM and<a name="line.29"></a> |
| <FONT color="green">030</FONT> * DTMIterator objects, and manage the DTM objects in the system.<a name="line.30"></a> |
| <FONT color="green">031</FONT> *<a name="line.31"></a> |
| <FONT color="green">032</FONT> * <p>The system property that determines which Factory implementation<a name="line.32"></a> |
| <FONT color="green">033</FONT> * to create is named "org.apache.xml.utils.DTMFactory". This<a name="line.33"></a> |
| <FONT color="green">034</FONT> * property names a concrete subclass of the DTMFactory abstract<a name="line.34"></a> |
| <FONT color="green">035</FONT> * class. If the property is not defined, a platform default is be used.</p><a name="line.35"></a> |
| <FONT color="green">036</FONT> *<a name="line.36"></a> |
| <FONT color="green">037</FONT> * <p>An instance of this class <emph>must</emph> be safe to use across<a name="line.37"></a> |
| <FONT color="green">038</FONT> * thread instances. It is expected that a client will create a single instance<a name="line.38"></a> |
| <FONT color="green">039</FONT> * of a DTMManager to use across multiple threads. This will allow sharing<a name="line.39"></a> |
| <FONT color="green">040</FONT> * of DTMs across multiple processes.</p><a name="line.40"></a> |
| <FONT color="green">041</FONT> *<a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p>Note: this class is incomplete right now. It will be pretty much<a name="line.42"></a> |
| <FONT color="green">043</FONT> * modeled after javax.xml.transform.TransformerFactory in terms of its<a name="line.43"></a> |
| <FONT color="green">044</FONT> * factory support.</p><a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <p>State: In progress!!</p><a name="line.46"></a> |
| <FONT color="green">047</FONT> */<a name="line.47"></a> |
| <FONT color="green">048</FONT> public abstract class DTMManager<a name="line.48"></a> |
| <FONT color="green">049</FONT> {<a name="line.49"></a> |
| <FONT color="green">050</FONT> <a name="line.50"></a> |
| <FONT color="green">051</FONT> /** The default property name to load the manager. */<a name="line.51"></a> |
| <FONT color="green">052</FONT> private static final String defaultPropName =<a name="line.52"></a> |
| <FONT color="green">053</FONT> "org.apache.xml.dtm.DTMManager";<a name="line.53"></a> |
| <FONT color="green">054</FONT> <a name="line.54"></a> |
| <FONT color="green">055</FONT> /** The default class name to use as the manager. */<a name="line.55"></a> |
| <FONT color="green">056</FONT> private static String defaultClassName =<a name="line.56"></a> |
| <FONT color="green">057</FONT> "org.apache.xml.dtm.ref.DTMManagerDefault";<a name="line.57"></a> |
| <FONT color="green">058</FONT> <a name="line.58"></a> |
| <FONT color="green">059</FONT> /**<a name="line.59"></a> |
| <FONT color="green">060</FONT> * Factory for creating XMLString objects.<a name="line.60"></a> |
| <FONT color="green">061</FONT> * %TBD% Make this set by the caller.<a name="line.61"></a> |
| <FONT color="green">062</FONT> */<a name="line.62"></a> |
| <FONT color="green">063</FONT> protected XMLStringFactory m_xsf = null;<a name="line.63"></a> |
| <FONT color="green">064</FONT> <a name="line.64"></a> |
| <FONT color="green">065</FONT> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Default constructor is protected on purpose.<a name="line.66"></a> |
| <FONT color="green">067</FONT> */<a name="line.67"></a> |
| <FONT color="green">068</FONT> protected DTMManager(){}<a name="line.68"></a> |
| <FONT color="green">069</FONT> <a name="line.69"></a> |
| <FONT color="green">070</FONT> /**<a name="line.70"></a> |
| <FONT color="green">071</FONT> * Get the XMLStringFactory used for the DTMs.<a name="line.71"></a> |
| <FONT color="green">072</FONT> *<a name="line.72"></a> |
| <FONT color="green">073</FONT> *<a name="line.73"></a> |
| <FONT color="green">074</FONT> * @return a valid XMLStringFactory object, or null if it hasn't been set yet.<a name="line.74"></a> |
| <FONT color="green">075</FONT> */<a name="line.75"></a> |
| <FONT color="green">076</FONT> public XMLStringFactory getXMLStringFactory()<a name="line.76"></a> |
| <FONT color="green">077</FONT> {<a name="line.77"></a> |
| <FONT color="green">078</FONT> return m_xsf;<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> * Set the XMLStringFactory used for the DTMs.<a name="line.82"></a> |
| <FONT color="green">083</FONT> *<a name="line.83"></a> |
| <FONT color="green">084</FONT> *<a name="line.84"></a> |
| <FONT color="green">085</FONT> * @param xsf a valid XMLStringFactory object, should not be null.<a name="line.85"></a> |
| <FONT color="green">086</FONT> */<a name="line.86"></a> |
| <FONT color="green">087</FONT> public void setXMLStringFactory(XMLStringFactory xsf)<a name="line.87"></a> |
| <FONT color="green">088</FONT> {<a name="line.88"></a> |
| <FONT color="green">089</FONT> m_xsf = xsf;<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> /**<a name="line.92"></a> |
| <FONT color="green">093</FONT> * Obtain a new instance of a <code>DTMManager</code>.<a name="line.93"></a> |
| <FONT color="green">094</FONT> * This static method creates a new factory instance<a name="line.94"></a> |
| <FONT color="green">095</FONT> * This method uses the following ordered lookup procedure to determine<a name="line.95"></a> |
| <FONT color="green">096</FONT> * the <code>DTMManager</code> implementation class to<a name="line.96"></a> |
| <FONT color="green">097</FONT> * load:<a name="line.97"></a> |
| <FONT color="green">098</FONT> * <ul><a name="line.98"></a> |
| <FONT color="green">099</FONT> * <li><a name="line.99"></a> |
| <FONT color="green">100</FONT> * Use the <code>org.apache.xml.dtm.DTMManager</code> system<a name="line.100"></a> |
| <FONT color="green">101</FONT> * property.<a name="line.101"></a> |
| <FONT color="green">102</FONT> * </li><a name="line.102"></a> |
| <FONT color="green">103</FONT> * <li><a name="line.103"></a> |
| <FONT color="green">104</FONT> * Use the JAVA_HOME(the parent directory where jdk is<a name="line.104"></a> |
| <FONT color="green">105</FONT> * installed)/lib/xalan.properties for a property file that contains the<a name="line.105"></a> |
| <FONT color="green">106</FONT> * name of the implementation class keyed on the same value as the<a name="line.106"></a> |
| <FONT color="green">107</FONT> * system property defined above.<a name="line.107"></a> |
| <FONT color="green">108</FONT> * </li><a name="line.108"></a> |
| <FONT color="green">109</FONT> * <li><a name="line.109"></a> |
| <FONT color="green">110</FONT> * Use the Services API (as detailed in the JAR specification), if<a name="line.110"></a> |
| <FONT color="green">111</FONT> * available, to determine the classname. The Services API will look<a name="line.111"></a> |
| <FONT color="green">112</FONT> * for a classname in the file<a name="line.112"></a> |
| <FONT color="green">113</FONT> * <code>META-INF/services/org.apache.xml.dtm.DTMManager</code><a name="line.113"></a> |
| <FONT color="green">114</FONT> * in jars available to the runtime.<a name="line.114"></a> |
| <FONT color="green">115</FONT> * </li><a name="line.115"></a> |
| <FONT color="green">116</FONT> * <li><a name="line.116"></a> |
| <FONT color="green">117</FONT> * Use the default <code>DTMManager</code> classname, which is<a name="line.117"></a> |
| <FONT color="green">118</FONT> * <code>org.apache.xml.dtm.ref.DTMManagerDefault</code>.<a name="line.118"></a> |
| <FONT color="green">119</FONT> * </li><a name="line.119"></a> |
| <FONT color="green">120</FONT> * </ul><a name="line.120"></a> |
| <FONT color="green">121</FONT> *<a name="line.121"></a> |
| <FONT color="green">122</FONT> * Once an application has obtained a reference to a <code><a name="line.122"></a> |
| <FONT color="green">123</FONT> * DTMManager</code> it can use the factory to configure<a name="line.123"></a> |
| <FONT color="green">124</FONT> * and obtain parser instances.<a name="line.124"></a> |
| <FONT color="green">125</FONT> *<a name="line.125"></a> |
| <FONT color="green">126</FONT> * @return new DTMManager instance, never null.<a name="line.126"></a> |
| <FONT color="green">127</FONT> *<a name="line.127"></a> |
| <FONT color="green">128</FONT> * @throws DTMConfigurationException<a name="line.128"></a> |
| <FONT color="green">129</FONT> * if the implementation is not available or cannot be instantiated.<a name="line.129"></a> |
| <FONT color="green">130</FONT> */<a name="line.130"></a> |
| <FONT color="green">131</FONT> public static DTMManager newInstance(XMLStringFactory xsf) <a name="line.131"></a> |
| <FONT color="green">132</FONT> throws DTMConfigurationException<a name="line.132"></a> |
| <FONT color="green">133</FONT> {<a name="line.133"></a> |
| <FONT color="green">134</FONT> DTMManager factoryImpl = null;<a name="line.134"></a> |
| <FONT color="green">135</FONT> try<a name="line.135"></a> |
| <FONT color="green">136</FONT> {<a name="line.136"></a> |
| <FONT color="green">137</FONT> factoryImpl = (DTMManager) ObjectFactory<a name="line.137"></a> |
| <FONT color="green">138</FONT> .createObject(defaultPropName, defaultClassName);<a name="line.138"></a> |
| <FONT color="green">139</FONT> }<a name="line.139"></a> |
| <FONT color="green">140</FONT> catch (ObjectFactory.ConfigurationError e)<a name="line.140"></a> |
| <FONT color="green">141</FONT> {<a name="line.141"></a> |
| <FONT color="green">142</FONT> throw new DTMConfigurationException(XMLMessages.createXMLMessage(<a name="line.142"></a> |
| <FONT color="green">143</FONT> XMLErrorResources.ER_NO_DEFAULT_IMPL, null), e.getException());<a name="line.143"></a> |
| <FONT color="green">144</FONT> //"No default implementation found");<a name="line.144"></a> |
| <FONT color="green">145</FONT> }<a name="line.145"></a> |
| <FONT color="green">146</FONT> <a name="line.146"></a> |
| <FONT color="green">147</FONT> if (factoryImpl == null)<a name="line.147"></a> |
| <FONT color="green">148</FONT> {<a name="line.148"></a> |
| <FONT color="green">149</FONT> throw new DTMConfigurationException(XMLMessages.createXMLMessage(<a name="line.149"></a> |
| <FONT color="green">150</FONT> XMLErrorResources.ER_NO_DEFAULT_IMPL, null));<a name="line.150"></a> |
| <FONT color="green">151</FONT> //"No default implementation found");<a name="line.151"></a> |
| <FONT color="green">152</FONT> }<a name="line.152"></a> |
| <FONT color="green">153</FONT> <a name="line.153"></a> |
| <FONT color="green">154</FONT> factoryImpl.setXMLStringFactory(xsf);<a name="line.154"></a> |
| <FONT color="green">155</FONT> <a name="line.155"></a> |
| <FONT color="green">156</FONT> return factoryImpl;<a name="line.156"></a> |
| <FONT color="green">157</FONT> }<a name="line.157"></a> |
| <FONT color="green">158</FONT> <a name="line.158"></a> |
| <FONT color="green">159</FONT> /**<a name="line.159"></a> |
| <FONT color="green">160</FONT> * Get an instance of a DTM, loaded with the content from the<a name="line.160"></a> |
| <FONT color="green">161</FONT> * specified source. If the unique flag is true, a new instance will<a name="line.161"></a> |
| <FONT color="green">162</FONT> * always be returned. Otherwise it is up to the DTMManager to return a<a name="line.162"></a> |
| <FONT color="green">163</FONT> * new instance or an instance that it already created and may be being used<a name="line.163"></a> |
| <FONT color="green">164</FONT> * by someone else.<a name="line.164"></a> |
| <FONT color="green">165</FONT> * <a name="line.165"></a> |
| <FONT color="green">166</FONT> * (More parameters may eventually need to be added for error handling<a name="line.166"></a> |
| <FONT color="green">167</FONT> * and entity resolution, and to better control selection of implementations.)<a name="line.167"></a> |
| <FONT color="green">168</FONT> *<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @param source the specification of the source object, which may be null,<a name="line.169"></a> |
| <FONT color="green">170</FONT> * in which case it is assumed that node construction will take<a name="line.170"></a> |
| <FONT color="green">171</FONT> * by some other means.<a name="line.171"></a> |
| <FONT color="green">172</FONT> * @param unique true if the returned DTM must be unique, probably because it<a name="line.172"></a> |
| <FONT color="green">173</FONT> * is going to be mutated.<a name="line.173"></a> |
| <FONT color="green">174</FONT> * @param whiteSpaceFilter Enables filtering of whitespace nodes, and may<a name="line.174"></a> |
| <FONT color="green">175</FONT> * be null.<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @param incremental true if the DTM should be built incrementally, if<a name="line.176"></a> |
| <FONT color="green">177</FONT> * possible.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param doIndexing true if the caller considers it worth it to use <a name="line.178"></a> |
| <FONT color="green">179</FONT> * indexing schemes.<a name="line.179"></a> |
| <FONT color="green">180</FONT> *<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @return a non-null DTM reference.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> public abstract DTM getDTM(javax.xml.transform.Source source,<a name="line.183"></a> |
| <FONT color="green">184</FONT> boolean unique, DTMWSFilter whiteSpaceFilter,<a name="line.184"></a> |
| <FONT color="green">185</FONT> boolean incremental, boolean doIndexing);<a name="line.185"></a> |
| <FONT color="green">186</FONT> <a name="line.186"></a> |
| <FONT color="green">187</FONT> /**<a name="line.187"></a> |
| <FONT color="green">188</FONT> * Get the instance of DTM that "owns" a node handle.<a name="line.188"></a> |
| <FONT color="green">189</FONT> *<a name="line.189"></a> |
| <FONT color="green">190</FONT> * @param nodeHandle the nodeHandle.<a name="line.190"></a> |
| <FONT color="green">191</FONT> *<a name="line.191"></a> |
| <FONT color="green">192</FONT> * @return a non-null DTM reference.<a name="line.192"></a> |
| <FONT color="green">193</FONT> */<a name="line.193"></a> |
| <FONT color="green">194</FONT> public abstract DTM getDTM(int nodeHandle);<a name="line.194"></a> |
| <FONT color="green">195</FONT> <a name="line.195"></a> |
| <FONT color="green">196</FONT> /**<a name="line.196"></a> |
| <FONT color="green">197</FONT> * Given a W3C DOM node, try and return a DTM handle.<a name="line.197"></a> |
| <FONT color="green">198</FONT> * Note: calling this may be non-optimal.<a name="line.198"></a> |
| <FONT color="green">199</FONT> *<a name="line.199"></a> |
| <FONT color="green">200</FONT> * @param node Non-null reference to a DOM node.<a name="line.200"></a> |
| <FONT color="green">201</FONT> *<a name="line.201"></a> |
| <FONT color="green">202</FONT> * @return a valid DTM handle.<a name="line.202"></a> |
| <FONT color="green">203</FONT> */<a name="line.203"></a> |
| <FONT color="green">204</FONT> public abstract int getDTMHandleFromNode(org.w3c.dom.Node node);<a name="line.204"></a> |
| <FONT color="green">205</FONT> <a name="line.205"></a> |
| <FONT color="green">206</FONT> /**<a name="line.206"></a> |
| <FONT color="green">207</FONT> * Creates a DTM representing an empty <code>DocumentFragment</code> object.<a name="line.207"></a> |
| <FONT color="green">208</FONT> * @return a non-null DTM reference.<a name="line.208"></a> |
| <FONT color="green">209</FONT> */<a name="line.209"></a> |
| <FONT color="green">210</FONT> public abstract DTM createDocumentFragment();<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> * Release a DTM either to a lru pool, or completely remove reference.<a name="line.213"></a> |
| <FONT color="green">214</FONT> * DTMs without system IDs are always hard deleted.<a name="line.214"></a> |
| <FONT color="green">215</FONT> * State: experimental.<a name="line.215"></a> |
| <FONT color="green">216</FONT> *<a name="line.216"></a> |
| <FONT color="green">217</FONT> * @param dtm The DTM to be released.<a name="line.217"></a> |
| <FONT color="green">218</FONT> * @param shouldHardDelete True if the DTM should be removed no matter what.<a name="line.218"></a> |
| <FONT color="green">219</FONT> * @return true if the DTM was removed, false if it was put back in a lru pool.<a name="line.219"></a> |
| <FONT color="green">220</FONT> */<a name="line.220"></a> |
| <FONT color="green">221</FONT> public abstract boolean release(DTM dtm, boolean shouldHardDelete);<a name="line.221"></a> |
| <FONT color="green">222</FONT> <a name="line.222"></a> |
| <FONT color="green">223</FONT> /**<a name="line.223"></a> |
| <FONT color="green">224</FONT> * Create a new <code>DTMIterator</code> based on an XPath<a name="line.224"></a> |
| <FONT color="green">225</FONT> * <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or<a name="line.225"></a> |
| <FONT color="green">226</FONT> * a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<a name="line.226"></a> |
| <FONT color="green">227</FONT> *<a name="line.227"></a> |
| <FONT color="green">228</FONT> * @param xpathCompiler ??? Somehow we need to pass in a subpart of the<a name="line.228"></a> |
| <FONT color="green">229</FONT> * expression. I hate to do this with strings, since the larger expression<a name="line.229"></a> |
| <FONT color="green">230</FONT> * has already been parsed.<a name="line.230"></a> |
| <FONT color="green">231</FONT> *<a name="line.231"></a> |
| <FONT color="green">232</FONT> * @param pos The position in the expression.<a name="line.232"></a> |
| <FONT color="green">233</FONT> * @return The newly created <code>DTMIterator</code>.<a name="line.233"></a> |
| <FONT color="green">234</FONT> */<a name="line.234"></a> |
| <FONT color="green">235</FONT> public abstract DTMIterator createDTMIterator(Object xpathCompiler,<a name="line.235"></a> |
| <FONT color="green">236</FONT> int pos);<a name="line.236"></a> |
| <FONT color="green">237</FONT> <a name="line.237"></a> |
| <FONT color="green">238</FONT> /**<a name="line.238"></a> |
| <FONT color="green">239</FONT> * Create a new <code>DTMIterator</code> based on an XPath<a name="line.239"></a> |
| <FONT color="green">240</FONT> * <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or<a name="line.240"></a> |
| <FONT color="green">241</FONT> * a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<a name="line.241"></a> |
| <FONT color="green">242</FONT> *<a name="line.242"></a> |
| <FONT color="green">243</FONT> * @param xpathString Must be a valid string expressing a<a name="line.243"></a> |
| <FONT color="green">244</FONT> * <a href="http://www.w3.org/TR/xpath#NT-LocationPath>LocationPath</a> or<a name="line.244"></a> |
| <FONT color="green">245</FONT> * a <a href="http://www.w3.org/TR/xpath#NT-UnionExpr">UnionExpr</a>.<a name="line.245"></a> |
| <FONT color="green">246</FONT> *<a name="line.246"></a> |
| <FONT color="green">247</FONT> * @param presolver An object that can resolve prefixes to namespace URLs.<a name="line.247"></a> |
| <FONT color="green">248</FONT> *<a name="line.248"></a> |
| <FONT color="green">249</FONT> * @return The newly created <code>DTMIterator</code>.<a name="line.249"></a> |
| <FONT color="green">250</FONT> */<a name="line.250"></a> |
| <FONT color="green">251</FONT> public abstract DTMIterator createDTMIterator(String xpathString,<a name="line.251"></a> |
| <FONT color="green">252</FONT> PrefixResolver presolver);<a name="line.252"></a> |
| <FONT color="green">253</FONT> <a name="line.253"></a> |
| <FONT color="green">254</FONT> /**<a name="line.254"></a> |
| <FONT color="green">255</FONT> * Create a new <code>DTMIterator</code> based only on a whatToShow<a name="line.255"></a> |
| <FONT color="green">256</FONT> * and a DTMFilter. The traversal semantics are defined as the<a name="line.256"></a> |
| <FONT color="green">257</FONT> * descendant access.<a name="line.257"></a> |
| <FONT color="green">258</FONT> * <p><a name="line.258"></a> |
| <FONT color="green">259</FONT> * Note that DTMIterators may not be an exact match to DOM<a name="line.259"></a> |
| <FONT color="green">260</FONT> * NodeIterators. They are initialized and used in much the same way<a name="line.260"></a> |
| <FONT color="green">261</FONT> * as a NodeIterator, but their response to document mutation is not<a name="line.261"></a> |
| <FONT color="green">262</FONT> * currently defined.<a name="line.262"></a> |
| <FONT color="green">263</FONT> *<a name="line.263"></a> |
| <FONT color="green">264</FONT> * @param whatToShow This flag specifies which node types may appear in<a name="line.264"></a> |
| <FONT color="green">265</FONT> * the logical view of the tree presented by the iterator. See the<a name="line.265"></a> |
| <FONT color="green">266</FONT> * description of <code>NodeFilter</code> for the set of possible<a name="line.266"></a> |
| <FONT color="green">267</FONT> * <code>SHOW_</code> values.These flags can be combined using<a name="line.267"></a> |
| <FONT color="green">268</FONT> * <code>OR</code>.<a name="line.268"></a> |
| <FONT color="green">269</FONT> * @param filter The <code>NodeFilter</code> to be used with this<a name="line.269"></a> |
| <FONT color="green">270</FONT> * <code>DTMFilter</code>, or <code>null</code> to indicate no filter.<a name="line.270"></a> |
| <FONT color="green">271</FONT> * @param entityReferenceExpansion The value of this flag determines<a name="line.271"></a> |
| <FONT color="green">272</FONT> * whether entity reference nodes are expanded.<a name="line.272"></a> |
| <FONT color="green">273</FONT> *<a name="line.273"></a> |
| <FONT color="green">274</FONT> * @return The newly created <code>DTMIterator</code>.<a name="line.274"></a> |
| <FONT color="green">275</FONT> */<a name="line.275"></a> |
| <FONT color="green">276</FONT> public abstract DTMIterator createDTMIterator(int whatToShow,<a name="line.276"></a> |
| <FONT color="green">277</FONT> DTMFilter filter, boolean entityReferenceExpansion);<a name="line.277"></a> |
| <FONT color="green">278</FONT> <a name="line.278"></a> |
| <FONT color="green">279</FONT> /**<a name="line.279"></a> |
| <FONT color="green">280</FONT> * Create a new <code>DTMIterator</code> that holds exactly one node.<a name="line.280"></a> |
| <FONT color="green">281</FONT> *<a name="line.281"></a> |
| <FONT color="green">282</FONT> * @param node The node handle that the DTMIterator will iterate to.<a name="line.282"></a> |
| <FONT color="green">283</FONT> *<a name="line.283"></a> |
| <FONT color="green">284</FONT> * @return The newly created <code>DTMIterator</code>.<a name="line.284"></a> |
| <FONT color="green">285</FONT> */<a name="line.285"></a> |
| <FONT color="green">286</FONT> public abstract DTMIterator createDTMIterator(int node);<a name="line.286"></a> |
| <FONT color="green">287</FONT> <a name="line.287"></a> |
| <FONT color="green">288</FONT> /* Flag indicating whether an incremental transform is desired */<a name="line.288"></a> |
| <FONT color="green">289</FONT> public boolean m_incremental = false;<a name="line.289"></a> |
| <FONT color="green">290</FONT> <a name="line.290"></a> |
| <FONT color="green">291</FONT> /*<a name="line.291"></a> |
| <FONT color="green">292</FONT> * Flag set by FEATURE_SOURCE_LOCATION.<a name="line.292"></a> |
| <FONT color="green">293</FONT> * This feature specifies whether the transformation phase should<a name="line.293"></a> |
| <FONT color="green">294</FONT> * keep track of line and column numbers for the input source<a name="line.294"></a> |
| <FONT color="green">295</FONT> * document. <a name="line.295"></a> |
| <FONT color="green">296</FONT> */<a name="line.296"></a> |
| <FONT color="green">297</FONT> public boolean m_source_location = false; <a name="line.297"></a> |
| <FONT color="green">298</FONT> <a name="line.298"></a> |
| <FONT color="green">299</FONT> /**<a name="line.299"></a> |
| <FONT color="green">300</FONT> * Get a flag indicating whether an incremental transform is desired <a name="line.300"></a> |
| <FONT color="green">301</FONT> * @return incremental boolean.<a name="line.301"></a> |
| <FONT color="green">302</FONT> *<a name="line.302"></a> |
| <FONT color="green">303</FONT> */<a name="line.303"></a> |
| <FONT color="green">304</FONT> public boolean getIncremental()<a name="line.304"></a> |
| <FONT color="green">305</FONT> {<a name="line.305"></a> |
| <FONT color="green">306</FONT> return m_incremental; <a name="line.306"></a> |
| <FONT color="green">307</FONT> }<a name="line.307"></a> |
| <FONT color="green">308</FONT> <a name="line.308"></a> |
| <FONT color="green">309</FONT> /**<a name="line.309"></a> |
| <FONT color="green">310</FONT> * Set a flag indicating whether an incremental transform is desired<a name="line.310"></a> |
| <FONT color="green">311</FONT> * This flag should have the same value as the FEATURE_INCREMENTAL feature<a name="line.311"></a> |
| <FONT color="green">312</FONT> * which is set by the TransformerFactory.setAttribut() method before a<a name="line.312"></a> |
| <FONT color="green">313</FONT> * DTMManager is created<a name="line.313"></a> |
| <FONT color="green">314</FONT> * @param incremental boolean to use to set m_incremental.<a name="line.314"></a> |
| <FONT color="green">315</FONT> *<a name="line.315"></a> |
| <FONT color="green">316</FONT> */<a name="line.316"></a> |
| <FONT color="green">317</FONT> public void setIncremental(boolean incremental)<a name="line.317"></a> |
| <FONT color="green">318</FONT> {<a name="line.318"></a> |
| <FONT color="green">319</FONT> m_incremental = incremental; <a name="line.319"></a> |
| <FONT color="green">320</FONT> }<a name="line.320"></a> |
| <FONT color="green">321</FONT> <a name="line.321"></a> |
| <FONT color="green">322</FONT> /**<a name="line.322"></a> |
| <FONT color="green">323</FONT> * Get a flag indicating whether the transformation phase should<a name="line.323"></a> |
| <FONT color="green">324</FONT> * keep track of line and column numbers for the input source<a name="line.324"></a> |
| <FONT color="green">325</FONT> * document.<a name="line.325"></a> |
| <FONT color="green">326</FONT> * @return source location boolean<a name="line.326"></a> |
| <FONT color="green">327</FONT> *<a name="line.327"></a> |
| <FONT color="green">328</FONT> */<a name="line.328"></a> |
| <FONT color="green">329</FONT> public boolean getSource_location()<a name="line.329"></a> |
| <FONT color="green">330</FONT> {<a name="line.330"></a> |
| <FONT color="green">331</FONT> return m_source_location; <a name="line.331"></a> |
| <FONT color="green">332</FONT> } <a name="line.332"></a> |
| <FONT color="green">333</FONT> <a name="line.333"></a> |
| <FONT color="green">334</FONT> /**<a name="line.334"></a> |
| <FONT color="green">335</FONT> * Set a flag indicating whether the transformation phase should<a name="line.335"></a> |
| <FONT color="green">336</FONT> * keep track of line and column numbers for the input source<a name="line.336"></a> |
| <FONT color="green">337</FONT> * document.<a name="line.337"></a> |
| <FONT color="green">338</FONT> * This flag should have the same value as the FEATURE_SOURCE_LOCATION feature<a name="line.338"></a> |
| <FONT color="green">339</FONT> * which is set by the TransformerFactory.setAttribut() method before a<a name="line.339"></a> |
| <FONT color="green">340</FONT> * DTMManager is created<a name="line.340"></a> |
| <FONT color="green">341</FONT> * @param sourceLocation boolean to use to set m_source_location<a name="line.341"></a> |
| <FONT color="green">342</FONT> */<a name="line.342"></a> |
| <FONT color="green">343</FONT> public void setSource_location(boolean sourceLocation){<a name="line.343"></a> |
| <FONT color="green">344</FONT> m_source_location = sourceLocation;<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> // -------------------- private methods --------------------<a name="line.348"></a> |
| <FONT color="green">349</FONT> <a name="line.349"></a> |
| <FONT color="green">350</FONT> /**<a name="line.350"></a> |
| <FONT color="green">351</FONT> * Temp debug code - this will be removed after we test everything<a name="line.351"></a> |
| <FONT color="green">352</FONT> */<a name="line.352"></a> |
| <FONT color="green">353</FONT> private static boolean debug;<a name="line.353"></a> |
| <FONT color="green">354</FONT> <a name="line.354"></a> |
| <FONT color="green">355</FONT> static<a name="line.355"></a> |
| <FONT color="green">356</FONT> {<a name="line.356"></a> |
| <FONT color="green">357</FONT> try<a name="line.357"></a> |
| <FONT color="green">358</FONT> {<a name="line.358"></a> |
| <FONT color="green">359</FONT> debug = System.getProperty("dtm.debug") != null;<a name="line.359"></a> |
| <FONT color="green">360</FONT> }<a name="line.360"></a> |
| <FONT color="green">361</FONT> catch (SecurityException ex){}<a name="line.361"></a> |
| <FONT color="green">362</FONT> }<a name="line.362"></a> |
| <FONT color="green">363</FONT> <a name="line.363"></a> |
| <FONT color="green">364</FONT> /** This value, set at compile time, controls how many bits of the<a name="line.364"></a> |
| <FONT color="green">365</FONT> * DTM node identifier numbers are used to identify a node within a<a name="line.365"></a> |
| <FONT color="green">366</FONT> * document, and thus sets the maximum number of nodes per<a name="line.366"></a> |
| <FONT color="green">367</FONT> * document. The remaining bits are used to identify the DTM<a name="line.367"></a> |
| <FONT color="green">368</FONT> * document which contains this node.<a name="line.368"></a> |
| <FONT color="green">369</FONT> *<a name="line.369"></a> |
| <FONT color="green">370</FONT> * If you change IDENT_DTM_NODE_BITS, be sure to rebuild _ALL_ the<a name="line.370"></a> |
| <FONT color="green">371</FONT> * files which use it... including the IDKey testcases.<a name="line.371"></a> |
| <FONT color="green">372</FONT> *<a name="line.372"></a> |
| <FONT color="green">373</FONT> * (FuncGenerateKey currently uses the node identifier directly and<a name="line.373"></a> |
| <FONT color="green">374</FONT> * thus is affected when this changes. The IDKEY results will still be<a name="line.374"></a> |
| <FONT color="green">375</FONT> * _correct_ (presuming no other breakage), but simple equality<a name="line.375"></a> |
| <FONT color="green">376</FONT> * comparison against the previous "golden" files will probably<a name="line.376"></a> |
| <FONT color="green">377</FONT> * complain.)<a name="line.377"></a> |
| <FONT color="green">378</FONT> * */<a name="line.378"></a> |
| <FONT color="green">379</FONT> public static final int IDENT_DTM_NODE_BITS = 16;<a name="line.379"></a> |
| <FONT color="green">380</FONT> <a name="line.380"></a> |
| <FONT color="green">381</FONT> <a name="line.381"></a> |
| <FONT color="green">382</FONT> /** When this bitmask is ANDed with a DTM node handle number, the result<a name="line.382"></a> |
| <FONT color="green">383</FONT> * is the low bits of the node's index number within that DTM. To obtain<a name="line.383"></a> |
| <FONT color="green">384</FONT> * the high bits, add the DTM ID portion's offset as assigned in the DTM <a name="line.384"></a> |
| <FONT color="green">385</FONT> * Manager.<a name="line.385"></a> |
| <FONT color="green">386</FONT> */<a name="line.386"></a> |
| <FONT color="green">387</FONT> public static final int IDENT_NODE_DEFAULT = (1<<IDENT_DTM_NODE_BITS)-1;<a name="line.387"></a> |
| <FONT color="green">388</FONT> <a name="line.388"></a> |
| <FONT color="green">389</FONT> <a name="line.389"></a> |
| <FONT color="green">390</FONT> /** When this bitmask is ANDed with a DTM node handle number, the result<a name="line.390"></a> |
| <FONT color="green">391</FONT> * is the DTM's document identity number.<a name="line.391"></a> |
| <FONT color="green">392</FONT> */<a name="line.392"></a> |
| <FONT color="green">393</FONT> public static final int IDENT_DTM_DEFAULT = ~IDENT_NODE_DEFAULT;<a name="line.393"></a> |
| <FONT color="green">394</FONT> <a name="line.394"></a> |
| <FONT color="green">395</FONT> /** This is the maximum number of DTMs available. The highest DTM is<a name="line.395"></a> |
| <FONT color="green">396</FONT> * one less than this.<a name="line.396"></a> |
| <FONT color="green">397</FONT> */<a name="line.397"></a> |
| <FONT color="green">398</FONT> public static final int IDENT_MAX_DTMS = (IDENT_DTM_DEFAULT >>> IDENT_DTM_NODE_BITS) + 1;<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> * %TBD% Doc<a name="line.402"></a> |
| <FONT color="green">403</FONT> *<a name="line.403"></a> |
| <FONT color="green">404</FONT> * NEEDSDOC @param dtm<a name="line.404"></a> |
| <FONT color="green">405</FONT> *<a name="line.405"></a> |
| <FONT color="green">406</FONT> * NEEDSDOC ($objectName$) @return<a name="line.406"></a> |
| <FONT color="green">407</FONT> */<a name="line.407"></a> |
| <FONT color="green">408</FONT> public abstract int getDTMIdentity(DTM dtm);<a name="line.408"></a> |
| <FONT color="green">409</FONT> <a name="line.409"></a> |
| <FONT color="green">410</FONT> /**<a name="line.410"></a> |
| <FONT color="green">411</FONT> * %TBD% Doc<a name="line.411"></a> |
| <FONT color="green">412</FONT> *<a name="line.412"></a> |
| <FONT color="green">413</FONT> * NEEDSDOC ($objectName$) @return<a name="line.413"></a> |
| <FONT color="green">414</FONT> */<a name="line.414"></a> |
| <FONT color="green">415</FONT> public int getDTMIdentityMask()<a name="line.415"></a> |
| <FONT color="green">416</FONT> {<a name="line.416"></a> |
| <FONT color="green">417</FONT> return IDENT_DTM_DEFAULT;<a name="line.417"></a> |
| <FONT color="green">418</FONT> }<a name="line.418"></a> |
| <FONT color="green">419</FONT> <a name="line.419"></a> |
| <FONT color="green">420</FONT> /**<a name="line.420"></a> |
| <FONT color="green">421</FONT> * %TBD% Doc<a name="line.421"></a> |
| <FONT color="green">422</FONT> *<a name="line.422"></a> |
| <FONT color="green">423</FONT> * NEEDSDOC ($objectName$) @return<a name="line.423"></a> |
| <FONT color="green">424</FONT> */<a name="line.424"></a> |
| <FONT color="green">425</FONT> public int getNodeIdentityMask()<a name="line.425"></a> |
| <FONT color="green">426</FONT> {<a name="line.426"></a> |
| <FONT color="green">427</FONT> return IDENT_NODE_DEFAULT;<a name="line.427"></a> |
| <FONT color="green">428</FONT> }<a name="line.428"></a> |
| <FONT color="green">429</FONT> <a name="line.429"></a> |
| <FONT color="green">430</FONT> }<a name="line.430"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
