Package com.ctc.wstx.util
Class WordResolver
- java.lang.Object
-
- com.ctc.wstx.util.WordResolver
-
public final class WordResolver extends Object
A specialized Map/Symbol table - like data structure that can be used for both checking whether a word (passed in as a char array) exists in certain set of words AND getting that word as a String. It is reasonably efficient both time and speed-wise, at least for certain use cases; specifically, if there is no existing key to use, it is more efficient way to get to a shared copy of that String The general usage pattern is expected to be such that most checks are positive, ie. that the word indeed is contained in the structure.Although this is an efficient data struct for specific set of usage patterns, one restriction is that the full set of words to include has to be known before constructing the instnace. Also, the size of the set is limited to total word content of about 20k characters.
TODO: Should document the internal data structure...
-
-
Field Summary
Fields Modifier and Type Field Description static int
MAX_WORDS
Maximum number of words (Strings) an instance can contain
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WordResolver
constructInstance(TreeSet<String> wordSet)
Tries to construct an instance given ordered set of words.String
find(char[] str, int start, int end)
String
find(String str)
int
size()
String
toString()
-
-
-
Field Detail
-
MAX_WORDS
public static final int MAX_WORDS
Maximum number of words (Strings) an instance can contain- See Also:
- Constant Field Values
-
-
Method Detail
-
constructInstance
public static WordResolver constructInstance(TreeSet<String> wordSet)
Tries to construct an instance given ordered set of words.Note: currently maximum number of words that can be contained is limited to
MAX_WORDS
; additionally, maximum length of all such words can not exceed roughly 28000 characters.- Returns:
- WordResolver constructed for given set of words, if the word set size is not too big; null to indicate "too big" instance.
-
size
public int size()
- Returns:
- Number of words contained
-
find
public String find(char[] str, int start, int end)
- Parameters:
str
- Character array that contains the word to findstart
- Index of the first character of the wordend
- Index following the last character of the word, so thatend - start
equals word length (similar to the wayString.substring()
has).- Returns:
- (Shared) string instance of the word, if it exists in the word set; null if not.
-
find
public String find(String str)
- Returns:
- (Shared) string instance of the word, if it exists in the word set; null if not.
-
-