Package com.swabunga.spell.event
Class DocumentWordTokenizer
- java.lang.Object
-
- com.swabunga.spell.event.DocumentWordTokenizer
-
- All Implemented Interfaces:
WordTokenizer
public class DocumentWordTokenizer extends java.lang.Object implements WordTokenizer
This class tokenizes a swing document model. It also allows for the document model to be changed when corrections occur.- Author:
- Jason Height (jheight@chariot.net.au)
-
-
Constructor Summary
Constructors Constructor Description DocumentWordTokenizer(javax.swing.text.Document document)
Creates a new DocumentWordTokenizer to work on a document
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getContext()
Returns the current text that is being tokenized (includes any changes that have been made)int
getCurrentWordCount()
Returns the number of word tokens that have been processed thus farint
getCurrentWordEnd()
Returns an index representing the end location of the current word in the text.int
getCurrentWordPosition()
Returns the number of word tokens that have been processed thus farboolean
hasMoreWords()
Indicates if there are more words leftboolean
isNewSentence()
Indicates if the current word is at the start of a sentencejava.lang.String
nextWord()
This returns the next word in the iteration.void
posStartFullWordFrom(int pos)
Sets the current word position at the start of the word containing the char at position pos.void
replaceWord(java.lang.String newWord)
Replaces the current word token
-
-
-
Method Detail
-
hasMoreWords
public boolean hasMoreWords()
Indicates if there are more words left- Specified by:
hasMoreWords
in interfaceWordTokenizer
- Returns:
- true if more words can be found in the text.
-
posStartFullWordFrom
public void posStartFullWordFrom(int pos)
Sets the current word position at the start of the word containing the char at position pos. This way a call to nextWord() will return this word.- Parameters:
pos
- position in the word we want to set as current.
-
getCurrentWordPosition
public int getCurrentWordPosition()
Returns the number of word tokens that have been processed thus far- Specified by:
getCurrentWordPosition
in interfaceWordTokenizer
- Returns:
- the number of words found so far.
-
getCurrentWordEnd
public int getCurrentWordEnd()
Returns an index representing the end location of the current word in the text.- Specified by:
getCurrentWordEnd
in interfaceWordTokenizer
- Returns:
- index of the end of the current word in the text.
-
nextWord
public java.lang.String nextWord()
This returns the next word in the iteration. Note that any implementation should return the current word, and then replace the current word with the next word found in the input text (if one exists).- Specified by:
nextWord
in interfaceWordTokenizer
- Returns:
- the next word in the iteration.
-
getCurrentWordCount
public int getCurrentWordCount()
Returns the number of word tokens that have been processed thus far- Specified by:
getCurrentWordCount
in interfaceWordTokenizer
- Returns:
- the number of words found so far.
-
replaceWord
public void replaceWord(java.lang.String newWord)
Replaces the current word token- Specified by:
replaceWord
in interfaceWordTokenizer
- Parameters:
newWord
- The new word to replace the misspelt one
-
getContext
public java.lang.String getContext()
Returns the current text that is being tokenized (includes any changes that have been made)- Specified by:
getContext
in interfaceWordTokenizer
- Returns:
- The text, including changes.
-
isNewSentence
public boolean isNewSentence()
Indicates if the current word is at the start of a sentence- Specified by:
isNewSentence
in interfaceWordTokenizer
- Returns:
- true if the current word is at the start of a sentence
-
-