blob: c61f58d4b2f4a4c519358e338b21b8017c94e05b [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: KeyIterator.java 468645 2006-10-28 06:57:24Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xalan.transformer;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Vector;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import javax.xml.transform.TransformerException;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.res.XSLTErrorResources;<a name="line.28"></a>
<FONT color="green">029</FONT> import org.apache.xalan.templates.KeyDeclaration;<a name="line.29"></a>
<FONT color="green">030</FONT> import org.apache.xml.dtm.Axis;<a name="line.30"></a>
<FONT color="green">031</FONT> import org.apache.xml.dtm.DTMIterator;<a name="line.31"></a>
<FONT color="green">032</FONT> import org.apache.xml.utils.QName;<a name="line.32"></a>
<FONT color="green">033</FONT> import org.apache.xpath.XPath;<a name="line.33"></a>
<FONT color="green">034</FONT> import org.apache.xpath.axes.OneStepIteratorForward;<a name="line.34"></a>
<FONT color="green">035</FONT> <a name="line.35"></a>
<FONT color="green">036</FONT> /**<a name="line.36"></a>
<FONT color="green">037</FONT> * This class implements an optimized iterator for <a name="line.37"></a>
<FONT color="green">038</FONT> * "key()" patterns, matching each node to the <a name="line.38"></a>
<FONT color="green">039</FONT> * match attribute in one or more xsl:key declarations.<a name="line.39"></a>
<FONT color="green">040</FONT> * @xsl.usage internal<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> public class KeyIterator extends OneStepIteratorForward<a name="line.42"></a>
<FONT color="green">043</FONT> {<a name="line.43"></a>
<FONT color="green">044</FONT> static final long serialVersionUID = -1349109910100249661L;<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /** Key name.<a name="line.46"></a>
<FONT color="green">047</FONT> * @serial */<a name="line.47"></a>
<FONT color="green">048</FONT> private QName m_name;<a name="line.48"></a>
<FONT color="green">049</FONT> <a name="line.49"></a>
<FONT color="green">050</FONT> /**<a name="line.50"></a>
<FONT color="green">051</FONT> * Get the key name from a key declaration this iterator will process<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> * @return Key name<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> public QName getName()<a name="line.56"></a>
<FONT color="green">057</FONT> {<a name="line.57"></a>
<FONT color="green">058</FONT> return m_name;<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /** Vector of Key declarations in the stylesheet.<a name="line.61"></a>
<FONT color="green">062</FONT> * @serial */<a name="line.62"></a>
<FONT color="green">063</FONT> private Vector m_keyDeclarations;<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> * Get the key declarations from the stylesheet <a name="line.66"></a>
<FONT color="green">067</FONT> *<a name="line.67"></a>
<FONT color="green">068</FONT> *<a name="line.68"></a>
<FONT color="green">069</FONT> * @return Vector containing the key declarations from the stylesheet<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public Vector getKeyDeclarations()<a name="line.71"></a>
<FONT color="green">072</FONT> {<a name="line.72"></a>
<FONT color="green">073</FONT> return m_keyDeclarations;<a name="line.73"></a>
<FONT color="green">074</FONT> }<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> * Create a KeyIterator object.<a name="line.77"></a>
<FONT color="green">078</FONT> *<a name="line.78"></a>
<FONT color="green">079</FONT> * @throws javax.xml.transform.TransformerException<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> KeyIterator(QName name, Vector keyDeclarations)<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> super(Axis.ALL);<a name="line.83"></a>
<FONT color="green">084</FONT> m_keyDeclarations = keyDeclarations;<a name="line.84"></a>
<FONT color="green">085</FONT> // m_prefixResolver = nscontext;<a name="line.85"></a>
<FONT color="green">086</FONT> m_name = name;<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> * Test whether a specified node is visible in the logical view of a<a name="line.90"></a>
<FONT color="green">091</FONT> * TreeWalker or NodeIterator. This function will be called by the<a name="line.91"></a>
<FONT color="green">092</FONT> * implementation of TreeWalker and NodeIterator; it is not intended to<a name="line.92"></a>
<FONT color="green">093</FONT> * be called directly from user code.<a name="line.93"></a>
<FONT color="green">094</FONT> * <a name="line.94"></a>
<FONT color="green">095</FONT> * @param testNode The node to check to see if it passes the filter or not.<a name="line.95"></a>
<FONT color="green">096</FONT> *<a name="line.96"></a>
<FONT color="green">097</FONT> * @return a constant to determine whether the node is accepted,<a name="line.97"></a>
<FONT color="green">098</FONT> * rejected, or skipped, as defined above .<a name="line.98"></a>
<FONT color="green">099</FONT> */<a name="line.99"></a>
<FONT color="green">100</FONT> public short acceptNode(int testNode)<a name="line.100"></a>
<FONT color="green">101</FONT> {<a name="line.101"></a>
<FONT color="green">102</FONT> boolean foundKey = false;<a name="line.102"></a>
<FONT color="green">103</FONT> KeyIterator ki = (KeyIterator) m_lpi;<a name="line.103"></a>
<FONT color="green">104</FONT> org.apache.xpath.XPathContext xctxt = ki.getXPathContext();<a name="line.104"></a>
<FONT color="green">105</FONT> Vector keys = ki.getKeyDeclarations();<a name="line.105"></a>
<FONT color="green">106</FONT> <a name="line.106"></a>
<FONT color="green">107</FONT> QName name = ki.getName();<a name="line.107"></a>
<FONT color="green">108</FONT> try<a name="line.108"></a>
<FONT color="green">109</FONT> {<a name="line.109"></a>
<FONT color="green">110</FONT> // System.out.println("lookupKey: "+lookupKey);<a name="line.110"></a>
<FONT color="green">111</FONT> int nDeclarations = keys.size();<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> // Walk through each of the declarations made with xsl:key<a name="line.113"></a>
<FONT color="green">114</FONT> for (int i = 0; i &lt; nDeclarations; i++)<a name="line.114"></a>
<FONT color="green">115</FONT> {<a name="line.115"></a>
<FONT color="green">116</FONT> KeyDeclaration kd = (KeyDeclaration) keys.elementAt(i);<a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> // Only continue if the name on this key declaration<a name="line.118"></a>
<FONT color="green">119</FONT> // matches the name on the iterator for this walker. <a name="line.119"></a>
<FONT color="green">120</FONT> if (!kd.getName().equals(name))<a name="line.120"></a>
<FONT color="green">121</FONT> continue;<a name="line.121"></a>
<FONT color="green">122</FONT> <a name="line.122"></a>
<FONT color="green">123</FONT> foundKey = true;<a name="line.123"></a>
<FONT color="green">124</FONT> // xctxt.setNamespaceContext(ki.getPrefixResolver());<a name="line.124"></a>
<FONT color="green">125</FONT> <a name="line.125"></a>
<FONT color="green">126</FONT> // See if our node matches the given key declaration according to <a name="line.126"></a>
<FONT color="green">127</FONT> // the match attribute on xsl:key.<a name="line.127"></a>
<FONT color="green">128</FONT> XPath matchExpr = kd.getMatch();<a name="line.128"></a>
<FONT color="green">129</FONT> double score = matchExpr.getMatchScore(xctxt, testNode);<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> if (score == kd.getMatch().MATCH_SCORE_NONE)<a name="line.131"></a>
<FONT color="green">132</FONT> continue;<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> return DTMIterator.FILTER_ACCEPT;<a name="line.134"></a>
<FONT color="green">135</FONT> <a name="line.135"></a>
<FONT color="green">136</FONT> } // end for(int i = 0; i &lt; nDeclarations; i++)<a name="line.136"></a>
<FONT color="green">137</FONT> }<a name="line.137"></a>
<FONT color="green">138</FONT> catch (TransformerException se)<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> // TODO: What to do?<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> if (!foundKey)<a name="line.144"></a>
<FONT color="green">145</FONT> throw new RuntimeException(<a name="line.145"></a>
<FONT color="green">146</FONT> XSLMessages.createMessage(<a name="line.146"></a>
<FONT color="green">147</FONT> XSLTErrorResources.ER_NO_XSLKEY_DECLARATION,<a name="line.147"></a>
<FONT color="green">148</FONT> new Object[] { name.getLocalName()}));<a name="line.148"></a>
<FONT color="green">149</FONT> <a name="line.149"></a>
<FONT color="green">150</FONT> return DTMIterator.FILTER_REJECT;<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 name="line.153"></a>
</PRE>
</BODY>
</HTML>