com.swabunga.spell.event
Class StringWordTokenizer

java.lang.Object
  extended bycom.swabunga.spell.event.AbstractWordTokenizer
      extended bycom.swabunga.spell.event.StringWordTokenizer
All Implemented Interfaces:
WordTokenizer

public class StringWordTokenizer
extends AbstractWordTokenizer

This class tokenizes a input string.

It also allows for the string to be altered by calls to replaceWord(). The result after the spell checking is completed is available to the call to getContext.

Author:
Jason Height ([email protected]), Anthony Roy ([email protected])

Field Summary
 
Fields inherited from class com.swabunga.spell.event.AbstractWordTokenizer
currentWord, finder, sentenceIterator, wordCount
 
Constructor Summary
StringWordTokenizer(java.lang.String s)
          Creates a new StringWordTokenizer object.
StringWordTokenizer(java.lang.String s, WordFinder finder)
           
StringWordTokenizer(WordFinder wf)
          Creates a new StringWordTokenizer object.
 
Method Summary
 java.lang.String getFinalText()
          Deprecated. use getContext() instead as per the WordTokenizer interface specification.
 void replaceWord(java.lang.String s)
          Replace the current word in the iteration with the String s.
 
Methods inherited from class com.swabunga.spell.event.AbstractWordTokenizer
getContext, getCurrentWordCount, getCurrentWordEnd, getCurrentWordPosition, hasMoreWords, isNewSentence, nextWord
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringWordTokenizer

public StringWordTokenizer(java.lang.String s)
Creates a new StringWordTokenizer object.

Parameters:
s - the string to tokenize.

StringWordTokenizer

public StringWordTokenizer(WordFinder wf)
Creates a new StringWordTokenizer object.

Parameters:
wf - the custom WordFinder to use in tokenizing. Note that the string to tokenize will be encapsulated within the WordFinder.

StringWordTokenizer

public StringWordTokenizer(java.lang.String s,
                           WordFinder finder)
Method Detail

getFinalText

public java.lang.String getFinalText()
Deprecated. use getContext() instead as per the WordTokenizer interface specification.

Returns:
the final text.

replaceWord

public void replaceWord(java.lang.String s)
Replace the current word in the iteration with the String s.

Specified by:
replaceWord in interface WordTokenizer
Specified by:
replaceWord in class AbstractWordTokenizer
Parameters:
s - the String to replace the current word.
Throws:
WordNotFoundException - current word not yet set.