Class TextTokenizer
The tokenizer knows about four different character classes: regular word characters, whitespace characters, sentence delimiters and separator characters. Tokens can consist of
- sequences of word characters and sentence delimiters where the last character is a word character,
- sentence delimiter characters (if they do not precede a word character),
- sequences of whitespace characters,
- and individual separator characters.
The character classes are completely user definable. By default, whitespace characters are the Unicode whitespace characters. All other characters are word characters. The two separator classes are empty by default. The different classes may have non-empty intersections. When determining the class of a character, the user defined classes are considered in the following order: end-of-sentence delimiter before other separators before whitespace before word characters. That is, if a character is defined to be both a separator and a whitespace character, it will be considered to be a separator.
By default, the tokenizer will return all tokens, including whitespace. That is, appending the sequence of tokens will recover the original input text. This behavior can be changed so that whitespace and/or separator tokens are skipped.
A tokenizer provides a standard iterator interface similar to
StringTokenizer
. The validity of the iterator can be queried
with hasNext()
, and the next token can be queried with nextToken()
.
In addition, getNextTokenType()
returns the type of the token as an integer. NB
that you need to call getNextTokenType()
before calling nextToken()
,
since calling nextToken()
will advance the iterator.
- Version:
- $Id: TextTokenizer.java,v 1.1 2002/09/30 19:09:09 goetz Exp $
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
static final int
Sentence delimiter character/word type.private char[]
private boolean
private int
private int
private int
private int
static final int
Separator character/word type.private char[]
private boolean
private boolean
private final char[]
static final int
Word character/word type.private char[]
private char[]
static final int
Whitespace character/word type. -
Constructor Summary
ConstructorsConstructorDescriptionTextTokenizer
(String string) Construct a tokenizer from a Java string.TextTokenizer
(CharArrayString string) Construct a tokenizer from a CharArrayString. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addSeparators
(String chars) Add to the set of separator characters.void
addToEndOfSentenceChars
(String chars) Add to the set of sentence delimiters.private char[]
addToSortedList
(String s, char[] list) Add the characters ins
to the sorted array of characters inlist
, returning a new, sorted array.void
addWhitespaceChars
(String chars) Add to the set of whitespace characters.void
addWordChars
(String chars) Add to the set of word characters.private boolean
Compute the next token.int
getCharType
(char c) Get the type of an individual character.int
Get the type of the token returned by the next call tonextToken()
.boolean
hasNext()
private char[]
void
setEndOfSentenceChars
(String chars) Set the set of sentence delimiters.void
setSeparators
(String chars) Set the set of separator characters.void
setShowSeparators
(boolean b) Set the flag for showing separator tokens.void
setShowWhitespace
(boolean b) Set the flag for showing whitespace tokens.void
setWhitespaceChars
(String chars) Set the set of whitespace characters (in addition to the Unicode whitespace chars).void
setWordChars
(String chars) Set the set of word characters.
-
Field Details
-
EOS
public static final int EOSSentence delimiter character/word type.- See Also:
-
SEP
public static final int SEPSeparator character/word type.- See Also:
-
WSP
public static final int WSPWhitespace character/word type.- See Also:
-
WCH
public static final int WCHWord character/word type.- See Also:
-
text
private final char[] text -
end
private final int end -
pos
private int pos -
eosDels
private char[] eosDels -
separators
private char[] separators -
whitespace
private char[] whitespace -
wordChars
private char[] wordChars -
nextTokenStart
private int nextTokenStart -
nextTokenEnd
private int nextTokenEnd -
nextTokenType
private int nextTokenType -
nextComputed
private boolean nextComputed -
showWhitespace
private boolean showWhitespace -
showSeparators
private boolean showSeparators
-
-
Constructor Details
-
TextTokenizer
Construct a tokenizer from a CharArrayString.- Parameters:
string
- The string to tokenize.
-
TextTokenizer
Construct a tokenizer from a Java string.- Parameters:
string
- -
-
-
Method Details
-
setShowWhitespace
public void setShowWhitespace(boolean b) Set the flag for showing whitespace tokens.- Parameters:
b
- -
-
setShowSeparators
public void setShowSeparators(boolean b) Set the flag for showing separator tokens.- Parameters:
b
- -
-
setEndOfSentenceChars
Set the set of sentence delimiters.- Parameters:
chars
- -
-
addToEndOfSentenceChars
Add to the set of sentence delimiters.- Parameters:
chars
- -
-
setSeparators
Set the set of separator characters.- Parameters:
chars
- -
-
addSeparators
Add to the set of separator characters.- Parameters:
chars
- -
-
setWhitespaceChars
Set the set of whitespace characters (in addition to the Unicode whitespace chars).- Parameters:
chars
- -
-
addWhitespaceChars
Add to the set of whitespace characters.- Parameters:
chars
- -
-
setWordChars
Set the set of word characters.- Parameters:
chars
- -
-
addWordChars
Add to the set of word characters.- Parameters:
chars
- -
-
getNextTokenType
public int getNextTokenType()Get the type of the token returned by the next call tonextToken()
.- Returns:
- The token type, or
-1
if there is no next token.
-
hasNext
public boolean hasNext()- Returns:
true
iff there is a next token.
-
nextToken
- Returns:
- the next token.
-
computeNextToken
private boolean computeNextToken()Compute the next token. -
getCharType
public int getCharType(char c) Get the type of an individual character.- Parameters:
c
- -- Returns:
- -
-
addToSortedList
Add the characters ins
to the sorted array of characters inlist
, returning a new, sorted array. -
makeSortedList
-