blob: 508e31ed610d58371b05fc3a5d69ca5f2f9dafe7 [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: CustomStringPool.java 475904 2006-11-16 20:09:39Z 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.dtm.ref;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Hashtable;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /** &lt;p&gt;CustomStringPool is an example of appliction provided data structure<a name="line.25"></a>
<FONT color="green">026</FONT> * for a DTM implementation to hold symbol references, e.g. elelment names.<a name="line.26"></a>
<FONT color="green">027</FONT> * It will follow the DTMDStringPool interface and use two simple methods<a name="line.27"></a>
<FONT color="green">028</FONT> * indexToString(int i) and stringToIndex(Sring s) to map between a set of<a name="line.28"></a>
<FONT color="green">029</FONT> * string values and a set of integer index values. Therefore, an application<a name="line.29"></a>
<FONT color="green">030</FONT> * may improve DTM processing speed by substituting the DTM symbol resolution<a name="line.30"></a>
<FONT color="green">031</FONT> * tables with application specific quick symbol resolution tables.&lt;/p&gt;<a name="line.31"></a>
<FONT color="green">032</FONT> *<a name="line.32"></a>
<FONT color="green">033</FONT> * %REVIEW% The only difference between this an DTMStringPool seems to be that<a name="line.33"></a>
<FONT color="green">034</FONT> * it uses a java.lang.Hashtable full of Integers rather than implementing its<a name="line.34"></a>
<FONT color="green">035</FONT> * own hashing. Joe deliberately avoided that approach when writing<a name="line.35"></a>
<FONT color="green">036</FONT> * DTMStringPool, since it is both much more memory-hungry and probably slower<a name="line.36"></a>
<FONT color="green">037</FONT> * -- especially in JDK 1.1.x, where Hashtable is synchronized. We need to<a name="line.37"></a>
<FONT color="green">038</FONT> * either justify this implementation or discard it.<a name="line.38"></a>
<FONT color="green">039</FONT> * <a name="line.39"></a>
<FONT color="green">040</FONT> * %REVIEW% Xalan-J has dropped support for 1.1.x and we can now use<a name="line.40"></a>
<FONT color="green">041</FONT> * the colletion classes in 1.2, such as java.util.HashMap which is<a name="line.41"></a>
<FONT color="green">042</FONT> * similar to java.util.Hashtable but not synchronized. For performance reasons<a name="line.42"></a>
<FONT color="green">043</FONT> * one could change m_stringToInt to be a HashMap, but is it OK to do that?<a name="line.43"></a>
<FONT color="green">044</FONT> * Are such CustomStringPool objects already used in a thread-safe way?<a name="line.44"></a>
<FONT color="green">045</FONT> *<a name="line.45"></a>
<FONT color="green">046</FONT> * &lt;p&gt;Status: In progress, under discussion.&lt;/p&gt;<a name="line.46"></a>
<FONT color="green">047</FONT> * */<a name="line.47"></a>
<FONT color="green">048</FONT> public class CustomStringPool extends DTMStringPool {<a name="line.48"></a>
<FONT color="green">049</FONT> //final Vector m_intToString;<a name="line.49"></a>
<FONT color="green">050</FONT> //static final int HASHPRIME=101;<a name="line.50"></a>
<FONT color="green">051</FONT> //int[] m_hashStart=new int[HASHPRIME];<a name="line.51"></a>
<FONT color="green">052</FONT> final Hashtable m_stringToInt = new Hashtable(); // can this be a HashMap instead?<a name="line.52"></a>
<FONT color="green">053</FONT> public static final int NULL=-1;<a name="line.53"></a>
<FONT color="green">054</FONT> <a name="line.54"></a>
<FONT color="green">055</FONT> public CustomStringPool()<a name="line.55"></a>
<FONT color="green">056</FONT> {<a name="line.56"></a>
<FONT color="green">057</FONT> super();<a name="line.57"></a>
<FONT color="green">058</FONT> /*m_intToString=new Vector();<a name="line.58"></a>
<FONT color="green">059</FONT> System.out.println("In constructor m_intToString is " + <a name="line.59"></a>
<FONT color="green">060</FONT> ((null == m_intToString) ? "null" : "not null"));*/<a name="line.60"></a>
<FONT color="green">061</FONT> //m_stringToInt=new Hashtable();<a name="line.61"></a>
<FONT color="green">062</FONT> //removeAllElements();<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> public void removeAllElements()<a name="line.65"></a>
<FONT color="green">066</FONT> {<a name="line.66"></a>
<FONT color="green">067</FONT> m_intToString.removeAllElements();<a name="line.67"></a>
<FONT color="green">068</FONT> if (m_stringToInt != null) <a name="line.68"></a>
<FONT color="green">069</FONT> m_stringToInt.clear();<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> /** @return string whose value is uniquely identified by this integer index.<a name="line.72"></a>
<FONT color="green">073</FONT> * @throws java.lang.ArrayIndexOutOfBoundsException<a name="line.73"></a>
<FONT color="green">074</FONT> * if index doesn't map to a string.<a name="line.74"></a>
<FONT color="green">075</FONT> * */<a name="line.75"></a>
<FONT color="green">076</FONT> public String indexToString(int i)<a name="line.76"></a>
<FONT color="green">077</FONT> throws java.lang.ArrayIndexOutOfBoundsException<a name="line.77"></a>
<FONT color="green">078</FONT> {<a name="line.78"></a>
<FONT color="green">079</FONT> return(String) m_intToString.elementAt(i);<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> /** @return integer index uniquely identifying the value of this string. */<a name="line.82"></a>
<FONT color="green">083</FONT> public int stringToIndex(String s)<a name="line.83"></a>
<FONT color="green">084</FONT> {<a name="line.84"></a>
<FONT color="green">085</FONT> if (s==null) return NULL;<a name="line.85"></a>
<FONT color="green">086</FONT> Integer iobj=(Integer)m_stringToInt.get(s);<a name="line.86"></a>
<FONT color="green">087</FONT> if (iobj==null) {<a name="line.87"></a>
<FONT color="green">088</FONT> m_intToString.addElement(s);<a name="line.88"></a>
<FONT color="green">089</FONT> iobj=new Integer(m_intToString.size());<a name="line.89"></a>
<FONT color="green">090</FONT> m_stringToInt.put(s,iobj);<a name="line.90"></a>
<FONT color="green">091</FONT> }<a name="line.91"></a>
<FONT color="green">092</FONT> return iobj.intValue();<a name="line.92"></a>
<FONT color="green">093</FONT> }<a name="line.93"></a>
<FONT color="green">094</FONT> }<a name="line.94"></a>
</PRE>
</BODY>
</HTML>