blob: 8e56d0d3fb918212fdbdbdad0a8dd997d09d264c [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: Axis.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> * Specifies values related to XPath Axes.<a name="line.24"></a>
<FONT color="green">025</FONT> * &lt;p&gt;The ancestor, descendant, following, preceding and self axes partition a<a name="line.25"></a>
<FONT color="green">026</FONT> * document (ignoring attribute and namespace nodes): they do not overlap<a name="line.26"></a>
<FONT color="green">027</FONT> * and together they contain all the nodes in the document.&lt;/p&gt;<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> public final class Axis<a name="line.30"></a>
<FONT color="green">031</FONT> {<a name="line.31"></a>
<FONT color="green">032</FONT> <a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * The ancestor axis contains the ancestors of the context node;<a name="line.34"></a>
<FONT color="green">035</FONT> * the ancestors of the context node consist of the parent of context<a name="line.35"></a>
<FONT color="green">036</FONT> * node and the parent's parent and so on; thus, the ancestor axis will<a name="line.36"></a>
<FONT color="green">037</FONT> * always include the root node, unless the context node is the root node.<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public static final int ANCESTOR = 0;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /**<a name="line.41"></a>
<FONT color="green">042</FONT> * the ancestor-or-self axis contains the context node and the ancestors of<a name="line.42"></a>
<FONT color="green">043</FONT> * the context node; thus, the ancestor axis will always include the<a name="line.43"></a>
<FONT color="green">044</FONT> * root node.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> public static final int ANCESTORORSELF = 1;<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * the attribute axis contains the attributes of the context node; the axis<a name="line.49"></a>
<FONT color="green">050</FONT> * will be empty unless the context node is an element.<a name="line.50"></a>
<FONT color="green">051</FONT> */<a name="line.51"></a>
<FONT color="green">052</FONT> public static final int ATTRIBUTE = 2;<a name="line.52"></a>
<FONT color="green">053</FONT> <a name="line.53"></a>
<FONT color="green">054</FONT> /** The child axis contains the children of the context node. */<a name="line.54"></a>
<FONT color="green">055</FONT> public static final int CHILD = 3;<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * The descendant axis contains the descendants of the context node;<a name="line.58"></a>
<FONT color="green">059</FONT> * a descendant is a child or a child of a child and so on; thus the<a name="line.59"></a>
<FONT color="green">060</FONT> * descendant axis never contains attribute or namespace 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 DESCENDANT = 4;<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> * The descendant-or-self axis contains the context node and the<a name="line.65"></a>
<FONT color="green">066</FONT> * descendants of the context node.<a name="line.66"></a>
<FONT color="green">067</FONT> */<a name="line.67"></a>
<FONT color="green">068</FONT> public static final int DESCENDANTORSELF = 5;<a name="line.68"></a>
<FONT color="green">069</FONT> <a name="line.69"></a>
<FONT color="green">070</FONT> /**<a name="line.70"></a>
<FONT color="green">071</FONT> * the following axis contains all nodes in the same document as the<a name="line.71"></a>
<FONT color="green">072</FONT> * context node that are after the context node in document order, excluding<a name="line.72"></a>
<FONT color="green">073</FONT> * any descendants and excluding attribute nodes and namespace nodes.<a name="line.73"></a>
<FONT color="green">074</FONT> */<a name="line.74"></a>
<FONT color="green">075</FONT> public static final int FOLLOWING = 6;<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> /**<a name="line.77"></a>
<FONT color="green">078</FONT> * The following-sibling axis contains all the following siblings of the<a name="line.78"></a>
<FONT color="green">079</FONT> * context node; if the context node is an attribute node or namespace node,<a name="line.79"></a>
<FONT color="green">080</FONT> * the following-sibling axis is empty.<a name="line.80"></a>
<FONT color="green">081</FONT> */<a name="line.81"></a>
<FONT color="green">082</FONT> public static final int FOLLOWINGSIBLING = 7;<a name="line.82"></a>
<FONT color="green">083</FONT> <a name="line.83"></a>
<FONT color="green">084</FONT> /**<a name="line.84"></a>
<FONT color="green">085</FONT> * The namespace axis contains the namespace nodes of the context node; the<a name="line.85"></a>
<FONT color="green">086</FONT> * axis will be empty unless the context node is an element.<a name="line.86"></a>
<FONT color="green">087</FONT> */<a name="line.87"></a>
<FONT color="green">088</FONT> public static final int NAMESPACEDECLS = 8;<a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> /**<a name="line.90"></a>
<FONT color="green">091</FONT> * The namespace axis contains the namespace nodes of the context node; the<a name="line.91"></a>
<FONT color="green">092</FONT> * axis will be empty unless the context node is an element.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> public static final int NAMESPACE = 9;<a name="line.94"></a>
<FONT color="green">095</FONT> <a name="line.95"></a>
<FONT color="green">096</FONT> /**<a name="line.96"></a>
<FONT color="green">097</FONT> * The parent axis contains the parent of the context node,<a name="line.97"></a>
<FONT color="green">098</FONT> * if there is one.<a name="line.98"></a>
<FONT color="green">099</FONT> */<a name="line.99"></a>
<FONT color="green">100</FONT> public static final int PARENT = 10;<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 preceding axis contains all nodes in the same document as the context<a name="line.103"></a>
<FONT color="green">104</FONT> * node that are before the context node in document order, excluding any<a name="line.104"></a>
<FONT color="green">105</FONT> * ancestors and excluding attribute nodes and namespace nodes<a name="line.105"></a>
<FONT color="green">106</FONT> */<a name="line.106"></a>
<FONT color="green">107</FONT> public static final int PRECEDING = 11;<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> /**<a name="line.109"></a>
<FONT color="green">110</FONT> * The preceding-sibling axis contains all the preceding siblings of the<a name="line.110"></a>
<FONT color="green">111</FONT> * context node; if the context node is an attribute node or namespace node,<a name="line.111"></a>
<FONT color="green">112</FONT> * the preceding-sibling axis is empty.<a name="line.112"></a>
<FONT color="green">113</FONT> */<a name="line.113"></a>
<FONT color="green">114</FONT> public static final int PRECEDINGSIBLING = 12;<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> /** The self axis contains just the context node itself. */<a name="line.116"></a>
<FONT color="green">117</FONT> public static final int SELF = 13;<a name="line.117"></a>
<FONT color="green">118</FONT> <a name="line.118"></a>
<FONT color="green">119</FONT> /**<a name="line.119"></a>
<FONT color="green">120</FONT> * A non-xpath axis, traversing the subtree including the subtree<a name="line.120"></a>
<FONT color="green">121</FONT> * root, descendants, attributes, and namespace node decls.<a name="line.121"></a>
<FONT color="green">122</FONT> */<a name="line.122"></a>
<FONT color="green">123</FONT> public static final int ALLFROMNODE = 14;<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> /**<a name="line.125"></a>
<FONT color="green">126</FONT> * A non-xpath axis, traversing the the preceding and the ancestor nodes, <a name="line.126"></a>
<FONT color="green">127</FONT> * needed for inverseing select patterns to match patterns.<a name="line.127"></a>
<FONT color="green">128</FONT> */<a name="line.128"></a>
<FONT color="green">129</FONT> public static final int PRECEDINGANDANCESTOR = 15;<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> // ===========================================<a name="line.131"></a>
<FONT color="green">132</FONT> // All axis past this are absolute.<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> /**<a name="line.134"></a>
<FONT color="green">135</FONT> * A non-xpath axis, returns all nodes in the tree from and including the <a name="line.135"></a>
<FONT color="green">136</FONT> * root.<a name="line.136"></a>
<FONT color="green">137</FONT> */<a name="line.137"></a>
<FONT color="green">138</FONT> public static final int ALL = 16;<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> /**<a name="line.140"></a>
<FONT color="green">141</FONT> * A non-xpath axis, returns all nodes that aren't namespaces or attributes, <a name="line.141"></a>
<FONT color="green">142</FONT> * from and including the root.<a name="line.142"></a>
<FONT color="green">143</FONT> */<a name="line.143"></a>
<FONT color="green">144</FONT> public static final int DESCENDANTSFROMROOT = 17;<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> /**<a name="line.146"></a>
<FONT color="green">147</FONT> * A non-xpath axis, returns all nodes that aren't namespaces or attributes, <a name="line.147"></a>
<FONT color="green">148</FONT> * from and including the root.<a name="line.148"></a>
<FONT color="green">149</FONT> */<a name="line.149"></a>
<FONT color="green">150</FONT> public static final int DESCENDANTSORSELFFROMROOT = 18;<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> * A non-xpath axis, returns root only.<a name="line.153"></a>
<FONT color="green">154</FONT> */<a name="line.154"></a>
<FONT color="green">155</FONT> public static final int ROOT = 19;<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> * A non-xpath axis, for functions.<a name="line.158"></a>
<FONT color="green">159</FONT> */<a name="line.159"></a>
<FONT color="green">160</FONT> public static final int FILTEREDLIST = 20;<a name="line.160"></a>
<FONT color="green">161</FONT> <a name="line.161"></a>
<FONT color="green">162</FONT> /**<a name="line.162"></a>
<FONT color="green">163</FONT> * A table to identify whether an axis is a reverse axis;<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> private static final boolean[] isReverse = {<a name="line.165"></a>
<FONT color="green">166</FONT> true, // ancestor<a name="line.166"></a>
<FONT color="green">167</FONT> true, // ancestor-or-self<a name="line.167"></a>
<FONT color="green">168</FONT> false, // attribute<a name="line.168"></a>
<FONT color="green">169</FONT> false, // child<a name="line.169"></a>
<FONT color="green">170</FONT> false, // descendant<a name="line.170"></a>
<FONT color="green">171</FONT> false, // descendant-or-self<a name="line.171"></a>
<FONT color="green">172</FONT> false, // following<a name="line.172"></a>
<FONT color="green">173</FONT> false, // following-sibling<a name="line.173"></a>
<FONT color="green">174</FONT> false, // namespace<a name="line.174"></a>
<FONT color="green">175</FONT> false, // namespace-declarations<a name="line.175"></a>
<FONT color="green">176</FONT> false, // parent (one node, has no order)<a name="line.176"></a>
<FONT color="green">177</FONT> true, // preceding<a name="line.177"></a>
<FONT color="green">178</FONT> true, // preceding-sibling<a name="line.178"></a>
<FONT color="green">179</FONT> false // self (one node, has no order)<a name="line.179"></a>
<FONT color="green">180</FONT> };<a name="line.180"></a>
<FONT color="green">181</FONT> <a name="line.181"></a>
<FONT color="green">182</FONT> /** The names of the axes for diagnostic purposes. */<a name="line.182"></a>
<FONT color="green">183</FONT> private static final String[] names =<a name="line.183"></a>
<FONT color="green">184</FONT> {<a name="line.184"></a>
<FONT color="green">185</FONT> "ancestor", // 0<a name="line.185"></a>
<FONT color="green">186</FONT> "ancestor-or-self", // 1<a name="line.186"></a>
<FONT color="green">187</FONT> "attribute", // 2<a name="line.187"></a>
<FONT color="green">188</FONT> "child", // 3<a name="line.188"></a>
<FONT color="green">189</FONT> "descendant", // 4<a name="line.189"></a>
<FONT color="green">190</FONT> "descendant-or-self", // 5<a name="line.190"></a>
<FONT color="green">191</FONT> "following", // 6<a name="line.191"></a>
<FONT color="green">192</FONT> "following-sibling", // 7<a name="line.192"></a>
<FONT color="green">193</FONT> "namespace-decls", // 8<a name="line.193"></a>
<FONT color="green">194</FONT> "namespace", // 9<a name="line.194"></a>
<FONT color="green">195</FONT> "parent", // 10<a name="line.195"></a>
<FONT color="green">196</FONT> "preceding", // 11<a name="line.196"></a>
<FONT color="green">197</FONT> "preceding-sibling", // 12<a name="line.197"></a>
<FONT color="green">198</FONT> "self", // 13<a name="line.198"></a>
<FONT color="green">199</FONT> "all-from-node", // 14<a name="line.199"></a>
<FONT color="green">200</FONT> "preceding-and-ancestor", // 15<a name="line.200"></a>
<FONT color="green">201</FONT> "all", // 16<a name="line.201"></a>
<FONT color="green">202</FONT> "descendants-from-root", // 17<a name="line.202"></a>
<FONT color="green">203</FONT> "descendants-or-self-from-root", // 18<a name="line.203"></a>
<FONT color="green">204</FONT> "root", // 19<a name="line.204"></a>
<FONT color="green">205</FONT> "filtered-list" // 20<a name="line.205"></a>
<FONT color="green">206</FONT> };<a name="line.206"></a>
<FONT color="green">207</FONT> <a name="line.207"></a>
<FONT color="green">208</FONT> public static boolean isReverse(int axis){<a name="line.208"></a>
<FONT color="green">209</FONT> return isReverse[axis];<a name="line.209"></a>
<FONT color="green">210</FONT> }<a name="line.210"></a>
<FONT color="green">211</FONT> <a name="line.211"></a>
<FONT color="green">212</FONT> public static String getNames(int index){<a name="line.212"></a>
<FONT color="green">213</FONT> return names[index]; <a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
<FONT color="green">215</FONT> <a name="line.215"></a>
<FONT color="green">216</FONT> public static int getNamesLength(){<a name="line.216"></a>
<FONT color="green">217</FONT> return names.length;<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> }<a name="line.220"></a>
</PRE>
</BODY>
</HTML>