org.apache.xml.dtm.ref

Class DTMStringPool

Known Direct Subclasses:
CustomStringPool, DTMSafeStringPool

public class DTMStringPool
extends java.lang.Object

DTMStringPool is an "interning" mechanism for strings. It will create a stable 1:1 mapping between a set of string values and a set of integer index values, so the integers can be used to reliably and uniquely identify (and when necessary retrieve) the strings.

Design Priorities:

Implementation detail: A standard Hashtable is relatively inefficient when looking up primitive int values, especially when we're already maintaining an int-to-string vector. So I'm maintaining a simple hash chain within this class.

NOTE: There is nothing in the code that has a real dependency upon String. It would work with any object type that implements reliable .hashCode() and .equals() operations. The API enforces Strings because it's safer that way, but this could trivially be turned into a general ObjectPool if one was needed.

Status: Passed basic test in main().

Field Summary

static int
NULL

Constructor Summary

DTMStringPool()
DTMStringPool(int chainSize)
Create a DTMStringPool using the given chain size

Method Summary

String
indexToString(int i)
static void
main(String[] args)
Command-line unit test driver.
void
removeAllElements()
int
stringToIndex(String s)

Field Details

NULL

public static final int NULL

Field Value:
-1

Constructor Details

DTMStringPool

public DTMStringPool()


DTMStringPool

public DTMStringPool(int chainSize)
Create a DTMStringPool using the given chain size

Parameters:
chainSize - The size of the hash chain vector

Method Details

indexToString

public String indexToString(int i)
            throws java.lang.ArrayIndexOutOfBoundsException

Returns:
string whose value is uniquely identified by this integer index.


main

public static void main(String[] args)
Command-line unit test driver. This test relies on the fact that this version of the pool assigns indices consecutively, starting from zero, as new unique strings are encountered.


removeAllElements

public void removeAllElements()


stringToIndex

public int stringToIndex(String s)

Returns:
integer index uniquely identifying the value of this string.


Copyright B) 2004 Apache XML Project. All Rights Reserved.