| <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: XPathVisitor.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xpath;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import org.apache.xpath.axes.LocPathIterator;<a name="line.23"></a> |
| <FONT color="green">024</FONT> import org.apache.xpath.axes.UnionPathIterator;<a name="line.24"></a> |
| <FONT color="green">025</FONT> import org.apache.xpath.functions.Function;<a name="line.25"></a> |
| <FONT color="green">026</FONT> import org.apache.xpath.objects.XNumber;<a name="line.26"></a> |
| <FONT color="green">027</FONT> import org.apache.xpath.objects.XString;<a name="line.27"></a> |
| <FONT color="green">028</FONT> import org.apache.xpath.operations.Operation;<a name="line.28"></a> |
| <FONT color="green">029</FONT> import org.apache.xpath.operations.UnaryOperation;<a name="line.29"></a> |
| <FONT color="green">030</FONT> import org.apache.xpath.operations.Variable;<a name="line.30"></a> |
| <FONT color="green">031</FONT> import org.apache.xpath.patterns.NodeTest;<a name="line.31"></a> |
| <FONT color="green">032</FONT> import org.apache.xpath.patterns.StepPattern;<a name="line.32"></a> |
| <FONT color="green">033</FONT> import org.apache.xpath.patterns.UnionPattern;<a name="line.33"></a> |
| <FONT color="green">034</FONT> <a name="line.34"></a> |
| <FONT color="green">035</FONT> /**<a name="line.35"></a> |
| <FONT color="green">036</FONT> * A derivation from this class can be passed to a class that implements <a name="line.36"></a> |
| <FONT color="green">037</FONT> * the XPathVisitable interface, to have the appropriate method called <a name="line.37"></a> |
| <FONT color="green">038</FONT> * for each component of the XPath. Aside from possible other uses, the <a name="line.38"></a> |
| <FONT color="green">039</FONT> * main intention is to provide a reasonable means to perform expression <a name="line.39"></a> |
| <FONT color="green">040</FONT> * rewriting.<a name="line.40"></a> |
| <FONT color="green">041</FONT> * <a name="line.41"></a> |
| <FONT color="green">042</FONT> * <p>Each method has the form <a name="line.42"></a> |
| <FONT color="green">043</FONT> * <code>boolean visitComponentType(ExpressionOwner owner, ComponentType compType)</code>. <a name="line.43"></a> |
| <FONT color="green">044</FONT> * The ExpressionOwner argument is the owner of the component, and can <a name="line.44"></a> |
| <FONT color="green">045</FONT> * be used to reset the expression for rewriting. If a method returns <a name="line.45"></a> |
| <FONT color="green">046</FONT> * false, the sub hierarchy will not be traversed.</p><a name="line.46"></a> |
| <FONT color="green">047</FONT> * <a name="line.47"></a> |
| <FONT color="green">048</FONT> * <p>This class is meant to be a base class that will be derived by concrete classes, <a name="line.48"></a> |
| <FONT color="green">049</FONT> * and doesn't much except return true for each method.</p><a name="line.49"></a> |
| <FONT color="green">050</FONT> */<a name="line.50"></a> |
| <FONT color="green">051</FONT> public class XPathVisitor<a name="line.51"></a> |
| <FONT color="green">052</FONT> {<a name="line.52"></a> |
| <FONT color="green">053</FONT> /**<a name="line.53"></a> |
| <FONT color="green">054</FONT> * Visit a LocationPath.<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.55"></a> |
| <FONT color="green">056</FONT> * be reset if rewriting takes place.<a name="line.56"></a> |
| <FONT color="green">057</FONT> * @param path The LocationPath object.<a name="line.57"></a> |
| <FONT color="green">058</FONT> * @return true if the sub expressions should be traversed.<a name="line.58"></a> |
| <FONT color="green">059</FONT> */<a name="line.59"></a> |
| <FONT color="green">060</FONT> public boolean visitLocationPath(ExpressionOwner owner, LocPathIterator path)<a name="line.60"></a> |
| <FONT color="green">061</FONT> {<a name="line.61"></a> |
| <FONT color="green">062</FONT> return true;<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> /**<a name="line.65"></a> |
| <FONT color="green">066</FONT> * Visit a UnionPath.<a name="line.66"></a> |
| <FONT color="green">067</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.67"></a> |
| <FONT color="green">068</FONT> * be reset if rewriting takes place.<a name="line.68"></a> |
| <FONT color="green">069</FONT> * @param path The UnionPath object.<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @return true if the sub expressions should be traversed.<a name="line.70"></a> |
| <FONT color="green">071</FONT> */<a name="line.71"></a> |
| <FONT color="green">072</FONT> public boolean visitUnionPath(ExpressionOwner owner, UnionPathIterator path)<a name="line.72"></a> |
| <FONT color="green">073</FONT> {<a name="line.73"></a> |
| <FONT color="green">074</FONT> return true;<a name="line.74"></a> |
| <FONT color="green">075</FONT> }<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> * Visit a step within a location path.<a name="line.78"></a> |
| <FONT color="green">079</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.79"></a> |
| <FONT color="green">080</FONT> * be reset if rewriting takes place.<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @param step The Step object.<a name="line.81"></a> |
| <FONT color="green">082</FONT> * @return true if the sub expressions should be traversed.<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> public boolean visitStep(ExpressionOwner owner, NodeTest step)<a name="line.84"></a> |
| <FONT color="green">085</FONT> {<a name="line.85"></a> |
| <FONT color="green">086</FONT> return true;<a name="line.86"></a> |
| <FONT color="green">087</FONT> }<a name="line.87"></a> |
| <FONT color="green">088</FONT> <a name="line.88"></a> |
| <FONT color="green">089</FONT> /**<a name="line.89"></a> |
| <FONT color="green">090</FONT> * Visit a predicate within a location path. Note that there isn't a <a name="line.90"></a> |
| <FONT color="green">091</FONT> * proper unique component for predicates, and that the expression will <a name="line.91"></a> |
| <FONT color="green">092</FONT> * be called also for whatever type Expression is.<a name="line.92"></a> |
| <FONT color="green">093</FONT> * <a name="line.93"></a> |
| <FONT color="green">094</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.94"></a> |
| <FONT color="green">095</FONT> * be reset if rewriting takes place.<a name="line.95"></a> |
| <FONT color="green">096</FONT> * @param pred The predicate object.<a name="line.96"></a> |
| <FONT color="green">097</FONT> * @return true if the sub expressions should be traversed.<a name="line.97"></a> |
| <FONT color="green">098</FONT> */<a name="line.98"></a> |
| <FONT color="green">099</FONT> public boolean visitPredicate(ExpressionOwner owner, Expression pred)<a name="line.99"></a> |
| <FONT color="green">100</FONT> {<a name="line.100"></a> |
| <FONT color="green">101</FONT> return true;<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> /**<a name="line.104"></a> |
| <FONT color="green">105</FONT> * Visit a binary operation.<a name="line.105"></a> |
| <FONT color="green">106</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.106"></a> |
| <FONT color="green">107</FONT> * be reset if rewriting takes place.<a name="line.107"></a> |
| <FONT color="green">108</FONT> * @param op The operation object.<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @return true if the sub expressions should be traversed.<a name="line.109"></a> |
| <FONT color="green">110</FONT> */<a name="line.110"></a> |
| <FONT color="green">111</FONT> public boolean visitBinaryOperation(ExpressionOwner owner, Operation op)<a name="line.111"></a> |
| <FONT color="green">112</FONT> {<a name="line.112"></a> |
| <FONT color="green">113</FONT> return true;<a name="line.113"></a> |
| <FONT color="green">114</FONT> }<a name="line.114"></a> |
| <FONT color="green">115</FONT> <a name="line.115"></a> |
| <FONT color="green">116</FONT> /**<a name="line.116"></a> |
| <FONT color="green">117</FONT> * Visit a unary operation.<a name="line.117"></a> |
| <FONT color="green">118</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.118"></a> |
| <FONT color="green">119</FONT> * be reset if rewriting takes place.<a name="line.119"></a> |
| <FONT color="green">120</FONT> * @param op The operation object.<a name="line.120"></a> |
| <FONT color="green">121</FONT> * @return true if the sub expressions should be traversed.<a name="line.121"></a> |
| <FONT color="green">122</FONT> */<a name="line.122"></a> |
| <FONT color="green">123</FONT> public boolean visitUnaryOperation(ExpressionOwner owner, UnaryOperation op)<a name="line.123"></a> |
| <FONT color="green">124</FONT> {<a name="line.124"></a> |
| <FONT color="green">125</FONT> return true;<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> /**<a name="line.128"></a> |
| <FONT color="green">129</FONT> * Visit a variable reference.<a name="line.129"></a> |
| <FONT color="green">130</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.130"></a> |
| <FONT color="green">131</FONT> * be reset if rewriting takes place.<a name="line.131"></a> |
| <FONT color="green">132</FONT> * @param var The variable reference object.<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @return true if the sub expressions should be traversed.<a name="line.133"></a> |
| <FONT color="green">134</FONT> */<a name="line.134"></a> |
| <FONT color="green">135</FONT> public boolean visitVariableRef(ExpressionOwner owner, Variable var)<a name="line.135"></a> |
| <FONT color="green">136</FONT> {<a name="line.136"></a> |
| <FONT color="green">137</FONT> return true;<a name="line.137"></a> |
| <FONT color="green">138</FONT> }<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> * Visit a function.<a name="line.141"></a> |
| <FONT color="green">142</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.142"></a> |
| <FONT color="green">143</FONT> * be reset if rewriting takes place.<a name="line.143"></a> |
| <FONT color="green">144</FONT> * @param func The function reference object.<a name="line.144"></a> |
| <FONT color="green">145</FONT> * @return true if the sub expressions should be traversed.<a name="line.145"></a> |
| <FONT color="green">146</FONT> */<a name="line.146"></a> |
| <FONT color="green">147</FONT> public boolean visitFunction(ExpressionOwner owner, Function func)<a name="line.147"></a> |
| <FONT color="green">148</FONT> {<a name="line.148"></a> |
| <FONT color="green">149</FONT> return true;<a name="line.149"></a> |
| <FONT color="green">150</FONT> }<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> * Visit a match pattern.<a name="line.153"></a> |
| <FONT color="green">154</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.154"></a> |
| <FONT color="green">155</FONT> * be reset if rewriting takes place.<a name="line.155"></a> |
| <FONT color="green">156</FONT> * @param pattern The match pattern object.<a name="line.156"></a> |
| <FONT color="green">157</FONT> * @return true if the sub expressions should be traversed.<a name="line.157"></a> |
| <FONT color="green">158</FONT> */<a name="line.158"></a> |
| <FONT color="green">159</FONT> public boolean visitMatchPattern(ExpressionOwner owner, StepPattern pattern)<a name="line.159"></a> |
| <FONT color="green">160</FONT> {<a name="line.160"></a> |
| <FONT color="green">161</FONT> return true;<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> /**<a name="line.164"></a> |
| <FONT color="green">165</FONT> * Visit a union pattern.<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.166"></a> |
| <FONT color="green">167</FONT> * be reset if rewriting takes place.<a name="line.167"></a> |
| <FONT color="green">168</FONT> * @param pattern The union pattern object.<a name="line.168"></a> |
| <FONT color="green">169</FONT> * @return true if the sub expressions should be traversed.<a name="line.169"></a> |
| <FONT color="green">170</FONT> */<a name="line.170"></a> |
| <FONT color="green">171</FONT> public boolean visitUnionPattern(ExpressionOwner owner, UnionPattern pattern)<a name="line.171"></a> |
| <FONT color="green">172</FONT> {<a name="line.172"></a> |
| <FONT color="green">173</FONT> return true;<a name="line.173"></a> |
| <FONT color="green">174</FONT> }<a name="line.174"></a> |
| <FONT color="green">175</FONT> <a name="line.175"></a> |
| <FONT color="green">176</FONT> /**<a name="line.176"></a> |
| <FONT color="green">177</FONT> * Visit a string literal.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.178"></a> |
| <FONT color="green">179</FONT> * be reset if rewriting takes place.<a name="line.179"></a> |
| <FONT color="green">180</FONT> * @param str The string literal object.<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @return true if the sub expressions should be traversed.<a name="line.181"></a> |
| <FONT color="green">182</FONT> */<a name="line.182"></a> |
| <FONT color="green">183</FONT> public boolean visitStringLiteral(ExpressionOwner owner, XString str)<a name="line.183"></a> |
| <FONT color="green">184</FONT> {<a name="line.184"></a> |
| <FONT color="green">185</FONT> return true;<a name="line.185"></a> |
| <FONT color="green">186</FONT> }<a name="line.186"></a> |
| <FONT color="green">187</FONT> <a name="line.187"></a> |
| <FONT color="green">188</FONT> <a name="line.188"></a> |
| <FONT color="green">189</FONT> /**<a name="line.189"></a> |
| <FONT color="green">190</FONT> * Visit a number literal.<a name="line.190"></a> |
| <FONT color="green">191</FONT> * @param owner The owner of the expression, to which the expression can <a name="line.191"></a> |
| <FONT color="green">192</FONT> * be reset if rewriting takes place.<a name="line.192"></a> |
| <FONT color="green">193</FONT> * @param num The number literal object.<a name="line.193"></a> |
| <FONT color="green">194</FONT> * @return true if the sub expressions should be traversed.<a name="line.194"></a> |
| <FONT color="green">195</FONT> */<a name="line.195"></a> |
| <FONT color="green">196</FONT> public boolean visitNumberLiteral(ExpressionOwner owner, XNumber num)<a name="line.196"></a> |
| <FONT color="green">197</FONT> {<a name="line.197"></a> |
| <FONT color="green">198</FONT> return true;<a name="line.198"></a> |
| <FONT color="green">199</FONT> }<a name="line.199"></a> |
| <FONT color="green">200</FONT> <a name="line.200"></a> |
| <FONT color="green">201</FONT> <a name="line.201"></a> |
| <FONT color="green">202</FONT> }<a name="line.202"></a> |
| <FONT color="green">203</FONT> <a name="line.203"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
