blob: 392f7f4d4c1d5bfb2bb565956a9495c8bc73ed19 [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: AttributesImplSerializer.java 468654 2006-10-28 07:09:23Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xml.serializer;<a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Hashtable;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> import org.xml.sax.Attributes;<a name="line.26"></a>
<FONT color="green">027</FONT> import org.xml.sax.helpers.AttributesImpl;<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> * This class extends org.xml.sax.helpers.AttributesImpl which implements org.<a name="line.30"></a>
<FONT color="green">031</FONT> * xml.sax.Attributes. But for optimization this class adds a Hashtable for<a name="line.31"></a>
<FONT color="green">032</FONT> * faster lookup of an index by qName, which is commonly done in the stream<a name="line.32"></a>
<FONT color="green">033</FONT> * serializer.<a name="line.33"></a>
<FONT color="green">034</FONT> * <a name="line.34"></a>
<FONT color="green">035</FONT> * @see org.xml.sax.Attributes<a name="line.35"></a>
<FONT color="green">036</FONT> * <a name="line.36"></a>
<FONT color="green">037</FONT> * @xsl.usage internal<a name="line.37"></a>
<FONT color="green">038</FONT> */<a name="line.38"></a>
<FONT color="green">039</FONT> public final class AttributesImplSerializer extends AttributesImpl<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> * Hash table of qName/index values to quickly lookup the index<a name="line.42"></a>
<FONT color="green">043</FONT> * of an attributes qName. qNames are in uppercase in the hash table<a name="line.43"></a>
<FONT color="green">044</FONT> * to make the search case insensitive.<a name="line.44"></a>
<FONT color="green">045</FONT> * <a name="line.45"></a>
<FONT color="green">046</FONT> * The keys to the hashtable to find the index are either<a name="line.46"></a>
<FONT color="green">047</FONT> * "prefix:localName" or "{uri}localName".<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> private final Hashtable m_indexFromQName = new Hashtable();<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> private final StringBuffer m_buff = new StringBuffer();<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> * This is the number of attributes before switching to the hash table,<a name="line.54"></a>
<FONT color="green">055</FONT> * and can be tuned, but 12 seems good for now - Brian M.<a name="line.55"></a>
<FONT color="green">056</FONT> */<a name="line.56"></a>
<FONT color="green">057</FONT> private static final int MAX = 12;<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> * One less than the number of attributes before switching to<a name="line.60"></a>
<FONT color="green">061</FONT> * the Hashtable.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> private static final int MAXMinus1 = MAX - 1;<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> * This method gets the index of an attribute given its qName.<a name="line.66"></a>
<FONT color="green">067</FONT> * @param qname the qualified name of the attribute, e.g. "prefix1:locName1"<a name="line.67"></a>
<FONT color="green">068</FONT> * @return the integer index of the attribute.<a name="line.68"></a>
<FONT color="green">069</FONT> * @see org.xml.sax.Attributes#getIndex(String)<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> public final int getIndex(String qname)<a name="line.71"></a>
<FONT color="green">072</FONT> {<a name="line.72"></a>
<FONT color="green">073</FONT> int index;<a name="line.73"></a>
<FONT color="green">074</FONT> <a name="line.74"></a>
<FONT color="green">075</FONT> if (super.getLength() &lt; MAX)<a name="line.75"></a>
<FONT color="green">076</FONT> {<a name="line.76"></a>
<FONT color="green">077</FONT> // if we haven't got too many attributes let the<a name="line.77"></a>
<FONT color="green">078</FONT> // super class look it up<a name="line.78"></a>
<FONT color="green">079</FONT> index = super.getIndex(qname);<a name="line.79"></a>
<FONT color="green">080</FONT> return index;<a name="line.80"></a>
<FONT color="green">081</FONT> }<a name="line.81"></a>
<FONT color="green">082</FONT> // we have too many attributes and the super class is slow<a name="line.82"></a>
<FONT color="green">083</FONT> // so find it quickly using our Hashtable.<a name="line.83"></a>
<FONT color="green">084</FONT> Integer i = (Integer)m_indexFromQName.get(qname);<a name="line.84"></a>
<FONT color="green">085</FONT> if (i == null)<a name="line.85"></a>
<FONT color="green">086</FONT> index = -1;<a name="line.86"></a>
<FONT color="green">087</FONT> else<a name="line.87"></a>
<FONT color="green">088</FONT> index = i.intValue();<a name="line.88"></a>
<FONT color="green">089</FONT> return index;<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> * This method adds the attribute, but also records its qName/index pair in<a name="line.92"></a>
<FONT color="green">093</FONT> * the hashtable for fast lookup by getIndex(qName).<a name="line.93"></a>
<FONT color="green">094</FONT> * @param uri the URI of the attribute<a name="line.94"></a>
<FONT color="green">095</FONT> * @param local the local name of the attribute<a name="line.95"></a>
<FONT color="green">096</FONT> * @param qname the qualified name of the attribute<a name="line.96"></a>
<FONT color="green">097</FONT> * @param type the type of the attribute<a name="line.97"></a>
<FONT color="green">098</FONT> * @param val the value of the attribute<a name="line.98"></a>
<FONT color="green">099</FONT> *<a name="line.99"></a>
<FONT color="green">100</FONT> * @see org.xml.sax.helpers.AttributesImpl#addAttribute(String, String, String, String, String)<a name="line.100"></a>
<FONT color="green">101</FONT> * @see #getIndex(String)<a name="line.101"></a>
<FONT color="green">102</FONT> */<a name="line.102"></a>
<FONT color="green">103</FONT> public final void addAttribute(<a name="line.103"></a>
<FONT color="green">104</FONT> String uri,<a name="line.104"></a>
<FONT color="green">105</FONT> String local,<a name="line.105"></a>
<FONT color="green">106</FONT> String qname,<a name="line.106"></a>
<FONT color="green">107</FONT> String type,<a name="line.107"></a>
<FONT color="green">108</FONT> String val)<a name="line.108"></a>
<FONT color="green">109</FONT> {<a name="line.109"></a>
<FONT color="green">110</FONT> int index = super.getLength();<a name="line.110"></a>
<FONT color="green">111</FONT> super.addAttribute(uri, local, qname, type, val);<a name="line.111"></a>
<FONT color="green">112</FONT> // (index + 1) is now the number of attributes<a name="line.112"></a>
<FONT color="green">113</FONT> // so either compare (index+1) to MAX, or compare index to (MAX-1)<a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> if (index &lt; MAXMinus1)<a name="line.115"></a>
<FONT color="green">116</FONT> {<a name="line.116"></a>
<FONT color="green">117</FONT> return;<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> else if (index == MAXMinus1)<a name="line.119"></a>
<FONT color="green">120</FONT> {<a name="line.120"></a>
<FONT color="green">121</FONT> switchOverToHash(MAX);<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> else<a name="line.123"></a>
<FONT color="green">124</FONT> {<a name="line.124"></a>
<FONT color="green">125</FONT> /* add the key with the format of "prefix:localName" */<a name="line.125"></a>
<FONT color="green">126</FONT> /* we have just added the attibute, its index is the old length */<a name="line.126"></a>
<FONT color="green">127</FONT> Integer i = new Integer(index);<a name="line.127"></a>
<FONT color="green">128</FONT> m_indexFromQName.put(qname, i);<a name="line.128"></a>
<FONT color="green">129</FONT> <a name="line.129"></a>
<FONT color="green">130</FONT> /* now add with key of the format "{uri}localName" */<a name="line.130"></a>
<FONT color="green">131</FONT> m_buff.setLength(0);<a name="line.131"></a>
<FONT color="green">132</FONT> m_buff.append('{').append(uri).append('}').append(local);<a name="line.132"></a>
<FONT color="green">133</FONT> String key = m_buff.toString();<a name="line.133"></a>
<FONT color="green">134</FONT> m_indexFromQName.put(key, i);<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> return;<a name="line.136"></a>
<FONT color="green">137</FONT> }<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> * We are switching over to having a hash table for quick look<a name="line.140"></a>
<FONT color="green">141</FONT> * up of attributes, but up until now we haven't kept any<a name="line.141"></a>
<FONT color="green">142</FONT> * information in the Hashtable, so we now update the Hashtable.<a name="line.142"></a>
<FONT color="green">143</FONT> * Future additional attributes will update the Hashtable as<a name="line.143"></a>
<FONT color="green">144</FONT> * they are added.<a name="line.144"></a>
<FONT color="green">145</FONT> * @param numAtts<a name="line.145"></a>
<FONT color="green">146</FONT> */<a name="line.146"></a>
<FONT color="green">147</FONT> private void switchOverToHash(int numAtts)<a name="line.147"></a>
<FONT color="green">148</FONT> {<a name="line.148"></a>
<FONT color="green">149</FONT> for (int index = 0; index &lt; numAtts; index++)<a name="line.149"></a>
<FONT color="green">150</FONT> {<a name="line.150"></a>
<FONT color="green">151</FONT> String qName = super.getQName(index);<a name="line.151"></a>
<FONT color="green">152</FONT> Integer i = new Integer(index);<a name="line.152"></a>
<FONT color="green">153</FONT> m_indexFromQName.put(qName, i);<a name="line.153"></a>
<FONT color="green">154</FONT> <a name="line.154"></a>
<FONT color="green">155</FONT> // Add quick look-up to find with uri/local name pair<a name="line.155"></a>
<FONT color="green">156</FONT> String uri = super.getURI(index);<a name="line.156"></a>
<FONT color="green">157</FONT> String local = super.getLocalName(index);<a name="line.157"></a>
<FONT color="green">158</FONT> m_buff.setLength(0);<a name="line.158"></a>
<FONT color="green">159</FONT> m_buff.append('{').append(uri).append('}').append(local);<a name="line.159"></a>
<FONT color="green">160</FONT> String key = m_buff.toString();<a name="line.160"></a>
<FONT color="green">161</FONT> m_indexFromQName.put(key, i);<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> /**<a name="line.165"></a>
<FONT color="green">166</FONT> * This method clears the accumulated attributes.<a name="line.166"></a>
<FONT color="green">167</FONT> *<a name="line.167"></a>
<FONT color="green">168</FONT> * @see org.xml.sax.helpers.AttributesImpl#clear()<a name="line.168"></a>
<FONT color="green">169</FONT> */<a name="line.169"></a>
<FONT color="green">170</FONT> public final void clear()<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> int len = super.getLength();<a name="line.173"></a>
<FONT color="green">174</FONT> super.clear();<a name="line.174"></a>
<FONT color="green">175</FONT> if (MAX &lt;= len)<a name="line.175"></a>
<FONT color="green">176</FONT> {<a name="line.176"></a>
<FONT color="green">177</FONT> // if we have had enough attributes and are<a name="line.177"></a>
<FONT color="green">178</FONT> // using the Hashtable, then clear the Hashtable too.<a name="line.178"></a>
<FONT color="green">179</FONT> m_indexFromQName.clear();<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> }<a name="line.182"></a>
<FONT color="green">183</FONT> <a name="line.183"></a>
<FONT color="green">184</FONT> /**<a name="line.184"></a>
<FONT color="green">185</FONT> * This method sets the attributes, previous attributes are cleared,<a name="line.185"></a>
<FONT color="green">186</FONT> * it also keeps the hashtable up to date for quick lookup via<a name="line.186"></a>
<FONT color="green">187</FONT> * getIndex(qName).<a name="line.187"></a>
<FONT color="green">188</FONT> * @param atts the attributes to copy into these attributes.<a name="line.188"></a>
<FONT color="green">189</FONT> * @see org.xml.sax.helpers.AttributesImpl#setAttributes(Attributes)<a name="line.189"></a>
<FONT color="green">190</FONT> * @see #getIndex(String)<a name="line.190"></a>
<FONT color="green">191</FONT> */<a name="line.191"></a>
<FONT color="green">192</FONT> public final void setAttributes(Attributes atts)<a name="line.192"></a>
<FONT color="green">193</FONT> {<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> super.setAttributes(atts);<a name="line.195"></a>
<FONT color="green">196</FONT> <a name="line.196"></a>
<FONT color="green">197</FONT> // we've let the super class add the attributes, but<a name="line.197"></a>
<FONT color="green">198</FONT> // we need to keep the hash table up to date ourselves for the<a name="line.198"></a>
<FONT color="green">199</FONT> // potentially new qName/index pairs for quick lookup. <a name="line.199"></a>
<FONT color="green">200</FONT> int numAtts = atts.getLength();<a name="line.200"></a>
<FONT color="green">201</FONT> if (MAX &lt;= numAtts)<a name="line.201"></a>
<FONT color="green">202</FONT> switchOverToHash(numAtts);<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> }<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> /**<a name="line.206"></a>
<FONT color="green">207</FONT> * This method gets the index of an attribute given its uri and locanName.<a name="line.207"></a>
<FONT color="green">208</FONT> * @param uri the URI of the attribute name.<a name="line.208"></a>
<FONT color="green">209</FONT> * @param localName the local namer (after the ':' ) of the attribute name.<a name="line.209"></a>
<FONT color="green">210</FONT> * @return the integer index of the attribute.<a name="line.210"></a>
<FONT color="green">211</FONT> * @see org.xml.sax.Attributes#getIndex(String)<a name="line.211"></a>
<FONT color="green">212</FONT> */<a name="line.212"></a>
<FONT color="green">213</FONT> public final int getIndex(String uri, String localName)<a name="line.213"></a>
<FONT color="green">214</FONT> {<a name="line.214"></a>
<FONT color="green">215</FONT> int index;<a name="line.215"></a>
<FONT color="green">216</FONT> <a name="line.216"></a>
<FONT color="green">217</FONT> if (super.getLength() &lt; MAX)<a name="line.217"></a>
<FONT color="green">218</FONT> {<a name="line.218"></a>
<FONT color="green">219</FONT> // if we haven't got too many attributes let the<a name="line.219"></a>
<FONT color="green">220</FONT> // super class look it up<a name="line.220"></a>
<FONT color="green">221</FONT> index = super.getIndex(uri,localName);<a name="line.221"></a>
<FONT color="green">222</FONT> return index;<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> // we have too many attributes and the super class is slow<a name="line.224"></a>
<FONT color="green">225</FONT> // so find it quickly using our Hashtable.<a name="line.225"></a>
<FONT color="green">226</FONT> // Form the key of format "{uri}localName"<a name="line.226"></a>
<FONT color="green">227</FONT> m_buff.setLength(0);<a name="line.227"></a>
<FONT color="green">228</FONT> m_buff.append('{').append(uri).append('}').append(localName);<a name="line.228"></a>
<FONT color="green">229</FONT> String key = m_buff.toString();<a name="line.229"></a>
<FONT color="green">230</FONT> Integer i = (Integer)m_indexFromQName.get(key);<a name="line.230"></a>
<FONT color="green">231</FONT> if (i == null)<a name="line.231"></a>
<FONT color="green">232</FONT> index = -1;<a name="line.232"></a>
<FONT color="green">233</FONT> else<a name="line.233"></a>
<FONT color="green">234</FONT> index = i.intValue();<a name="line.234"></a>
<FONT color="green">235</FONT> return index;<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> }<a name="line.237"></a>
</PRE>
</BODY>
</HTML>