| <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: DTM.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 javax.xml.transform.SourceLocator;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.xml.utils.XMLString;<a name="line.25"></a> |
| <FONT color="green">026</FONT> <a name="line.26"></a> |
| <FONT color="green">027</FONT> /**<a name="line.27"></a> |
| <FONT color="green">028</FONT> * <code>DTM</code> is an XML document model expressed as a table<a name="line.28"></a> |
| <FONT color="green">029</FONT> * rather than an object tree. It attempts to provide an interface to<a name="line.29"></a> |
| <FONT color="green">030</FONT> * a parse tree that has very little object creation. (DTM<a name="line.30"></a> |
| <FONT color="green">031</FONT> * implementations may also support incremental construction of the<a name="line.31"></a> |
| <FONT color="green">032</FONT> * model, but that's hidden from the DTM API.)<a name="line.32"></a> |
| <FONT color="green">033</FONT> *<a name="line.33"></a> |
| <FONT color="green">034</FONT> * <p>Nodes in the DTM are identified by integer "handles". A handle must<a name="line.34"></a> |
| <FONT color="green">035</FONT> * be unique within a process, and carries both node identification and<a name="line.35"></a> |
| <FONT color="green">036</FONT> * document identification. It must be possible to compare two handles<a name="line.36"></a> |
| <FONT color="green">037</FONT> * (and thus their nodes) for identity with "==".</p><a name="line.37"></a> |
| <FONT color="green">038</FONT> *<a name="line.38"></a> |
| <FONT color="green">039</FONT> * <p>Namespace URLs, local-names, and expanded-names can all be<a name="line.39"></a> |
| <FONT color="green">040</FONT> * represented by and tested as integer ID values. An expanded name<a name="line.40"></a> |
| <FONT color="green">041</FONT> * represents (and may or may not directly contain) a combination of<a name="line.41"></a> |
| <FONT color="green">042</FONT> * the URL ID, and the local-name ID. Note that the namespace URL id<a name="line.42"></a> |
| <FONT color="green">043</FONT> * can be 0, which should have the meaning that the namespace is null.<a name="line.43"></a> |
| <FONT color="green">044</FONT> * For consistancy, zero should not be used for a local-name index. </p><a name="line.44"></a> |
| <FONT color="green">045</FONT> *<a name="line.45"></a> |
| <FONT color="green">046</FONT> * <p>Text content of a node is represented by an index and length,<a name="line.46"></a> |
| <FONT color="green">047</FONT> * permitting efficient storage such as a shared FastStringBuffer.</p><a name="line.47"></a> |
| <FONT color="green">048</FONT> *<a name="line.48"></a> |
| <FONT color="green">049</FONT> * <p>The model of the tree, as well as the general navigation model,<a name="line.49"></a> |
| <FONT color="green">050</FONT> * is that of XPath 1.0, for the moment. The model will eventually be<a name="line.50"></a> |
| <FONT color="green">051</FONT> * adapted to match the XPath 2.0 data model, XML Schema, and<a name="line.51"></a> |
| <FONT color="green">052</FONT> * InfoSet.</p><a name="line.52"></a> |
| <FONT color="green">053</FONT> *<a name="line.53"></a> |
| <FONT color="green">054</FONT> * <p>DTM does _not_ directly support the W3C's Document Object<a name="line.54"></a> |
| <FONT color="green">055</FONT> * Model. However, it attempts to come close enough that an<a name="line.55"></a> |
| <FONT color="green">056</FONT> * implementation of DTM can be created that wraps a DOM and vice<a name="line.56"></a> |
| <FONT color="green">057</FONT> * versa.</p><a name="line.57"></a> |
| <FONT color="green">058</FONT> *<a name="line.58"></a> |
| <FONT color="green">059</FONT> * <p><strong>Please Note:</strong> The DTM API is still<a name="line.59"></a> |
| <FONT color="green">060</FONT> * <strong>Subject To Change.</strong> This wouldn't affect most<a name="line.60"></a> |
| <FONT color="green">061</FONT> * users, but might require updating some extensions.</p><a name="line.61"></a> |
| <FONT color="green">062</FONT> *<a name="line.62"></a> |
| <FONT color="green">063</FONT> * <p> The largest change being contemplated is a reconsideration of<a name="line.63"></a> |
| <FONT color="green">064</FONT> * the Node Handle representation. We are still not entirely sure<a name="line.64"></a> |
| <FONT color="green">065</FONT> * that an integer packed with two numeric subfields is really the<a name="line.65"></a> |
| <FONT color="green">066</FONT> * best solution. It has been suggested that we move up to a Long, to<a name="line.66"></a> |
| <FONT color="green">067</FONT> * permit more nodes per document without having to reduce the number<a name="line.67"></a> |
| <FONT color="green">068</FONT> * of slots in the DTMManager. There's even been a proposal that we<a name="line.68"></a> |
| <FONT color="green">069</FONT> * replace these integers with "cursor" objects containing the<a name="line.69"></a> |
| <FONT color="green">070</FONT> * internal node id and a pointer to the actual DTM object; this might<a name="line.70"></a> |
| <FONT color="green">071</FONT> * reduce the need to continuously consult the DTMManager to retrieve<a name="line.71"></a> |
| <FONT color="green">072</FONT> * the latter, and might provide a useful "hook" back into normal Java<a name="line.72"></a> |
| <FONT color="green">073</FONT> * heap management. But changing this datatype would have huge impact<a name="line.73"></a> |
| <FONT color="green">074</FONT> * on Xalan's internals -- especially given Java's lack of C-style<a name="line.74"></a> |
| <FONT color="green">075</FONT> * typedefs -- so we won't cut over unless we're convinced the new<a name="line.75"></a> |
| <FONT color="green">076</FONT> * solution really would be an improvement!</p><a name="line.76"></a> |
| <FONT color="green">077</FONT> * */<a name="line.77"></a> |
| <FONT color="green">078</FONT> public interface DTM<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> * Null node handles are represented by this value.<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> public static final int NULL = -1;<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> // These nodeType mnemonics and values are deliberately the same as those<a name="line.86"></a> |
| <FONT color="green">087</FONT> // used by the DOM, for convenient mapping<a name="line.87"></a> |
| <FONT color="green">088</FONT> //<a name="line.88"></a> |
| <FONT color="green">089</FONT> // %REVIEW% Should we actually define these as initialized to,<a name="line.89"></a> |
| <FONT color="green">090</FONT> // eg. org.w3c.dom.Document.ELEMENT_NODE?<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> * The node is a <code>Root</code>.<a name="line.93"></a> |
| <FONT color="green">094</FONT> */<a name="line.94"></a> |
| <FONT color="green">095</FONT> public static final short ROOT_NODE = 0;<a name="line.95"></a> |
| <FONT color="green">096</FONT> <a name="line.96"></a> |
| <FONT color="green">097</FONT> /**<a name="line.97"></a> |
| <FONT color="green">098</FONT> * The node is an <code>Element</code>.<a name="line.98"></a> |
| <FONT color="green">099</FONT> */<a name="line.99"></a> |
| <FONT color="green">100</FONT> public static final short ELEMENT_NODE = 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> * The node is an <code>Attr</code>.<a name="line.103"></a> |
| <FONT color="green">104</FONT> */<a name="line.104"></a> |
| <FONT color="green">105</FONT> public static final short ATTRIBUTE_NODE = 2;<a name="line.105"></a> |
| <FONT color="green">106</FONT> <a name="line.106"></a> |
| <FONT color="green">107</FONT> /**<a name="line.107"></a> |
| <FONT color="green">108</FONT> * The node is a <code>Text</code> node.<a name="line.108"></a> |
| <FONT color="green">109</FONT> */<a name="line.109"></a> |
| <FONT color="green">110</FONT> public static final short TEXT_NODE = 3;<a name="line.110"></a> |
| <FONT color="green">111</FONT> <a name="line.111"></a> |
| <FONT color="green">112</FONT> /**<a name="line.112"></a> |
| <FONT color="green">113</FONT> * The node is a <code>CDATASection</code>.<a name="line.113"></a> |
| <FONT color="green">114</FONT> */<a name="line.114"></a> |
| <FONT color="green">115</FONT> public static final short CDATA_SECTION_NODE = 4;<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> * The node is an <code>EntityReference</code>.<a name="line.118"></a> |
| <FONT color="green">119</FONT> */<a name="line.119"></a> |
| <FONT color="green">120</FONT> public static final short ENTITY_REFERENCE_NODE = 5;<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> /**<a name="line.122"></a> |
| <FONT color="green">123</FONT> * The node is an <code>Entity</code>.<a name="line.123"></a> |
| <FONT color="green">124</FONT> */<a name="line.124"></a> |
| <FONT color="green">125</FONT> public static final short ENTITY_NODE = 6;<a name="line.125"></a> |
| <FONT color="green">126</FONT> <a name="line.126"></a> |
| <FONT color="green">127</FONT> /**<a name="line.127"></a> |
| <FONT color="green">128</FONT> * The node is a <code>ProcessingInstruction</code>.<a name="line.128"></a> |
| <FONT color="green">129</FONT> */<a name="line.129"></a> |
| <FONT color="green">130</FONT> public static final short PROCESSING_INSTRUCTION_NODE = 7;<a name="line.130"></a> |
| <FONT color="green">131</FONT> <a name="line.131"></a> |
| <FONT color="green">132</FONT> /**<a name="line.132"></a> |
| <FONT color="green">133</FONT> * The node is a <code>Comment</code>.<a name="line.133"></a> |
| <FONT color="green">134</FONT> */<a name="line.134"></a> |
| <FONT color="green">135</FONT> public static final short COMMENT_NODE = 8;<a name="line.135"></a> |
| <FONT color="green">136</FONT> <a name="line.136"></a> |
| <FONT color="green">137</FONT> /**<a name="line.137"></a> |
| <FONT color="green">138</FONT> * The node is a <code>Document</code>.<a name="line.138"></a> |
| <FONT color="green">139</FONT> */<a name="line.139"></a> |
| <FONT color="green">140</FONT> public static final short DOCUMENT_NODE = 9;<a name="line.140"></a> |
| <FONT color="green">141</FONT> <a name="line.141"></a> |
| <FONT color="green">142</FONT> /**<a name="line.142"></a> |
| <FONT color="green">143</FONT> * The node is a <code>DocumentType</code>.<a name="line.143"></a> |
| <FONT color="green">144</FONT> */<a name="line.144"></a> |
| <FONT color="green">145</FONT> public static final short DOCUMENT_TYPE_NODE = 10;<a name="line.145"></a> |
| <FONT color="green">146</FONT> <a name="line.146"></a> |
| <FONT color="green">147</FONT> /**<a name="line.147"></a> |
| <FONT color="green">148</FONT> * The node is a <code>DocumentFragment</code>.<a name="line.148"></a> |
| <FONT color="green">149</FONT> */<a name="line.149"></a> |
| <FONT color="green">150</FONT> public static final short DOCUMENT_FRAGMENT_NODE = 11;<a name="line.150"></a> |
| <FONT color="green">151</FONT> <a name="line.151"></a> |
| <FONT color="green">152</FONT> /**<a name="line.152"></a> |
| <FONT color="green">153</FONT> * The node is a <code>Notation</code>.<a name="line.153"></a> |
| <FONT color="green">154</FONT> */<a name="line.154"></a> |
| <FONT color="green">155</FONT> public static final short NOTATION_NODE = 12;<a name="line.155"></a> |
| <FONT color="green">156</FONT> <a name="line.156"></a> |
| <FONT color="green">157</FONT> /**<a name="line.157"></a> |
| <FONT color="green">158</FONT> * The node is a <code>namespace node</code>. Note that this is not<a name="line.158"></a> |
| <FONT color="green">159</FONT> * currently a node type defined by the DOM API.<a name="line.159"></a> |
| <FONT color="green">160</FONT> */<a name="line.160"></a> |
| <FONT color="green">161</FONT> public static final short NAMESPACE_NODE = 13;<a name="line.161"></a> |
| <FONT color="green">162</FONT> <a name="line.162"></a> |
| <FONT color="green">163</FONT> /**<a name="line.163"></a> |
| <FONT color="green">164</FONT> * The number of valid nodetypes.<a name="line.164"></a> |
| <FONT color="green">165</FONT> */<a name="line.165"></a> |
| <FONT color="green">166</FONT> public static final short NTYPES = 14;<a name="line.166"></a> |
| <FONT color="green">167</FONT> <a name="line.167"></a> |
| <FONT color="green">168</FONT> // ========= DTM Implementation Control Functions. ==============<a name="line.168"></a> |
| <FONT color="green">169</FONT> // %TBD% RETIRED -- do via setFeature if needed. Remove from impls.<a name="line.169"></a> |
| <FONT color="green">170</FONT> // public void setParseBlockSize(int blockSizeSuggestion);<a name="line.170"></a> |
| <FONT color="green">171</FONT> <a name="line.171"></a> |
| <FONT color="green">172</FONT> /**<a name="line.172"></a> |
| <FONT color="green">173</FONT> * Set an implementation dependent feature.<a name="line.173"></a> |
| <FONT color="green">174</FONT> * <p><a name="line.174"></a> |
| <FONT color="green">175</FONT> * %REVIEW% Do we really expect to set features on DTMs?<a name="line.175"></a> |
| <FONT color="green">176</FONT> *<a name="line.176"></a> |
| <FONT color="green">177</FONT> * @param featureId A feature URL.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param state true if this feature should be on, false otherwise.<a name="line.178"></a> |
| <FONT color="green">179</FONT> */<a name="line.179"></a> |
| <FONT color="green">180</FONT> public void setFeature(String featureId, boolean state);<a name="line.180"></a> |
| <FONT color="green">181</FONT> <a name="line.181"></a> |
| <FONT color="green">182</FONT> /**<a name="line.182"></a> |
| <FONT color="green">183</FONT> * Set a run time property for this DTM instance.<a name="line.183"></a> |
| <FONT color="green">184</FONT> *<a name="line.184"></a> |
| <FONT color="green">185</FONT> * @param property a <code>String</code> value<a name="line.185"></a> |
| <FONT color="green">186</FONT> * @param value an <code>Object</code> value<a name="line.186"></a> |
| <FONT color="green">187</FONT> */<a name="line.187"></a> |
| <FONT color="green">188</FONT> public void setProperty(String property, Object value);<a name="line.188"></a> |
| <FONT color="green">189</FONT> <a name="line.189"></a> |
| <FONT color="green">190</FONT> // ========= Document Navigation Functions =========<a name="line.190"></a> |
| <FONT color="green">191</FONT> <a name="line.191"></a> |
| <FONT color="green">192</FONT> /**<a name="line.192"></a> |
| <FONT color="green">193</FONT> * This returns a stateless "traverser", that can navigate over an<a name="line.193"></a> |
| <FONT color="green">194</FONT> * XPath axis, though not in document order.<a name="line.194"></a> |
| <FONT color="green">195</FONT> *<a name="line.195"></a> |
| <FONT color="green">196</FONT> * @param axis One of Axes.ANCESTORORSELF, etc.<a name="line.196"></a> |
| <FONT color="green">197</FONT> *<a name="line.197"></a> |
| <FONT color="green">198</FONT> * @return A DTMAxisIterator, or null if the givin axis isn't supported.<a name="line.198"></a> |
| <FONT color="green">199</FONT> */<a name="line.199"></a> |
| <FONT color="green">200</FONT> public DTMAxisTraverser getAxisTraverser(final int axis);<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> * This is a shortcut to the iterators that implement<a name="line.203"></a> |
| <FONT color="green">204</FONT> * XPath axes.<a name="line.204"></a> |
| <FONT color="green">205</FONT> * Returns a bare-bones iterator that must be initialized<a name="line.205"></a> |
| <FONT color="green">206</FONT> * with a start node (using iterator.setStartNode()).<a name="line.206"></a> |
| <FONT color="green">207</FONT> *<a name="line.207"></a> |
| <FONT color="green">208</FONT> * @param axis One of Axes.ANCESTORORSELF, etc.<a name="line.208"></a> |
| <FONT color="green">209</FONT> *<a name="line.209"></a> |
| <FONT color="green">210</FONT> * @return A DTMAxisIterator, or null if the givin axis isn't supported.<a name="line.210"></a> |
| <FONT color="green">211</FONT> */<a name="line.211"></a> |
| <FONT color="green">212</FONT> public DTMAxisIterator getAxisIterator(final int axis);<a name="line.212"></a> |
| <FONT color="green">213</FONT> <a name="line.213"></a> |
| <FONT color="green">214</FONT> /**<a name="line.214"></a> |
| <FONT color="green">215</FONT> * Get an iterator that can navigate over an XPath Axis, predicated by<a name="line.215"></a> |
| <FONT color="green">216</FONT> * the extended type ID.<a name="line.216"></a> |
| <FONT color="green">217</FONT> *<a name="line.217"></a> |
| <FONT color="green">218</FONT> * @param axis<a name="line.218"></a> |
| <FONT color="green">219</FONT> * @param type An extended type ID.<a name="line.219"></a> |
| <FONT color="green">220</FONT> *<a name="line.220"></a> |
| <FONT color="green">221</FONT> * @return A DTMAxisIterator, or null if the givin axis isn't supported.<a name="line.221"></a> |
| <FONT color="green">222</FONT> */<a name="line.222"></a> |
| <FONT color="green">223</FONT> public DTMAxisIterator getTypedAxisIterator(final int axis, final int type);<a name="line.223"></a> |
| <FONT color="green">224</FONT> <a name="line.224"></a> |
| <FONT color="green">225</FONT> /**<a name="line.225"></a> |
| <FONT color="green">226</FONT> * Given a node handle, test if it has child nodes.<a name="line.226"></a> |
| <FONT color="green">227</FONT> * <p> %REVIEW% This is obviously useful at the DOM layer, where it<a name="line.227"></a> |
| <FONT color="green">228</FONT> * would permit testing this without having to create a proxy<a name="line.228"></a> |
| <FONT color="green">229</FONT> * node. It's less useful in the DTM API, where<a name="line.229"></a> |
| <FONT color="green">230</FONT> * (dtm.getFirstChild(nodeHandle)!=DTM.NULL) is just as fast and<a name="line.230"></a> |
| <FONT color="green">231</FONT> * almost as self-evident. But it's a convenience, and eases porting<a name="line.231"></a> |
| <FONT color="green">232</FONT> * of DOM code to DTM. </p><a name="line.232"></a> |
| <FONT color="green">233</FONT> *<a name="line.233"></a> |
| <FONT color="green">234</FONT> * @param nodeHandle int Handle of the node.<a name="line.234"></a> |
| <FONT color="green">235</FONT> * @return int true if the given node has child nodes.<a name="line.235"></a> |
| <FONT color="green">236</FONT> */<a name="line.236"></a> |
| <FONT color="green">237</FONT> public boolean hasChildNodes(int nodeHandle);<a name="line.237"></a> |
| <FONT color="green">238</FONT> <a name="line.238"></a> |
| <FONT color="green">239</FONT> /**<a name="line.239"></a> |
| <FONT color="green">240</FONT> * Given a node handle, get the handle of the node's first child.<a name="line.240"></a> |
| <FONT color="green">241</FONT> *<a name="line.241"></a> |
| <FONT color="green">242</FONT> * @param nodeHandle int Handle of the node.<a name="line.242"></a> |
| <FONT color="green">243</FONT> * @return int DTM node-number of first child,<a name="line.243"></a> |
| <FONT color="green">244</FONT> * or DTM.NULL to indicate none exists.<a name="line.244"></a> |
| <FONT color="green">245</FONT> */<a name="line.245"></a> |
| <FONT color="green">246</FONT> public int getFirstChild(int nodeHandle);<a name="line.246"></a> |
| <FONT color="green">247</FONT> <a name="line.247"></a> |
| <FONT color="green">248</FONT> /**<a name="line.248"></a> |
| <FONT color="green">249</FONT> * Given a node handle, get the handle of the node's last child.<a name="line.249"></a> |
| <FONT color="green">250</FONT> *<a name="line.250"></a> |
| <FONT color="green">251</FONT> * @param nodeHandle int Handle of the node.<a name="line.251"></a> |
| <FONT color="green">252</FONT> * @return int Node-number of last child,<a name="line.252"></a> |
| <FONT color="green">253</FONT> * or DTM.NULL to indicate none exists.<a name="line.253"></a> |
| <FONT color="green">254</FONT> */<a name="line.254"></a> |
| <FONT color="green">255</FONT> public int getLastChild(int nodeHandle);<a name="line.255"></a> |
| <FONT color="green">256</FONT> <a name="line.256"></a> |
| <FONT color="green">257</FONT> /**<a name="line.257"></a> |
| <FONT color="green">258</FONT> * Retrieves an attribute node by local name and namespace URI<a name="line.258"></a> |
| <FONT color="green">259</FONT> *<a name="line.259"></a> |
| <FONT color="green">260</FONT> * %TBD% Note that we currently have no way to support<a name="line.260"></a> |
| <FONT color="green">261</FONT> * the DOM's old getAttribute() call, which accesses only the qname.<a name="line.261"></a> |
| <FONT color="green">262</FONT> *<a name="line.262"></a> |
| <FONT color="green">263</FONT> * @param elementHandle Handle of the node upon which to look up this attribute.<a name="line.263"></a> |
| <FONT color="green">264</FONT> * @param namespaceURI The namespace URI of the attribute to<a name="line.264"></a> |
| <FONT color="green">265</FONT> * retrieve, or null.<a name="line.265"></a> |
| <FONT color="green">266</FONT> * @param name The local name of the attribute to<a name="line.266"></a> |
| <FONT color="green">267</FONT> * retrieve.<a name="line.267"></a> |
| <FONT color="green">268</FONT> * @return The attribute node handle with the specified name (<a name="line.268"></a> |
| <FONT color="green">269</FONT> * <code>nodeName</code>) or <code>DTM.NULL</code> if there is no such<a name="line.269"></a> |
| <FONT color="green">270</FONT> * attribute.<a name="line.270"></a> |
| <FONT color="green">271</FONT> */<a name="line.271"></a> |
| <FONT color="green">272</FONT> public int getAttributeNode(int elementHandle, String namespaceURI,<a name="line.272"></a> |
| <FONT color="green">273</FONT> String name);<a name="line.273"></a> |
| <FONT color="green">274</FONT> <a name="line.274"></a> |
| <FONT color="green">275</FONT> /**<a name="line.275"></a> |
| <FONT color="green">276</FONT> * Given a node handle, get the index of the node's first attribute.<a name="line.276"></a> |
| <FONT color="green">277</FONT> *<a name="line.277"></a> |
| <FONT color="green">278</FONT> * @param nodeHandle int Handle of the node.<a name="line.278"></a> |
| <FONT color="green">279</FONT> * @return Handle of first attribute, or DTM.NULL to indicate none exists.<a name="line.279"></a> |
| <FONT color="green">280</FONT> */<a name="line.280"></a> |
| <FONT color="green">281</FONT> public int getFirstAttribute(int nodeHandle);<a name="line.281"></a> |
| <FONT color="green">282</FONT> <a name="line.282"></a> |
| <FONT color="green">283</FONT> /**<a name="line.283"></a> |
| <FONT color="green">284</FONT> * Given a node handle, get the index of the node's first namespace node.<a name="line.284"></a> |
| <FONT color="green">285</FONT> *<a name="line.285"></a> |
| <FONT color="green">286</FONT> * @param nodeHandle handle to node, which should probably be an element<a name="line.286"></a> |
| <FONT color="green">287</FONT> * node, but need not be.<a name="line.287"></a> |
| <FONT color="green">288</FONT> *<a name="line.288"></a> |
| <FONT color="green">289</FONT> * @param inScope true if all namespaces in scope should be<a name="line.289"></a> |
| <FONT color="green">290</FONT> * returned, false if only the node's own<a name="line.290"></a> |
| <FONT color="green">291</FONT> * namespace declarations should be returned.<a name="line.291"></a> |
| <FONT color="green">292</FONT> * @return handle of first namespace,<a name="line.292"></a> |
| <FONT color="green">293</FONT> * or DTM.NULL to indicate none exists.<a name="line.293"></a> |
| <FONT color="green">294</FONT> */<a name="line.294"></a> |
| <FONT color="green">295</FONT> public int getFirstNamespaceNode(int nodeHandle, boolean inScope);<a name="line.295"></a> |
| <FONT color="green">296</FONT> <a name="line.296"></a> |
| <FONT color="green">297</FONT> /**<a name="line.297"></a> |
| <FONT color="green">298</FONT> * Given a node handle, advance to its next sibling.<a name="line.298"></a> |
| <FONT color="green">299</FONT> * @param nodeHandle int Handle of the node.<a name="line.299"></a> |
| <FONT color="green">300</FONT> * @return int Node-number of next sibling,<a name="line.300"></a> |
| <FONT color="green">301</FONT> * or DTM.NULL to indicate none exists.<a name="line.301"></a> |
| <FONT color="green">302</FONT> */<a name="line.302"></a> |
| <FONT color="green">303</FONT> public int getNextSibling(int nodeHandle);<a name="line.303"></a> |
| <FONT color="green">304</FONT> <a name="line.304"></a> |
| <FONT color="green">305</FONT> /**<a name="line.305"></a> |
| <FONT color="green">306</FONT> * Given a node handle, find its preceeding sibling.<a name="line.306"></a> |
| <FONT color="green">307</FONT> * WARNING: DTM implementations may be asymmetric; in some,<a name="line.307"></a> |
| <FONT color="green">308</FONT> * this operation has been resolved by search, and is relatively expensive.<a name="line.308"></a> |
| <FONT color="green">309</FONT> *<a name="line.309"></a> |
| <FONT color="green">310</FONT> * @param nodeHandle the id of the node.<a name="line.310"></a> |
| <FONT color="green">311</FONT> * @return int Node-number of the previous sib,<a name="line.311"></a> |
| <FONT color="green">312</FONT> * or DTM.NULL to indicate none exists.<a name="line.312"></a> |
| <FONT color="green">313</FONT> */<a name="line.313"></a> |
| <FONT color="green">314</FONT> public int getPreviousSibling(int nodeHandle);<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> * Given a node handle, advance to the next attribute. If an<a name="line.317"></a> |
| <FONT color="green">318</FONT> * element, we advance to its first attribute; if an attr, we advance to<a name="line.318"></a> |
| <FONT color="green">319</FONT> * the next attr of the same element.<a name="line.319"></a> |
| <FONT color="green">320</FONT> *<a name="line.320"></a> |
| <FONT color="green">321</FONT> * @param nodeHandle int Handle of the node.<a name="line.321"></a> |
| <FONT color="green">322</FONT> * @return int DTM node-number of the resolved attr,<a name="line.322"></a> |
| <FONT color="green">323</FONT> * or DTM.NULL to indicate none exists.<a name="line.323"></a> |
| <FONT color="green">324</FONT> */<a name="line.324"></a> |
| <FONT color="green">325</FONT> public int getNextAttribute(int nodeHandle);<a name="line.325"></a> |
| <FONT color="green">326</FONT> <a name="line.326"></a> |
| <FONT color="green">327</FONT> /**<a name="line.327"></a> |
| <FONT color="green">328</FONT> * Given a namespace handle, advance to the next namespace in the same scope<a name="line.328"></a> |
| <FONT color="green">329</FONT> * (local or local-plus-inherited, as selected by getFirstNamespaceNode)<a name="line.329"></a> |
| <FONT color="green">330</FONT> *<a name="line.330"></a> |
| <FONT color="green">331</FONT> * @param baseHandle handle to original node from where the first child<a name="line.331"></a> |
| <FONT color="green">332</FONT> * was relative to (needed to return nodes in document order).<a name="line.332"></a> |
| <FONT color="green">333</FONT> * @param namespaceHandle handle to node which must be of type<a name="line.333"></a> |
| <FONT color="green">334</FONT> * NAMESPACE_NODE.<a name="line.334"></a> |
| <FONT color="green">335</FONT> * NEEDSDOC @param inScope<a name="line.335"></a> |
| <FONT color="green">336</FONT> * @return handle of next namespace,<a name="line.336"></a> |
| <FONT color="green">337</FONT> * or DTM.NULL to indicate none exists.<a name="line.337"></a> |
| <FONT color="green">338</FONT> */<a name="line.338"></a> |
| <FONT color="green">339</FONT> public int getNextNamespaceNode(int baseHandle, int namespaceHandle,<a name="line.339"></a> |
| <FONT color="green">340</FONT> boolean inScope);<a name="line.340"></a> |
| <FONT color="green">341</FONT> <a name="line.341"></a> |
| <FONT color="green">342</FONT> /**<a name="line.342"></a> |
| <FONT color="green">343</FONT> * Given a node handle, find its parent node.<a name="line.343"></a> |
| <FONT color="green">344</FONT> *<a name="line.344"></a> |
| <FONT color="green">345</FONT> * @param nodeHandle the id of the node.<a name="line.345"></a> |
| <FONT color="green">346</FONT> * @return int Node handle of parent,<a name="line.346"></a> |
| <FONT color="green">347</FONT> * or DTM.NULL to indicate none exists.<a name="line.347"></a> |
| <FONT color="green">348</FONT> */<a name="line.348"></a> |
| <FONT color="green">349</FONT> public int getParent(int nodeHandle);<a name="line.349"></a> |
| <FONT color="green">350</FONT> <a name="line.350"></a> |
| <FONT color="green">351</FONT> /**<a name="line.351"></a> |
| <FONT color="green">352</FONT> * Given a DTM which contains only a single document, <a name="line.352"></a> |
| <FONT color="green">353</FONT> * find the Node Handle of the Document node. Note <a name="line.353"></a> |
| <FONT color="green">354</FONT> * that if the DTM is configured so it can contain multiple<a name="line.354"></a> |
| <FONT color="green">355</FONT> * documents, this call will return the Document currently<a name="line.355"></a> |
| <FONT color="green">356</FONT> * under construction -- but may return null if it's between<a name="line.356"></a> |
| <FONT color="green">357</FONT> * documents. Generally, you should use getOwnerDocument(nodeHandle)<a name="line.357"></a> |
| <FONT color="green">358</FONT> * or getDocumentRoot(nodeHandle) instead.<a name="line.358"></a> |
| <FONT color="green">359</FONT> *<a name="line.359"></a> |
| <FONT color="green">360</FONT> * @return int Node handle of document, or DTM.NULL if a shared DTM<a name="line.360"></a> |
| <FONT color="green">361</FONT> * can not tell us which Document is currently active.<a name="line.361"></a> |
| <FONT color="green">362</FONT> */<a name="line.362"></a> |
| <FONT color="green">363</FONT> public int getDocument();<a name="line.363"></a> |
| <FONT color="green">364</FONT> <a name="line.364"></a> |
| <FONT color="green">365</FONT> /**<a name="line.365"></a> |
| <FONT color="green">366</FONT> * Given a node handle, find the owning document node. This version mimics<a name="line.366"></a> |
| <FONT color="green">367</FONT> * the behavior of the DOM call by the same name.<a name="line.367"></a> |
| <FONT color="green">368</FONT> *<a name="line.368"></a> |
| <FONT color="green">369</FONT> * @param nodeHandle the id of the node.<a name="line.369"></a> |
| <FONT color="green">370</FONT> * @return int Node handle of owning document, or DTM.NULL if the node was<a name="line.370"></a> |
| <FONT color="green">371</FONT> * a Document.<a name="line.371"></a> |
| <FONT color="green">372</FONT> * @see #getDocumentRoot(int nodeHandle)<a name="line.372"></a> |
| <FONT color="green">373</FONT> */<a name="line.373"></a> |
| <FONT color="green">374</FONT> public int getOwnerDocument(int nodeHandle);<a name="line.374"></a> |
| <FONT color="green">375</FONT> <a name="line.375"></a> |
| <FONT color="green">376</FONT> /**<a name="line.376"></a> |
| <FONT color="green">377</FONT> * Given a node handle, find the owning document node.<a name="line.377"></a> |
| <FONT color="green">378</FONT> *<a name="line.378"></a> |
| <FONT color="green">379</FONT> * @param nodeHandle the id of the node.<a name="line.379"></a> |
| <FONT color="green">380</FONT> * @return int Node handle of owning document, or the node itself if it was<a name="line.380"></a> |
| <FONT color="green">381</FONT> * a Document. (Note difference from DOM, where getOwnerDocument returns<a name="line.381"></a> |
| <FONT color="green">382</FONT> * null for the Document node.)<a name="line.382"></a> |
| <FONT color="green">383</FONT> * @see #getOwnerDocument(int nodeHandle)<a name="line.383"></a> |
| <FONT color="green">384</FONT> */<a name="line.384"></a> |
| <FONT color="green">385</FONT> public int getDocumentRoot(int nodeHandle);<a name="line.385"></a> |
| <FONT color="green">386</FONT> <a name="line.386"></a> |
| <FONT color="green">387</FONT> /**<a name="line.387"></a> |
| <FONT color="green">388</FONT> * Get the string-value of a node as a String object<a name="line.388"></a> |
| <FONT color="green">389</FONT> * (see http://www.w3.org/TR/xpath#data-model<a name="line.389"></a> |
| <FONT color="green">390</FONT> * for the definition of a node's string-value).<a name="line.390"></a> |
| <FONT color="green">391</FONT> *<a name="line.391"></a> |
| <FONT color="green">392</FONT> * @param nodeHandle The node ID.<a name="line.392"></a> |
| <FONT color="green">393</FONT> *<a name="line.393"></a> |
| <FONT color="green">394</FONT> * @return A string object that represents the string-value of the given node.<a name="line.394"></a> |
| <FONT color="green">395</FONT> */<a name="line.395"></a> |
| <FONT color="green">396</FONT> public XMLString getStringValue(int nodeHandle);<a name="line.396"></a> |
| <FONT color="green">397</FONT> <a name="line.397"></a> |
| <FONT color="green">398</FONT> /**<a name="line.398"></a> |
| <FONT color="green">399</FONT> * Get number of character array chunks in<a name="line.399"></a> |
| <FONT color="green">400</FONT> * the string-value of a node.<a name="line.400"></a> |
| <FONT color="green">401</FONT> * (see http://www.w3.org/TR/xpath#data-model<a name="line.401"></a> |
| <FONT color="green">402</FONT> * for the definition of a node's string-value).<a name="line.402"></a> |
| <FONT color="green">403</FONT> * Note that a single text node may have multiple text chunks.<a name="line.403"></a> |
| <FONT color="green">404</FONT> *<a name="line.404"></a> |
| <FONT color="green">405</FONT> * @param nodeHandle The node ID.<a name="line.405"></a> |
| <FONT color="green">406</FONT> *<a name="line.406"></a> |
| <FONT color="green">407</FONT> * @return number of character array chunks in<a name="line.407"></a> |
| <FONT color="green">408</FONT> * the string-value of a node.<a name="line.408"></a> |
| <FONT color="green">409</FONT> */<a name="line.409"></a> |
| <FONT color="green">410</FONT> public int getStringValueChunkCount(int nodeHandle);<a name="line.410"></a> |
| <FONT color="green">411</FONT> <a name="line.411"></a> |
| <FONT color="green">412</FONT> /**<a name="line.412"></a> |
| <FONT color="green">413</FONT> * Get a character array chunk in the string-value of a node.<a name="line.413"></a> |
| <FONT color="green">414</FONT> * (see http://www.w3.org/TR/xpath#data-model<a name="line.414"></a> |
| <FONT color="green">415</FONT> * for the definition of a node's string-value).<a name="line.415"></a> |
| <FONT color="green">416</FONT> * Note that a single text node may have multiple text chunks.<a name="line.416"></a> |
| <FONT color="green">417</FONT> *<a name="line.417"></a> |
| <FONT color="green">418</FONT> * @param nodeHandle The node ID.<a name="line.418"></a> |
| <FONT color="green">419</FONT> * @param chunkIndex Which chunk to get.<a name="line.419"></a> |
| <FONT color="green">420</FONT> * @param startAndLen A two-integer array which, upon return, WILL<a name="line.420"></a> |
| <FONT color="green">421</FONT> * BE FILLED with values representing the chunk's start position<a name="line.421"></a> |
| <FONT color="green">422</FONT> * within the returned character buffer and the length of the chunk.<a name="line.422"></a> |
| <FONT color="green">423</FONT> * @return The character array buffer within which the chunk occurs,<a name="line.423"></a> |
| <FONT color="green">424</FONT> * setting startAndLen's contents as a side-effect.<a name="line.424"></a> |
| <FONT color="green">425</FONT> */<a name="line.425"></a> |
| <FONT color="green">426</FONT> public char[] getStringValueChunk(int nodeHandle, int chunkIndex,<a name="line.426"></a> |
| <FONT color="green">427</FONT> int[] startAndLen);<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> * Given a node handle, return an ID that represents the node's expanded name.<a name="line.430"></a> |
| <FONT color="green">431</FONT> *<a name="line.431"></a> |
| <FONT color="green">432</FONT> * @param nodeHandle The handle to the node in question.<a name="line.432"></a> |
| <FONT color="green">433</FONT> *<a name="line.433"></a> |
| <FONT color="green">434</FONT> * @return the expanded-name id of the node.<a name="line.434"></a> |
| <FONT color="green">435</FONT> */<a name="line.435"></a> |
| <FONT color="green">436</FONT> public int getExpandedTypeID(int nodeHandle);<a name="line.436"></a> |
| <FONT color="green">437</FONT> <a name="line.437"></a> |
| <FONT color="green">438</FONT> /**<a name="line.438"></a> |
| <FONT color="green">439</FONT> * Given an expanded name, return an ID. If the expanded-name does not<a name="line.439"></a> |
| <FONT color="green">440</FONT> * exist in the internal tables, the entry will be created, and the ID will<a name="line.440"></a> |
| <FONT color="green">441</FONT> * be returned. Any additional nodes that are created that have this<a name="line.441"></a> |
| <FONT color="green">442</FONT> * expanded name will use this ID.<a name="line.442"></a> |
| <FONT color="green">443</FONT> *<a name="line.443"></a> |
| <FONT color="green">444</FONT> * NEEDSDOC @param namespace<a name="line.444"></a> |
| <FONT color="green">445</FONT> * NEEDSDOC @param localName<a name="line.445"></a> |
| <FONT color="green">446</FONT> * NEEDSDOC @param type<a name="line.446"></a> |
| <FONT color="green">447</FONT> *<a name="line.447"></a> |
| <FONT color="green">448</FONT> * @return the expanded-name id of the node.<a name="line.448"></a> |
| <FONT color="green">449</FONT> */<a name="line.449"></a> |
| <FONT color="green">450</FONT> public int getExpandedTypeID(String namespace, String localName, int type);<a name="line.450"></a> |
| <FONT color="green">451</FONT> <a name="line.451"></a> |
| <FONT color="green">452</FONT> /**<a name="line.452"></a> |
| <FONT color="green">453</FONT> * Given an expanded-name ID, return the local name part.<a name="line.453"></a> |
| <FONT color="green">454</FONT> *<a name="line.454"></a> |
| <FONT color="green">455</FONT> * @param ExpandedNameID an ID that represents an expanded-name.<a name="line.455"></a> |
| <FONT color="green">456</FONT> * @return String Local name of this node.<a name="line.456"></a> |
| <FONT color="green">457</FONT> */<a name="line.457"></a> |
| <FONT color="green">458</FONT> public String getLocalNameFromExpandedNameID(int ExpandedNameID);<a name="line.458"></a> |
| <FONT color="green">459</FONT> <a name="line.459"></a> |
| <FONT color="green">460</FONT> /**<a name="line.460"></a> |
| <FONT color="green">461</FONT> * Given an expanded-name ID, return the namespace URI part.<a name="line.461"></a> |
| <FONT color="green">462</FONT> *<a name="line.462"></a> |
| <FONT color="green">463</FONT> * @param ExpandedNameID an ID that represents an expanded-name.<a name="line.463"></a> |
| <FONT color="green">464</FONT> * @return String URI value of this node's namespace, or null if no<a name="line.464"></a> |
| <FONT color="green">465</FONT> * namespace was resolved.<a name="line.465"></a> |
| <FONT color="green">466</FONT> */<a name="line.466"></a> |
| <FONT color="green">467</FONT> public String getNamespaceFromExpandedNameID(int ExpandedNameID);<a name="line.467"></a> |
| <FONT color="green">468</FONT> <a name="line.468"></a> |
| <FONT color="green">469</FONT> /**<a name="line.469"></a> |
| <FONT color="green">470</FONT> * Given a node handle, return its DOM-style node name. This will<a name="line.470"></a> |
| <FONT color="green">471</FONT> * include names such as #text or #document.<a name="line.471"></a> |
| <FONT color="green">472</FONT> *<a name="line.472"></a> |
| <FONT color="green">473</FONT> * @param nodeHandle the id of the node.<a name="line.473"></a> |
| <FONT color="green">474</FONT> * @return String Name of this node, which may be an empty string.<a name="line.474"></a> |
| <FONT color="green">475</FONT> * %REVIEW% Document when empty string is possible...<a name="line.475"></a> |
| <FONT color="green">476</FONT> */<a name="line.476"></a> |
| <FONT color="green">477</FONT> public String getNodeName(int nodeHandle);<a name="line.477"></a> |
| <FONT color="green">478</FONT> <a name="line.478"></a> |
| <FONT color="green">479</FONT> /**<a name="line.479"></a> |
| <FONT color="green">480</FONT> * Given a node handle, return the XPath node name. This should be<a name="line.480"></a> |
| <FONT color="green">481</FONT> * the name as described by the XPath data model, NOT the DOM-style<a name="line.481"></a> |
| <FONT color="green">482</FONT> * name.<a name="line.482"></a> |
| <FONT color="green">483</FONT> *<a name="line.483"></a> |
| <FONT color="green">484</FONT> * @param nodeHandle the id of the node.<a name="line.484"></a> |
| <FONT color="green">485</FONT> * @return String Name of this node.<a name="line.485"></a> |
| <FONT color="green">486</FONT> */<a name="line.486"></a> |
| <FONT color="green">487</FONT> public String getNodeNameX(int nodeHandle);<a name="line.487"></a> |
| <FONT color="green">488</FONT> <a name="line.488"></a> |
| <FONT color="green">489</FONT> /**<a name="line.489"></a> |
| <FONT color="green">490</FONT> * Given a node handle, return its DOM-style localname.<a name="line.490"></a> |
| <FONT color="green">491</FONT> * (As defined in Namespaces, this is the portion of the name after the<a name="line.491"></a> |
| <FONT color="green">492</FONT> * prefix, if present, or the whole node name if no prefix exists)<a name="line.492"></a> |
| <FONT color="green">493</FONT> *<a name="line.493"></a> |
| <FONT color="green">494</FONT> * @param nodeHandle the id of the node.<a name="line.494"></a> |
| <FONT color="green">495</FONT> * @return String Local name of this node.<a name="line.495"></a> |
| <FONT color="green">496</FONT> */<a name="line.496"></a> |
| <FONT color="green">497</FONT> public String getLocalName(int nodeHandle);<a name="line.497"></a> |
| <FONT color="green">498</FONT> <a name="line.498"></a> |
| <FONT color="green">499</FONT> /**<a name="line.499"></a> |
| <FONT color="green">500</FONT> * Given a namespace handle, return the prefix that the namespace decl is<a name="line.500"></a> |
| <FONT color="green">501</FONT> * mapping.<a name="line.501"></a> |
| <FONT color="green">502</FONT> * Given a node handle, return the prefix used to map to the namespace.<a name="line.502"></a> |
| <FONT color="green">503</FONT> * (As defined in Namespaces, this is the portion of the name before any<a name="line.503"></a> |
| <FONT color="green">504</FONT> * colon character).<a name="line.504"></a> |
| <FONT color="green">505</FONT> *<a name="line.505"></a> |
| <FONT color="green">506</FONT> * <p> %REVIEW% Are you sure you want "" for no prefix? </p><a name="line.506"></a> |
| <FONT color="green">507</FONT> *<a name="line.507"></a> |
| <FONT color="green">508</FONT> * @param nodeHandle the id of the node.<a name="line.508"></a> |
| <FONT color="green">509</FONT> * @return String prefix of this node's name, or "" if no explicit<a name="line.509"></a> |
| <FONT color="green">510</FONT> * namespace prefix was given.<a name="line.510"></a> |
| <FONT color="green">511</FONT> */<a name="line.511"></a> |
| <FONT color="green">512</FONT> public String getPrefix(int nodeHandle);<a name="line.512"></a> |
| <FONT color="green">513</FONT> <a name="line.513"></a> |
| <FONT color="green">514</FONT> /**<a name="line.514"></a> |
| <FONT color="green">515</FONT> * Given a node handle, return its DOM-style namespace URI<a name="line.515"></a> |
| <FONT color="green">516</FONT> * (As defined in Namespaces, this is the declared URI which this node's<a name="line.516"></a> |
| <FONT color="green">517</FONT> * prefix -- or default in lieu thereof -- was mapped to.)<a name="line.517"></a> |
| <FONT color="green">518</FONT> * @param nodeHandle the id of the node.<a name="line.518"></a> |
| <FONT color="green">519</FONT> * @return String URI value of this node's namespace, or null if no<a name="line.519"></a> |
| <FONT color="green">520</FONT> * namespace was resolved.<a name="line.520"></a> |
| <FONT color="green">521</FONT> */<a name="line.521"></a> |
| <FONT color="green">522</FONT> public String getNamespaceURI(int nodeHandle);<a name="line.522"></a> |
| <FONT color="green">523</FONT> <a name="line.523"></a> |
| <FONT color="green">524</FONT> /**<a name="line.524"></a> |
| <FONT color="green">525</FONT> * Given a node handle, return its node value. This is mostly<a name="line.525"></a> |
| <FONT color="green">526</FONT> * as defined by the DOM, but may ignore some conveniences.<a name="line.526"></a> |
| <FONT color="green">527</FONT> * <p><a name="line.527"></a> |
| <FONT color="green">528</FONT> * @param nodeHandle The node id.<a name="line.528"></a> |
| <FONT color="green">529</FONT> * @return String Value of this node, or null if not<a name="line.529"></a> |
| <FONT color="green">530</FONT> * meaningful for this node type.<a name="line.530"></a> |
| <FONT color="green">531</FONT> */<a name="line.531"></a> |
| <FONT color="green">532</FONT> public String getNodeValue(int nodeHandle);<a name="line.532"></a> |
| <FONT color="green">533</FONT> <a name="line.533"></a> |
| <FONT color="green">534</FONT> /**<a name="line.534"></a> |
| <FONT color="green">535</FONT> * Given a node handle, return its DOM-style node type.<a name="line.535"></a> |
| <FONT color="green">536</FONT> *<a name="line.536"></a> |
| <FONT color="green">537</FONT> * <p>%REVIEW% Generally, returning short is false economy. Return int?</p><a name="line.537"></a> |
| <FONT color="green">538</FONT> *<a name="line.538"></a> |
| <FONT color="green">539</FONT> * @param nodeHandle The node id.<a name="line.539"></a> |
| <FONT color="green">540</FONT> * @return int Node type, as per the DOM's Node._NODE constants.<a name="line.540"></a> |
| <FONT color="green">541</FONT> */<a name="line.541"></a> |
| <FONT color="green">542</FONT> public short getNodeType(int nodeHandle);<a name="line.542"></a> |
| <FONT color="green">543</FONT> <a name="line.543"></a> |
| <FONT color="green">544</FONT> /**<a name="line.544"></a> |
| <FONT color="green">545</FONT> * Get the depth level of this node in the tree (equals 1 for<a name="line.545"></a> |
| <FONT color="green">546</FONT> * a parentless node).<a name="line.546"></a> |
| <FONT color="green">547</FONT> *<a name="line.547"></a> |
| <FONT color="green">548</FONT> * @param nodeHandle The node id.<a name="line.548"></a> |
| <FONT color="green">549</FONT> * @return the number of ancestors, plus one<a name="line.549"></a> |
| <FONT color="green">550</FONT> * @xsl.usage internal<a name="line.550"></a> |
| <FONT color="green">551</FONT> */<a name="line.551"></a> |
| <FONT color="green">552</FONT> public short getLevel(int nodeHandle);<a name="line.552"></a> |
| <FONT color="green">553</FONT> <a name="line.553"></a> |
| <FONT color="green">554</FONT> // ============== Document query functions ==============<a name="line.554"></a> |
| <FONT color="green">555</FONT> <a name="line.555"></a> |
| <FONT color="green">556</FONT> /**<a name="line.556"></a> |
| <FONT color="green">557</FONT> * Tests whether DTM DOM implementation implements a specific feature and<a name="line.557"></a> |
| <FONT color="green">558</FONT> * that feature is supported by this node.<a name="line.558"></a> |
| <FONT color="green">559</FONT> * @param feature The name of the feature to test.<a name="line.559"></a> |
| <FONT color="green">560</FONT> * @param version This is the version number of the feature to test.<a name="line.560"></a> |
| <FONT color="green">561</FONT> * If the version is not<a name="line.561"></a> |
| <FONT color="green">562</FONT> * specified, supporting any version of the feature will cause the<a name="line.562"></a> |
| <FONT color="green">563</FONT> * method to return <code>true</code>.<a name="line.563"></a> |
| <FONT color="green">564</FONT> * @return Returns <code>true</code> if the specified feature is<a name="line.564"></a> |
| <FONT color="green">565</FONT> * supported on this node, <code>false</code> otherwise.<a name="line.565"></a> |
| <FONT color="green">566</FONT> */<a name="line.566"></a> |
| <FONT color="green">567</FONT> public boolean isSupported(String feature, String version);<a name="line.567"></a> |
| <FONT color="green">568</FONT> <a name="line.568"></a> |
| <FONT color="green">569</FONT> /**<a name="line.569"></a> |
| <FONT color="green">570</FONT> * Return the base URI of the document entity. If it is not known<a name="line.570"></a> |
| <FONT color="green">571</FONT> * (because the document was parsed from a socket connection or from<a name="line.571"></a> |
| <FONT color="green">572</FONT> * standard input, for example), the value of this property is unknown.<a name="line.572"></a> |
| <FONT color="green">573</FONT> *<a name="line.573"></a> |
| <FONT color="green">574</FONT> * @return the document base URI String object or null if unknown.<a name="line.574"></a> |
| <FONT color="green">575</FONT> */<a name="line.575"></a> |
| <FONT color="green">576</FONT> public String getDocumentBaseURI();<a name="line.576"></a> |
| <FONT color="green">577</FONT> <a name="line.577"></a> |
| <FONT color="green">578</FONT> /**<a name="line.578"></a> |
| <FONT color="green">579</FONT> * Set the base URI of the document entity.<a name="line.579"></a> |
| <FONT color="green">580</FONT> *<a name="line.580"></a> |
| <FONT color="green">581</FONT> * @param baseURI the document base URI String object or null if unknown.<a name="line.581"></a> |
| <FONT color="green">582</FONT> */<a name="line.582"></a> |
| <FONT color="green">583</FONT> public void setDocumentBaseURI(String baseURI);<a name="line.583"></a> |
| <FONT color="green">584</FONT> <a name="line.584"></a> |
| <FONT color="green">585</FONT> /**<a name="line.585"></a> |
| <FONT color="green">586</FONT> * Return the system identifier of the document entity. If<a name="line.586"></a> |
| <FONT color="green">587</FONT> * it is not known, the value of this property is null.<a name="line.587"></a> |
| <FONT color="green">588</FONT> *<a name="line.588"></a> |
| <FONT color="green">589</FONT> * @param nodeHandle The node id, which can be any valid node handle.<a name="line.589"></a> |
| <FONT color="green">590</FONT> * @return the system identifier String object or null if unknown.<a name="line.590"></a> |
| <FONT color="green">591</FONT> */<a name="line.591"></a> |
| <FONT color="green">592</FONT> public String getDocumentSystemIdentifier(int nodeHandle);<a name="line.592"></a> |
| <FONT color="green">593</FONT> <a name="line.593"></a> |
| <FONT color="green">594</FONT> /**<a name="line.594"></a> |
| <FONT color="green">595</FONT> * Return the name of the character encoding scheme<a name="line.595"></a> |
| <FONT color="green">596</FONT> * in which the document entity is expressed.<a name="line.596"></a> |
| <FONT color="green">597</FONT> *<a name="line.597"></a> |
| <FONT color="green">598</FONT> * @param nodeHandle The node id, which can be any valid node handle.<a name="line.598"></a> |
| <FONT color="green">599</FONT> * @return the document encoding String object.<a name="line.599"></a> |
| <FONT color="green">600</FONT> */<a name="line.600"></a> |
| <FONT color="green">601</FONT> public String getDocumentEncoding(int nodeHandle);<a name="line.601"></a> |
| <FONT color="green">602</FONT> <a name="line.602"></a> |
| <FONT color="green">603</FONT> /**<a name="line.603"></a> |
| <FONT color="green">604</FONT> * Return an indication of the standalone status of the document,<a name="line.604"></a> |
| <FONT color="green">605</FONT> * either "yes" or "no". This property is derived from the optional<a name="line.605"></a> |
| <FONT color="green">606</FONT> * standalone document declaration in the XML declaration at the<a name="line.606"></a> |
| <FONT color="green">607</FONT> * beginning of the document entity, and has no value if there is no<a name="line.607"></a> |
| <FONT color="green">608</FONT> * standalone document declaration.<a name="line.608"></a> |
| <FONT color="green">609</FONT> *<a name="line.609"></a> |
| <FONT color="green">610</FONT> * @param nodeHandle The node id, which can be any valid node handle.<a name="line.610"></a> |
| <FONT color="green">611</FONT> * @return the document standalone String object, either "yes", "no", or null.<a name="line.611"></a> |
| <FONT color="green">612</FONT> */<a name="line.612"></a> |
| <FONT color="green">613</FONT> public String getDocumentStandalone(int nodeHandle);<a name="line.613"></a> |
| <FONT color="green">614</FONT> <a name="line.614"></a> |
| <FONT color="green">615</FONT> /**<a name="line.615"></a> |
| <FONT color="green">616</FONT> * Return a string representing the XML version of the document. This<a name="line.616"></a> |
| <FONT color="green">617</FONT> * property is derived from the XML declaration optionally present at the<a name="line.617"></a> |
| <FONT color="green">618</FONT> * beginning of the document entity, and has no value if there is no XML<a name="line.618"></a> |
| <FONT color="green">619</FONT> * declaration.<a name="line.619"></a> |
| <FONT color="green">620</FONT> *<a name="line.620"></a> |
| <FONT color="green">621</FONT> * @param documentHandle the document handle<a name="line.621"></a> |
| <FONT color="green">622</FONT> * @return the document version String object<a name="line.622"></a> |
| <FONT color="green">623</FONT> */<a name="line.623"></a> |
| <FONT color="green">624</FONT> public String getDocumentVersion(int documentHandle);<a name="line.624"></a> |
| <FONT color="green">625</FONT> <a name="line.625"></a> |
| <FONT color="green">626</FONT> /**<a name="line.626"></a> |
| <FONT color="green">627</FONT> * Return an indication of<a name="line.627"></a> |
| <FONT color="green">628</FONT> * whether the processor has read the complete DTD. Its value is a<a name="line.628"></a> |
| <FONT color="green">629</FONT> * boolean. If it is false, then certain properties (indicated in their<a name="line.629"></a> |
| <FONT color="green">630</FONT> * descriptions below) may be unknown. If it is true, those properties<a name="line.630"></a> |
| <FONT color="green">631</FONT> * are never unknown.<a name="line.631"></a> |
| <FONT color="green">632</FONT> *<a name="line.632"></a> |
| <FONT color="green">633</FONT> * @return <code>true</code> if all declarations were processed;<a name="line.633"></a> |
| <FONT color="green">634</FONT> * <code>false</code> otherwise.<a name="line.634"></a> |
| <FONT color="green">635</FONT> */<a name="line.635"></a> |
| <FONT color="green">636</FONT> public boolean getDocumentAllDeclarationsProcessed();<a name="line.636"></a> |
| <FONT color="green">637</FONT> <a name="line.637"></a> |
| <FONT color="green">638</FONT> /**<a name="line.638"></a> |
| <FONT color="green">639</FONT> * A document type declaration information item has the following properties:<a name="line.639"></a> |
| <FONT color="green">640</FONT> *<a name="line.640"></a> |
| <FONT color="green">641</FONT> * 1. [system identifier] The system identifier of the external subset, if<a name="line.641"></a> |
| <FONT color="green">642</FONT> * it exists. Otherwise this property has no value.<a name="line.642"></a> |
| <FONT color="green">643</FONT> *<a name="line.643"></a> |
| <FONT color="green">644</FONT> * @return the system identifier String object, or null if there is none.<a name="line.644"></a> |
| <FONT color="green">645</FONT> */<a name="line.645"></a> |
| <FONT color="green">646</FONT> public String getDocumentTypeDeclarationSystemIdentifier();<a name="line.646"></a> |
| <FONT color="green">647</FONT> <a name="line.647"></a> |
| <FONT color="green">648</FONT> /**<a name="line.648"></a> |
| <FONT color="green">649</FONT> * Return the public identifier of the external subset,<a name="line.649"></a> |
| <FONT color="green">650</FONT> * normalized as described in 4.2.2 External Entities [XML]. If there is<a name="line.650"></a> |
| <FONT color="green">651</FONT> * no external subset or if it has no public identifier, this property<a name="line.651"></a> |
| <FONT color="green">652</FONT> * has no value.<a name="line.652"></a> |
| <FONT color="green">653</FONT> *<a name="line.653"></a> |
| <FONT color="green">654</FONT> * @return the public identifier String object, or null if there is none.<a name="line.654"></a> |
| <FONT color="green">655</FONT> */<a name="line.655"></a> |
| <FONT color="green">656</FONT> public String getDocumentTypeDeclarationPublicIdentifier();<a name="line.656"></a> |
| <FONT color="green">657</FONT> <a name="line.657"></a> |
| <FONT color="green">658</FONT> /**<a name="line.658"></a> |
| <FONT color="green">659</FONT> * Returns the <code>Element</code> whose <code>ID</code> is given by<a name="line.659"></a> |
| <FONT color="green">660</FONT> * <code>elementId</code>. If no such element exists, returns<a name="line.660"></a> |
| <FONT color="green">661</FONT> * <code>DTM.NULL</code>. Behavior is not defined if more than one element<a name="line.661"></a> |
| <FONT color="green">662</FONT> * has this <code>ID</code>. Attributes (including those<a name="line.662"></a> |
| <FONT color="green">663</FONT> * with the name "ID") are not of type ID unless so defined by DTD/Schema<a name="line.663"></a> |
| <FONT color="green">664</FONT> * information available to the DTM implementation.<a name="line.664"></a> |
| <FONT color="green">665</FONT> * Implementations that do not know whether attributes are of type ID or<a name="line.665"></a> |
| <FONT color="green">666</FONT> * not are expected to return <code>DTM.NULL</code>.<a name="line.666"></a> |
| <FONT color="green">667</FONT> *<a name="line.667"></a> |
| <FONT color="green">668</FONT> * <p>%REVIEW% Presumably IDs are still scoped to a single document,<a name="line.668"></a> |
| <FONT color="green">669</FONT> * and this operation searches only within a single document, right?<a name="line.669"></a> |
| <FONT color="green">670</FONT> * Wouldn't want collisions between DTMs in the same process.</p><a name="line.670"></a> |
| <FONT color="green">671</FONT> *<a name="line.671"></a> |
| <FONT color="green">672</FONT> * @param elementId The unique <code>id</code> value for an element.<a name="line.672"></a> |
| <FONT color="green">673</FONT> * @return The handle of the matching element.<a name="line.673"></a> |
| <FONT color="green">674</FONT> */<a name="line.674"></a> |
| <FONT color="green">675</FONT> public int getElementById(String elementId);<a name="line.675"></a> |
| <FONT color="green">676</FONT> <a name="line.676"></a> |
| <FONT color="green">677</FONT> /**<a name="line.677"></a> |
| <FONT color="green">678</FONT> * The getUnparsedEntityURI function returns the URI of the unparsed<a name="line.678"></a> |
| <FONT color="green">679</FONT> * entity with the specified name in the same document as the context<a name="line.679"></a> |
| <FONT color="green">680</FONT> * node (see [3.3 Unparsed Entities]). It returns the empty string if<a name="line.680"></a> |
| <FONT color="green">681</FONT> * there is no such entity.<a name="line.681"></a> |
| <FONT color="green">682</FONT> * <p><a name="line.682"></a> |
| <FONT color="green">683</FONT> * XML processors may choose to use the System Identifier (if one<a name="line.683"></a> |
| <FONT color="green">684</FONT> * is provided) to resolve the entity, rather than the URI in the<a name="line.684"></a> |
| <FONT color="green">685</FONT> * Public Identifier. The details are dependent on the processor, and<a name="line.685"></a> |
| <FONT color="green">686</FONT> * we would have to support some form of plug-in resolver to handle<a name="line.686"></a> |
| <FONT color="green">687</FONT> * this properly. Currently, we simply return the System Identifier if<a name="line.687"></a> |
| <FONT color="green">688</FONT> * present, and hope that it a usable URI or that our caller can<a name="line.688"></a> |
| <FONT color="green">689</FONT> * map it to one.<a name="line.689"></a> |
| <FONT color="green">690</FONT> * %REVIEW% Resolve Public Identifiers... or consider changing function name.<a name="line.690"></a> |
| <FONT color="green">691</FONT> * <p><a name="line.691"></a> |
| <FONT color="green">692</FONT> * If we find a relative URI<a name="line.692"></a> |
| <FONT color="green">693</FONT> * reference, XML expects it to be resolved in terms of the base URI<a name="line.693"></a> |
| <FONT color="green">694</FONT> * of the document. The DOM doesn't do that for us, and it isn't<a name="line.694"></a> |
| <FONT color="green">695</FONT> * entirely clear whether that should be done here; currently that's<a name="line.695"></a> |
| <FONT color="green">696</FONT> * pushed up to a higher level of our application. (Note that DOM Level<a name="line.696"></a> |
| <FONT color="green">697</FONT> * 1 didn't store the document's base URI.)<a name="line.697"></a> |
| <FONT color="green">698</FONT> * %REVIEW% Consider resolving Relative URIs.<a name="line.698"></a> |
| <FONT color="green">699</FONT> * <p><a name="line.699"></a> |
| <FONT color="green">700</FONT> * (The DOM's statement that "An XML processor may choose to<a name="line.700"></a> |
| <FONT color="green">701</FONT> * completely expand entities before the structure model is passed<a name="line.701"></a> |
| <FONT color="green">702</FONT> * to the DOM" refers only to parsed entities, not unparsed, and hence<a name="line.702"></a> |
| <FONT color="green">703</FONT> * doesn't affect this function.)<a name="line.703"></a> |
| <FONT color="green">704</FONT> *<a name="line.704"></a> |
| <FONT color="green">705</FONT> * @param name A string containing the Entity Name of the unparsed<a name="line.705"></a> |
| <FONT color="green">706</FONT> * entity.<a name="line.706"></a> |
| <FONT color="green">707</FONT> *<a name="line.707"></a> |
| <FONT color="green">708</FONT> * @return String containing the URI of the Unparsed Entity, or an<a name="line.708"></a> |
| <FONT color="green">709</FONT> * empty string if no such entity exists.<a name="line.709"></a> |
| <FONT color="green">710</FONT> */<a name="line.710"></a> |
| <FONT color="green">711</FONT> public String getUnparsedEntityURI(String name);<a name="line.711"></a> |
| <FONT color="green">712</FONT> <a name="line.712"></a> |
| <FONT color="green">713</FONT> // ============== Boolean methods ================<a name="line.713"></a> |
| <FONT color="green">714</FONT> <a name="line.714"></a> |
| <FONT color="green">715</FONT> /**<a name="line.715"></a> |
| <FONT color="green">716</FONT> * Return true if the xsl:strip-space or xsl:preserve-space was processed<a name="line.716"></a> |
| <FONT color="green">717</FONT> * during construction of the document contained in this DTM.<a name="line.717"></a> |
| <FONT color="green">718</FONT> *<a name="line.718"></a> |
| <FONT color="green">719</FONT> * NEEDSDOC ($objectName$) @return<a name="line.719"></a> |
| <FONT color="green">720</FONT> */<a name="line.720"></a> |
| <FONT color="green">721</FONT> public boolean supportsPreStripping();<a name="line.721"></a> |
| <FONT color="green">722</FONT> <a name="line.722"></a> |
| <FONT color="green">723</FONT> /**<a name="line.723"></a> |
| <FONT color="green">724</FONT> * Figure out whether nodeHandle2 should be considered as being later<a name="line.724"></a> |
| <FONT color="green">725</FONT> * in the document than nodeHandle1, in Document Order as defined<a name="line.725"></a> |
| <FONT color="green">726</FONT> * by the XPath model. This may not agree with the ordering defined<a name="line.726"></a> |
| <FONT color="green">727</FONT> * by other XML applications.<a name="line.727"></a> |
| <FONT color="green">728</FONT> * <p><a name="line.728"></a> |
| <FONT color="green">729</FONT> * There are some cases where ordering isn't defined, and neither are<a name="line.729"></a> |
| <FONT color="green">730</FONT> * the results of this function -- though we'll generally return true.<a name="line.730"></a> |
| <FONT color="green">731</FONT> * <p><a name="line.731"></a> |
| <FONT color="green">732</FONT> * %REVIEW% Make sure this does the right thing with attribute nodes!!!<a name="line.732"></a> |
| <FONT color="green">733</FONT> * <p><a name="line.733"></a> |
| <FONT color="green">734</FONT> * %REVIEW% Consider renaming for clarity. Perhaps isDocumentOrder(a,b)?<a name="line.734"></a> |
| <FONT color="green">735</FONT> *<a name="line.735"></a> |
| <FONT color="green">736</FONT> * @param firstNodeHandle DOM Node to perform position comparison on.<a name="line.736"></a> |
| <FONT color="green">737</FONT> * @param secondNodeHandle DOM Node to perform position comparison on.<a name="line.737"></a> |
| <FONT color="green">738</FONT> *<a name="line.738"></a> |
| <FONT color="green">739</FONT> * @return false if secondNode comes before firstNode, otherwise return true.<a name="line.739"></a> |
| <FONT color="green">740</FONT> * You can think of this as<a name="line.740"></a> |
| <FONT color="green">741</FONT> * <code>(firstNode.documentOrderPosition &lt;= secondNode.documentOrderPosition)</code>.<a name="line.741"></a> |
| <FONT color="green">742</FONT> */<a name="line.742"></a> |
| <FONT color="green">743</FONT> public boolean isNodeAfter(int firstNodeHandle, int secondNodeHandle);<a name="line.743"></a> |
| <FONT color="green">744</FONT> <a name="line.744"></a> |
| <FONT color="green">745</FONT> /**<a name="line.745"></a> |
| <FONT color="green">746</FONT> * 2. [element content whitespace] A boolean indicating whether a<a name="line.746"></a> |
| <FONT color="green">747</FONT> * text node represents white space appearing within element content<a name="line.747"></a> |
| <FONT color="green">748</FONT> * (see [XML], 2.10 "White Space Handling"). Note that validating<a name="line.748"></a> |
| <FONT color="green">749</FONT> * XML processors are required by XML 1.0 to provide this<a name="line.749"></a> |
| <FONT color="green">750</FONT> * information... but that DOM Level 2 did not support it, since it<a name="line.750"></a> |
| <FONT color="green">751</FONT> * depends on knowledge of the DTD which DOM2 could not guarantee<a name="line.751"></a> |
| <FONT color="green">752</FONT> * would be available.<a name="line.752"></a> |
| <FONT color="green">753</FONT> * <p><a name="line.753"></a> |
| <FONT color="green">754</FONT> * If there is no declaration for the containing element, an XML<a name="line.754"></a> |
| <FONT color="green">755</FONT> * processor must assume that the whitespace could be meaningful and<a name="line.755"></a> |
| <FONT color="green">756</FONT> * return false. If no declaration has been read, but the [all<a name="line.756"></a> |
| <FONT color="green">757</FONT> * declarations processed] property of the document information item<a name="line.757"></a> |
| <FONT color="green">758</FONT> * is false (so there may be an unread declaration), then the value<a name="line.758"></a> |
| <FONT color="green">759</FONT> * of this property is indeterminate for white space characters and<a name="line.759"></a> |
| <FONT color="green">760</FONT> * should probably be reported as false. It is always false for text<a name="line.760"></a> |
| <FONT color="green">761</FONT> * nodes that contain anything other than (or in addition to) white<a name="line.761"></a> |
| <FONT color="green">762</FONT> * space.<a name="line.762"></a> |
| <FONT color="green">763</FONT> * <p><a name="line.763"></a> |
| <FONT color="green">764</FONT> * Note too that it always returns false for non-Text nodes.<a name="line.764"></a> |
| <FONT color="green">765</FONT> * <p><a name="line.765"></a> |
| <FONT color="green">766</FONT> * %REVIEW% Joe wants to rename this isWhitespaceInElementContent() for clarity<a name="line.766"></a> |
| <FONT color="green">767</FONT> *<a name="line.767"></a> |
| <FONT color="green">768</FONT> * @param nodeHandle the node ID.<a name="line.768"></a> |
| <FONT color="green">769</FONT> * @return <code>true</code> if the node definitely represents whitespace in<a name="line.769"></a> |
| <FONT color="green">770</FONT> * element content; <code>false</code> otherwise.<a name="line.770"></a> |
| <FONT color="green">771</FONT> */<a name="line.771"></a> |
| <FONT color="green">772</FONT> public boolean isCharacterElementContentWhitespace(int nodeHandle);<a name="line.772"></a> |
| <FONT color="green">773</FONT> <a name="line.773"></a> |
| <FONT color="green">774</FONT> /**<a name="line.774"></a> |
| <FONT color="green">775</FONT> * 10. [all declarations processed] This property is not strictly speaking<a name="line.775"></a> |
| <FONT color="green">776</FONT> * part of the infoset of the document. Rather it is an indication of<a name="line.776"></a> |
| <FONT color="green">777</FONT> * whether the processor has read the complete DTD. Its value is a<a name="line.777"></a> |
| <FONT color="green">778</FONT> * boolean. If it is false, then certain properties (indicated in their<a name="line.778"></a> |
| <FONT color="green">779</FONT> * descriptions below) may be unknown. If it is true, those properties<a name="line.779"></a> |
| <FONT color="green">780</FONT> * are never unknown.<a name="line.780"></a> |
| <FONT color="green">781</FONT> *<a name="line.781"></a> |
| <FONT color="green">782</FONT> * @param documentHandle A node handle that must identify a document.<a name="line.782"></a> |
| <FONT color="green">783</FONT> * @return <code>true</code> if all declarations were processed;<a name="line.783"></a> |
| <FONT color="green">784</FONT> * <code>false</code> otherwise.<a name="line.784"></a> |
| <FONT color="green">785</FONT> */<a name="line.785"></a> |
| <FONT color="green">786</FONT> public boolean isDocumentAllDeclarationsProcessed(int documentHandle);<a name="line.786"></a> |
| <FONT color="green">787</FONT> <a name="line.787"></a> |
| <FONT color="green">788</FONT> /**<a name="line.788"></a> |
| <FONT color="green">789</FONT> * 5. [specified] A flag indicating whether this attribute was actually<a name="line.789"></a> |
| <FONT color="green">790</FONT> * specified in the start-tag of its element, or was defaulted from the<a name="line.790"></a> |
| <FONT color="green">791</FONT> * DTD (or schema).<a name="line.791"></a> |
| <FONT color="green">792</FONT> *<a name="line.792"></a> |
| <FONT color="green">793</FONT> * @param attributeHandle The attribute handle<a name="line.793"></a> |
| <FONT color="green">794</FONT> * @return <code>true</code> if the attribute was specified;<a name="line.794"></a> |
| <FONT color="green">795</FONT> * <code>false</code> if it was defaulted or the handle doesn't<a name="line.795"></a> |
| <FONT color="green">796</FONT> * refer to an attribute node.<a name="line.796"></a> |
| <FONT color="green">797</FONT> */<a name="line.797"></a> |
| <FONT color="green">798</FONT> public boolean isAttributeSpecified(int attributeHandle);<a name="line.798"></a> |
| <FONT color="green">799</FONT> <a name="line.799"></a> |
| <FONT color="green">800</FONT> // ========== Direct SAX Dispatch, for optimization purposes ========<a name="line.800"></a> |
| <FONT color="green">801</FONT> <a name="line.801"></a> |
| <FONT color="green">802</FONT> /**<a name="line.802"></a> |
| <FONT color="green">803</FONT> * Directly call the<a name="line.803"></a> |
| <FONT color="green">804</FONT> * characters method on the passed ContentHandler for the<a name="line.804"></a> |
| <FONT color="green">805</FONT> * string-value of the given node (see http://www.w3.org/TR/xpath#data-model<a name="line.805"></a> |
| <FONT color="green">806</FONT> * for the definition of a node's string-value). Multiple calls to the<a name="line.806"></a> |
| <FONT color="green">807</FONT> * ContentHandler's characters methods may well occur for a single call to<a name="line.807"></a> |
| <FONT color="green">808</FONT> * this method.<a name="line.808"></a> |
| <FONT color="green">809</FONT> *<a name="line.809"></a> |
| <FONT color="green">810</FONT> * @param nodeHandle The node ID.<a name="line.810"></a> |
| <FONT color="green">811</FONT> * @param ch A non-null reference to a ContentHandler.<a name="line.811"></a> |
| <FONT color="green">812</FONT> * @param normalize true if the content should be normalized according to<a name="line.812"></a> |
| <FONT color="green">813</FONT> * the rules for the XPath<a name="line.813"></a> |
| <FONT color="green">814</FONT> * <a href="http://www.w3.org/TR/xpath#function-normalize-space">normalize-space</a><a name="line.814"></a> |
| <FONT color="green">815</FONT> * function.<a name="line.815"></a> |
| <FONT color="green">816</FONT> *<a name="line.816"></a> |
| <FONT color="green">817</FONT> * @throws org.xml.sax.SAXException<a name="line.817"></a> |
| <FONT color="green">818</FONT> */<a name="line.818"></a> |
| <FONT color="green">819</FONT> public void dispatchCharactersEvents(<a name="line.819"></a> |
| <FONT color="green">820</FONT> int nodeHandle, org.xml.sax.ContentHandler ch, boolean normalize)<a name="line.820"></a> |
| <FONT color="green">821</FONT> throws org.xml.sax.SAXException;<a name="line.821"></a> |
| <FONT color="green">822</FONT> <a name="line.822"></a> |
| <FONT color="green">823</FONT> /**<a name="line.823"></a> |
| <FONT color="green">824</FONT> * Directly create SAX parser events representing the XML content of<a name="line.824"></a> |
| <FONT color="green">825</FONT> * a DTM subtree. This is a "serialize" operation.<a name="line.825"></a> |
| <FONT color="green">826</FONT> *<a name="line.826"></a> |
| <FONT color="green">827</FONT> * @param nodeHandle The node ID.<a name="line.827"></a> |
| <FONT color="green">828</FONT> * @param ch A non-null reference to a ContentHandler.<a name="line.828"></a> |
| <FONT color="green">829</FONT> *<a name="line.829"></a> |
| <FONT color="green">830</FONT> * @throws org.xml.sax.SAXException<a name="line.830"></a> |
| <FONT color="green">831</FONT> */<a name="line.831"></a> |
| <FONT color="green">832</FONT> public void dispatchToEvents(int nodeHandle, org.xml.sax.ContentHandler ch)<a name="line.832"></a> |
| <FONT color="green">833</FONT> throws org.xml.sax.SAXException;<a name="line.833"></a> |
| <FONT color="green">834</FONT> <a name="line.834"></a> |
| <FONT color="green">835</FONT> /**<a name="line.835"></a> |
| <FONT color="green">836</FONT> * Return an DOM node for the given node.<a name="line.836"></a> |
| <FONT color="green">837</FONT> *<a name="line.837"></a> |
| <FONT color="green">838</FONT> * @param nodeHandle The node ID.<a name="line.838"></a> |
| <FONT color="green">839</FONT> *<a name="line.839"></a> |
| <FONT color="green">840</FONT> * @return A node representation of the DTM node.<a name="line.840"></a> |
| <FONT color="green">841</FONT> */<a name="line.841"></a> |
| <FONT color="green">842</FONT> public org.w3c.dom.Node getNode(int nodeHandle);<a name="line.842"></a> |
| <FONT color="green">843</FONT> <a name="line.843"></a> |
| <FONT color="green">844</FONT> // ==== Construction methods (may not be supported by some implementations!) =====<a name="line.844"></a> |
| <FONT color="green">845</FONT> // %REVIEW% What response occurs if not supported?<a name="line.845"></a> |
| <FONT color="green">846</FONT> <a name="line.846"></a> |
| <FONT color="green">847</FONT> /**<a name="line.847"></a> |
| <FONT color="green">848</FONT> * @return true iff we're building this model incrementally (eg<a name="line.848"></a> |
| <FONT color="green">849</FONT> * we're partnered with a CoroutineParser) and thus require that the<a name="line.849"></a> |
| <FONT color="green">850</FONT> * transformation and the parse run simultaneously. Guidance to the<a name="line.850"></a> |
| <FONT color="green">851</FONT> * DTMManager.<a name="line.851"></a> |
| <FONT color="green">852</FONT> */<a name="line.852"></a> |
| <FONT color="green">853</FONT> public boolean needsTwoThreads();<a name="line.853"></a> |
| <FONT color="green">854</FONT> <a name="line.854"></a> |
| <FONT color="green">855</FONT> // %REVIEW% Do these appends make any sense, should we support a<a name="line.855"></a> |
| <FONT color="green">856</FONT> // wider set of methods (like the "append" methods in the<a name="line.856"></a> |
| <FONT color="green">857</FONT> // current DTMDocumentImpl draft), or should we just support SAX<a name="line.857"></a> |
| <FONT color="green">858</FONT> // listener interfaces? Should it be a separate interface to<a name="line.858"></a> |
| <FONT color="green">859</FONT> // make that distinction explicit?<a name="line.859"></a> |
| <FONT color="green">860</FONT> <a name="line.860"></a> |
| <FONT color="green">861</FONT> /**<a name="line.861"></a> |
| <FONT color="green">862</FONT> * Return this DTM's content handler, if it has one.<a name="line.862"></a> |
| <FONT color="green">863</FONT> *<a name="line.863"></a> |
| <FONT color="green">864</FONT> * @return null if this model doesn't respond to SAX events.<a name="line.864"></a> |
| <FONT color="green">865</FONT> */<a name="line.865"></a> |
| <FONT color="green">866</FONT> public org.xml.sax.ContentHandler getContentHandler();<a name="line.866"></a> |
| <FONT color="green">867</FONT> <a name="line.867"></a> |
| <FONT color="green">868</FONT> /**<a name="line.868"></a> |
| <FONT color="green">869</FONT> * Return this DTM's lexical handler, if it has one.<a name="line.869"></a> |
| <FONT color="green">870</FONT> *<a name="line.870"></a> |
| <FONT color="green">871</FONT> * %REVIEW% Should this return null if constrution already done/begun?<a name="line.871"></a> |
| <FONT color="green">872</FONT> *<a name="line.872"></a> |
| <FONT color="green">873</FONT> * @return null if this model doesn't respond to lexical SAX events.<a name="line.873"></a> |
| <FONT color="green">874</FONT> */<a name="line.874"></a> |
| <FONT color="green">875</FONT> public org.xml.sax.ext.LexicalHandler getLexicalHandler();<a name="line.875"></a> |
| <FONT color="green">876</FONT> <a name="line.876"></a> |
| <FONT color="green">877</FONT> /**<a name="line.877"></a> |
| <FONT color="green">878</FONT> * Return this DTM's EntityResolver, if it has one.<a name="line.878"></a> |
| <FONT color="green">879</FONT> *<a name="line.879"></a> |
| <FONT color="green">880</FONT> * @return null if this model doesn't respond to SAX entity ref events.<a name="line.880"></a> |
| <FONT color="green">881</FONT> */<a name="line.881"></a> |
| <FONT color="green">882</FONT> public org.xml.sax.EntityResolver getEntityResolver();<a name="line.882"></a> |
| <FONT color="green">883</FONT> <a name="line.883"></a> |
| <FONT color="green">884</FONT> /**<a name="line.884"></a> |
| <FONT color="green">885</FONT> * Return this DTM's DTDHandler, if it has one.<a name="line.885"></a> |
| <FONT color="green">886</FONT> *<a name="line.886"></a> |
| <FONT color="green">887</FONT> * @return null if this model doesn't respond to SAX dtd events.<a name="line.887"></a> |
| <FONT color="green">888</FONT> */<a name="line.888"></a> |
| <FONT color="green">889</FONT> public org.xml.sax.DTDHandler getDTDHandler();<a name="line.889"></a> |
| <FONT color="green">890</FONT> <a name="line.890"></a> |
| <FONT color="green">891</FONT> /**<a name="line.891"></a> |
| <FONT color="green">892</FONT> * Return this DTM's ErrorHandler, if it has one.<a name="line.892"></a> |
| <FONT color="green">893</FONT> *<a name="line.893"></a> |
| <FONT color="green">894</FONT> * @return null if this model doesn't respond to SAX error events.<a name="line.894"></a> |
| <FONT color="green">895</FONT> */<a name="line.895"></a> |
| <FONT color="green">896</FONT> public org.xml.sax.ErrorHandler getErrorHandler();<a name="line.896"></a> |
| <FONT color="green">897</FONT> <a name="line.897"></a> |
| <FONT color="green">898</FONT> /**<a name="line.898"></a> |
| <FONT color="green">899</FONT> * Return this DTM's DeclHandler, if it has one.<a name="line.899"></a> |
| <FONT color="green">900</FONT> *<a name="line.900"></a> |
| <FONT color="green">901</FONT> * @return null if this model doesn't respond to SAX Decl events.<a name="line.901"></a> |
| <FONT color="green">902</FONT> */<a name="line.902"></a> |
| <FONT color="green">903</FONT> public org.xml.sax.ext.DeclHandler getDeclHandler();<a name="line.903"></a> |
| <FONT color="green">904</FONT> <a name="line.904"></a> |
| <FONT color="green">905</FONT> /**<a name="line.905"></a> |
| <FONT color="green">906</FONT> * Append a child to "the end of the document". Please note that<a name="line.906"></a> |
| <FONT color="green">907</FONT> * the node is always cloned in a base DTM, since our basic behavior<a name="line.907"></a> |
| <FONT color="green">908</FONT> * is immutable so nodes can't be removed from their previous<a name="line.908"></a> |
| <FONT color="green">909</FONT> * location.<a name="line.909"></a> |
| <FONT color="green">910</FONT> *<a name="line.910"></a> |
| <FONT color="green">911</FONT> * <p> %REVIEW% DTM maintains an insertion cursor which<a name="line.911"></a> |
| <FONT color="green">912</FONT> * performs a depth-first tree walk as nodes come in, and this operation<a name="line.912"></a> |
| <FONT color="green">913</FONT> * is really equivalent to:<a name="line.913"></a> |
| <FONT color="green">914</FONT> * insertionCursor.appendChild(document.importNode(newChild)))<a name="line.914"></a> |
| <FONT color="green">915</FONT> * where the insert point is the last element that was appended (or<a name="line.915"></a> |
| <FONT color="green">916</FONT> * the last one popped back to by an end-element operation).</p><a name="line.916"></a> |
| <FONT color="green">917</FONT> *<a name="line.917"></a> |
| <FONT color="green">918</FONT> * @param newChild Must be a valid new node handle.<a name="line.918"></a> |
| <FONT color="green">919</FONT> * @param clone true if the child should be cloned into the document.<a name="line.919"></a> |
| <FONT color="green">920</FONT> * @param cloneDepth if the clone argument is true, specifies that the<a name="line.920"></a> |
| <FONT color="green">921</FONT> * clone should include all it's children.<a name="line.921"></a> |
| <FONT color="green">922</FONT> */<a name="line.922"></a> |
| <FONT color="green">923</FONT> public void appendChild(int newChild, boolean clone, boolean cloneDepth);<a name="line.923"></a> |
| <FONT color="green">924</FONT> <a name="line.924"></a> |
| <FONT color="green">925</FONT> /**<a name="line.925"></a> |
| <FONT color="green">926</FONT> * Append a text node child that will be constructed from a string,<a name="line.926"></a> |
| <FONT color="green">927</FONT> * to the end of the document. Behavior is otherwise like appendChild().<a name="line.927"></a> |
| <FONT color="green">928</FONT> *<a name="line.928"></a> |
| <FONT color="green">929</FONT> * @param str Non-null reference to a string.<a name="line.929"></a> |
| <FONT color="green">930</FONT> */<a name="line.930"></a> |
| <FONT color="green">931</FONT> public void appendTextChild(String str);<a name="line.931"></a> |
| <FONT color="green">932</FONT> <a name="line.932"></a> |
| <FONT color="green">933</FONT> /**<a name="line.933"></a> |
| <FONT color="green">934</FONT> * Get the location of a node in the source document.<a name="line.934"></a> |
| <FONT color="green">935</FONT> *<a name="line.935"></a> |
| <FONT color="green">936</FONT> * @param node an <code>int</code> value<a name="line.936"></a> |
| <FONT color="green">937</FONT> * @return a <code>SourceLocator</code> value or null if no location<a name="line.937"></a> |
| <FONT color="green">938</FONT> * is available<a name="line.938"></a> |
| <FONT color="green">939</FONT> */<a name="line.939"></a> |
| <FONT color="green">940</FONT> public SourceLocator getSourceLocatorFor(int node);<a name="line.940"></a> |
| <FONT color="green">941</FONT> <a name="line.941"></a> |
| <FONT color="green">942</FONT> /**<a name="line.942"></a> |
| <FONT color="green">943</FONT> * As the DTM is registered with the DTMManager, this method<a name="line.943"></a> |
| <FONT color="green">944</FONT> * will be called. This will give the DTM implementation a<a name="line.944"></a> |
| <FONT color="green">945</FONT> * chance to initialize any subsystems that are required to<a name="line.945"></a> |
| <FONT color="green">946</FONT> * build the DTM<a name="line.946"></a> |
| <FONT color="green">947</FONT> */<a name="line.947"></a> |
| <FONT color="green">948</FONT> public void documentRegistration();<a name="line.948"></a> |
| <FONT color="green">949</FONT> <a name="line.949"></a> |
| <FONT color="green">950</FONT> /**<a name="line.950"></a> |
| <FONT color="green">951</FONT> * As documents are released from the DTMManager, the DTM implementation<a name="line.951"></a> |
| <FONT color="green">952</FONT> * will be notified of the event. This will allow the DTM implementation<a name="line.952"></a> |
| <FONT color="green">953</FONT> * to shutdown any subsystem activity that may of been assoiated with<a name="line.953"></a> |
| <FONT color="green">954</FONT> * the active DTM Implementation.<a name="line.954"></a> |
| <FONT color="green">955</FONT> */<a name="line.955"></a> |
| <FONT color="green">956</FONT> <a name="line.956"></a> |
| <FONT color="green">957</FONT> public void documentRelease();<a name="line.957"></a> |
| <FONT color="green">958</FONT> <a name="line.958"></a> |
| <FONT color="green">959</FONT> /**<a name="line.959"></a> |
| <FONT color="green">960</FONT> * Migrate a DTM built with an old DTMManager to a new DTMManager.<a name="line.960"></a> |
| <FONT color="green">961</FONT> * After the migration, the new DTMManager will treat the DTM as<a name="line.961"></a> |
| <FONT color="green">962</FONT> * one that is built by itself.<a name="line.962"></a> |
| <FONT color="green">963</FONT> * This is used to support DTM sharing between multiple transformations.<a name="line.963"></a> |
| <FONT color="green">964</FONT> * @param manager the DTMManager<a name="line.964"></a> |
| <FONT color="green">965</FONT> */<a name="line.965"></a> |
| <FONT color="green">966</FONT> public void migrateTo(DTMManager manager);<a name="line.966"></a> |
| <FONT color="green">967</FONT> }<a name="line.967"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
