| <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: DTMFilter.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> /**<a name="line.23"></a> |
| <FONT color="green">024</FONT> * Simple filter for doing node tests. Note the semantics of this are<a name="line.24"></a> |
| <FONT color="green">025</FONT> * somewhat different that the DOM's NodeFilter.<a name="line.25"></a> |
| <FONT color="green">026</FONT> */<a name="line.26"></a> |
| <FONT color="green">027</FONT> public interface DTMFilter<a name="line.27"></a> |
| <FONT color="green">028</FONT> {<a name="line.28"></a> |
| <FONT color="green">029</FONT> <a name="line.29"></a> |
| <FONT color="green">030</FONT> // Constants for whatToShow. These are used to set the node type that will <a name="line.30"></a> |
| <FONT color="green">031</FONT> // be traversed. These values may be ORed together before being passed to<a name="line.31"></a> |
| <FONT color="green">032</FONT> // the DTMIterator.<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Show all <code>Nodes</code>.<a name="line.35"></a> |
| <FONT color="green">036</FONT> */<a name="line.36"></a> |
| <FONT color="green">037</FONT> public static final int SHOW_ALL = 0xFFFFFFFF;<a name="line.37"></a> |
| <FONT color="green">038</FONT> <a name="line.38"></a> |
| <FONT color="green">039</FONT> /**<a name="line.39"></a> |
| <FONT color="green">040</FONT> * Show <code>Element</code> nodes.<a name="line.40"></a> |
| <FONT color="green">041</FONT> */<a name="line.41"></a> |
| <FONT color="green">042</FONT> public static final int SHOW_ELEMENT = 0x00000001;<a name="line.42"></a> |
| <FONT color="green">043</FONT> <a name="line.43"></a> |
| <FONT color="green">044</FONT> /**<a name="line.44"></a> |
| <FONT color="green">045</FONT> * Show <code>Attr</code> nodes. This is meaningful only when creating an<a name="line.45"></a> |
| <FONT color="green">046</FONT> * iterator or tree-walker with an attribute node as its<a name="line.46"></a> |
| <FONT color="green">047</FONT> * <code>root</code>; in this case, it means that the attribute node<a name="line.47"></a> |
| <FONT color="green">048</FONT> * will appear in the first position of the iteration or traversal.<a name="line.48"></a> |
| <FONT color="green">049</FONT> * Since attributes are never children of other nodes, they do not<a name="line.49"></a> |
| <FONT color="green">050</FONT> * appear when traversing over the main document tree.<a name="line.50"></a> |
| <FONT color="green">051</FONT> */<a name="line.51"></a> |
| <FONT color="green">052</FONT> public static final int SHOW_ATTRIBUTE = 0x00000002;<a name="line.52"></a> |
| <FONT color="green">053</FONT> <a name="line.53"></a> |
| <FONT color="green">054</FONT> /**<a name="line.54"></a> |
| <FONT color="green">055</FONT> * Show <code>Text</code> nodes.<a name="line.55"></a> |
| <FONT color="green">056</FONT> */<a name="line.56"></a> |
| <FONT color="green">057</FONT> public static final int SHOW_TEXT = 0x00000004;<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> * Show <code>CDATASection</code> nodes.<a name="line.60"></a> |
| <FONT color="green">061</FONT> */<a name="line.61"></a> |
| <FONT color="green">062</FONT> public static final int SHOW_CDATA_SECTION = 0x00000008;<a name="line.62"></a> |
| <FONT color="green">063</FONT> <a name="line.63"></a> |
| <FONT color="green">064</FONT> /**<a name="line.64"></a> |
| <FONT color="green">065</FONT> * Show <code>EntityReference</code> nodes. Note that if Entity References<a name="line.65"></a> |
| <FONT color="green">066</FONT> * have been fully expanded while the tree was being constructed, these<a name="line.66"></a> |
| <FONT color="green">067</FONT> * nodes will not appear and this mask has no effect.<a name="line.67"></a> |
| <FONT color="green">068</FONT> */<a name="line.68"></a> |
| <FONT color="green">069</FONT> public static final int SHOW_ENTITY_REFERENCE = 0x00000010;<a name="line.69"></a> |
| <FONT color="green">070</FONT> <a name="line.70"></a> |
| <FONT color="green">071</FONT> /**<a name="line.71"></a> |
| <FONT color="green">072</FONT> * Show <code>Entity</code> nodes. This is meaningful only when creating<a name="line.72"></a> |
| <FONT color="green">073</FONT> * an iterator or tree-walker with an<code> Entity</code> node as its<a name="line.73"></a> |
| <FONT color="green">074</FONT> * <code>root</code>; in this case, it means that the <code>Entity</code><a name="line.74"></a> |
| <FONT color="green">075</FONT> * node will appear in the first position of the traversal. Since<a name="line.75"></a> |
| <FONT color="green">076</FONT> * entities are not part of the document tree, they do not appear when<a name="line.76"></a> |
| <FONT color="green">077</FONT> * traversing over the main document tree.<a name="line.77"></a> |
| <FONT color="green">078</FONT> */<a name="line.78"></a> |
| <FONT color="green">079</FONT> public static final int SHOW_ENTITY = 0x00000020;<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> * Show <code>ProcessingInstruction</code> nodes.<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> public static final int SHOW_PROCESSING_INSTRUCTION = 0x00000040;<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> /**<a name="line.86"></a> |
| <FONT color="green">087</FONT> * Show <code>Comment</code> nodes.<a name="line.87"></a> |
| <FONT color="green">088</FONT> */<a name="line.88"></a> |
| <FONT color="green">089</FONT> public static final int SHOW_COMMENT = 0x00000080;<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> * Show <code>Document</code> nodes. (Of course, as with Attributes<a name="line.92"></a> |
| <FONT color="green">093</FONT> * and such, this is meaningful only when the iteration root is the<a name="line.93"></a> |
| <FONT color="green">094</FONT> * Document itself, since Document has no parent.)<a name="line.94"></a> |
| <FONT color="green">095</FONT> */<a name="line.95"></a> |
| <FONT color="green">096</FONT> public static final int SHOW_DOCUMENT = 0x00000100;<a name="line.96"></a> |
| <FONT color="green">097</FONT> <a name="line.97"></a> |
| <FONT color="green">098</FONT> /**<a name="line.98"></a> |
| <FONT color="green">099</FONT> * Show <code>DocumentType</code> nodes. <a name="line.99"></a> |
| <FONT color="green">100</FONT> */<a name="line.100"></a> |
| <FONT color="green">101</FONT> public static final int SHOW_DOCUMENT_TYPE = 0x00000200;<a name="line.101"></a> |
| <FONT color="green">102</FONT> <a name="line.102"></a> |
| <FONT color="green">103</FONT> /**<a name="line.103"></a> |
| <FONT color="green">104</FONT> * Show <code>DocumentFragment</code> nodes. (Of course, as with<a name="line.104"></a> |
| <FONT color="green">105</FONT> * Attributes and such, this is meaningful only when the iteration<a name="line.105"></a> |
| <FONT color="green">106</FONT> * root is the Document itself, since DocumentFragment has no parent.)<a name="line.106"></a> |
| <FONT color="green">107</FONT> */<a name="line.107"></a> |
| <FONT color="green">108</FONT> public static final int SHOW_DOCUMENT_FRAGMENT = 0x00000400;<a name="line.108"></a> |
| <FONT color="green">109</FONT> <a name="line.109"></a> |
| <FONT color="green">110</FONT> /**<a name="line.110"></a> |
| <FONT color="green">111</FONT> * Show <code>Notation</code> nodes. This is meaningful only when creating<a name="line.111"></a> |
| <FONT color="green">112</FONT> * an iterator or tree-walker with a <code>Notation</code> node as its<a name="line.112"></a> |
| <FONT color="green">113</FONT> * <code>root</code>; in this case, it means that the<a name="line.113"></a> |
| <FONT color="green">114</FONT> * <code>Notation</code> node will appear in the first position of the<a name="line.114"></a> |
| <FONT color="green">115</FONT> * traversal. Since notations are not part of the document tree, they do<a name="line.115"></a> |
| <FONT color="green">116</FONT> * not appear when traversing over the main document tree.<a name="line.116"></a> |
| <FONT color="green">117</FONT> */<a name="line.117"></a> |
| <FONT color="green">118</FONT> public static final int SHOW_NOTATION = 0x00000800;<a name="line.118"></a> |
| <FONT color="green">119</FONT> <a name="line.119"></a> |
| <FONT color="green">120</FONT> /**<a name="line.120"></a> |
| <FONT color="green">121</FONT> <a name="line.121"></a> |
| <FONT color="green">122</FONT> * This bit instructs the iterator to show namespace nodes, which<a name="line.122"></a> |
| <FONT color="green">123</FONT> * are modeled by DTM but not by the DOM. Make sure this does not<a name="line.123"></a> |
| <FONT color="green">124</FONT> * conflict with {@link org.w3c.dom.traversal.NodeFilter}.<a name="line.124"></a> |
| <FONT color="green">125</FONT> * <p><a name="line.125"></a> |
| <FONT color="green">126</FONT> * %REVIEW% Might be safer to start from higher bits and work down,<a name="line.126"></a> |
| <FONT color="green">127</FONT> * to leave room for the DOM to expand its set of constants... Or,<a name="line.127"></a> |
| <FONT color="green">128</FONT> * possibly, to create a DTM-specific field for these additional bits.<a name="line.128"></a> |
| <FONT color="green">129</FONT> */<a name="line.129"></a> |
| <FONT color="green">130</FONT> public static final int SHOW_NAMESPACE = 0x00001000;<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> * Special bit for filters implementing match patterns starting with<a name="line.133"></a> |
| <FONT color="green">134</FONT> * a function. Make sure this does not conflict with<a name="line.134"></a> |
| <FONT color="green">135</FONT> * {@link org.w3c.dom.traversal.NodeFilter}.<a name="line.135"></a> |
| <FONT color="green">136</FONT> * <p><a name="line.136"></a> |
| <FONT color="green">137</FONT> * %REVIEW% Might be safer to start from higher bits and work down,<a name="line.137"></a> |
| <FONT color="green">138</FONT> * to leave room for the DOM to expand its set of constants... Or,<a name="line.138"></a> |
| <FONT color="green">139</FONT> * possibly, to create a DTM-specific field for these additional bits.<a name="line.139"></a> |
| <FONT color="green">140</FONT> */<a name="line.140"></a> |
| <FONT color="green">141</FONT> public static final int SHOW_BYFUNCTION = 0x00010000;<a name="line.141"></a> |
| <FONT color="green">142</FONT> <a name="line.142"></a> |
| <FONT color="green">143</FONT> /**<a name="line.143"></a> |
| <FONT color="green">144</FONT> * Test whether a specified node is visible in the logical view of a<a name="line.144"></a> |
| <FONT color="green">145</FONT> * <code>DTMIterator</code>. Normally, this function<a name="line.145"></a> |
| <FONT color="green">146</FONT> * will be called by the implementation of <code>DTMIterator</code>; <a name="line.146"></a> |
| <FONT color="green">147</FONT> * it is not normally called directly from<a name="line.147"></a> |
| <FONT color="green">148</FONT> * user code.<a name="line.148"></a> |
| <FONT color="green">149</FONT> * <a name="line.149"></a> |
| <FONT color="green">150</FONT> * @param nodeHandle int Handle of the node.<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @param whatToShow one of SHOW_XXX values.<a name="line.151"></a> |
| <FONT color="green">152</FONT> * @return one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP.<a name="line.152"></a> |
| <FONT color="green">153</FONT> */<a name="line.153"></a> |
| <FONT color="green">154</FONT> public short acceptNode(int nodeHandle, int whatToShow);<a name="line.154"></a> |
| <FONT color="green">155</FONT> <a name="line.155"></a> |
| <FONT color="green">156</FONT> /**<a name="line.156"></a> |
| <FONT color="green">157</FONT> * Test whether a specified node is visible in the logical view of a<a name="line.157"></a> |
| <FONT color="green">158</FONT> * <code>DTMIterator</code>. Normally, this function<a name="line.158"></a> |
| <FONT color="green">159</FONT> * will be called by the implementation of <code>DTMIterator</code>; <a name="line.159"></a> |
| <FONT color="green">160</FONT> * it is not normally called directly from<a name="line.160"></a> |
| <FONT color="green">161</FONT> * user code.<a name="line.161"></a> |
| <FONT color="green">162</FONT> * <p><a name="line.162"></a> |
| <FONT color="green">163</FONT> * TODO: Should this be setNameMatch(expandedName) followed by accept()?<a name="line.163"></a> |
| <FONT color="green">164</FONT> * Or will we really be testing a different name at every invocation?<a name="line.164"></a> |
| <FONT color="green">165</FONT> * <a name="line.165"></a> |
| <FONT color="green">166</FONT> * <p>%REVIEW% Under what circumstances will this be used? The cases<a name="line.166"></a> |
| <FONT color="green">167</FONT> * I've considered are just as easy and just about as efficient if<a name="line.167"></a> |
| <FONT color="green">168</FONT> * the name test is performed in the DTMIterator... -- Joe</p><a name="line.168"></a> |
| <FONT color="green">169</FONT> * <a name="line.169"></a> |
| <FONT color="green">170</FONT> * <p>%REVIEW% Should that 0xFFFF have a mnemonic assigned to it?<a name="line.170"></a> |
| <FONT color="green">171</FONT> * Also: This representation is assuming the expanded name is indeed<a name="line.171"></a> |
| <FONT color="green">172</FONT> * split into high/low 16-bit halfwords. If we ever change the<a name="line.172"></a> |
| <FONT color="green">173</FONT> * balance between namespace and localname bits (eg because we<a name="line.173"></a> |
| <FONT color="green">174</FONT> * decide there are many more localnames than namespaces, which is<a name="line.174"></a> |
| <FONT color="green">175</FONT> * fairly likely), this is going to break. It might be safer to<a name="line.175"></a> |
| <FONT color="green">176</FONT> * encapsulate the details with a makeExpandedName method and make<a name="line.176"></a> |
| <FONT color="green">177</FONT> * that responsible for setting up the wildcard version as well.</p><a name="line.177"></a> |
| <FONT color="green">178</FONT> * <a name="line.178"></a> |
| <FONT color="green">179</FONT> * @param nodeHandle int Handle of the node.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @param whatToShow one of SHOW_XXX values.<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @param expandedName a value defining the exanded name as defined in <a name="line.181"></a> |
| <FONT color="green">182</FONT> * the DTM interface. Wild cards will be defined <a name="line.182"></a> |
| <FONT color="green">183</FONT> * by 0xFFFF in the namespace and/or localname<a name="line.183"></a> |
| <FONT color="green">184</FONT> * portion of the expandedName.<a name="line.184"></a> |
| <FONT color="green">185</FONT> * @return one of FILTER_ACCEPT, FILTER_REJECT, or FILTER_SKIP. */<a name="line.185"></a> |
| <FONT color="green">186</FONT> public short acceptNode(int nodeHandle, int whatToShow, int expandedName);<a name="line.186"></a> |
| <FONT color="green">187</FONT> <a name="line.187"></a> |
| <FONT color="green">188</FONT> }<a name="line.188"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
