com.swabunga.spell.event
public abstract class AbstractWordFinder extends Object implements WordFinder
Field Summary | |
---|---|
protected Word | currentWord The word being analyzed |
protected Word | nextWord The word following the current one |
protected BreakIterator | sentenceIterator An iterator to work through the sentence |
protected boolean | startsSentence Indicate if the current word starts a new sentence |
protected String | text Holds the text to analyze |
Constructor Summary | |
---|---|
AbstractWordFinder(String inText)
Creates a new AbstractWordFinder object.
| |
AbstractWordFinder()
Creates a new default AbstractWordFinder object. |
Method Summary | |
---|---|
Word | current()
Returns the current word in the iteration .
|
String | getText()
Return the text being searched. |
boolean | hasNext()
Indicates if there is some more word to analyze |
protected int | ignore(int index, char startIgnore)
Ignores or skip over text starting from the index position specified
if it contains the startIgnore , and until the
first non letter or digit character is encountered or end of text is
detected. |
protected int | ignore(int index, char startIgnore, char endIgnore)
Ignores or skip over text starting from the index position specified
if it contains the startIgnore , and until the
endIgnore character is encountered or end of text is
detected. |
protected int | ignore(int index, Character startIgnore, Character endIgnore)
Ignores or skip over text starting from the index position specified
if it contains the startIgnore , and until the
endIgnore character is encountered or end of text is
detected. |
protected int | ignore(int index, String startIgnore, String endIgnore)
Ignores or skip over text starting from the index position specified
if it contains the startIgnore string, and until the
endIgnore string is encountered or end of text is
detected. |
protected void | init()
Initializes the sentenseIterator |
protected boolean | isWordChar(int posn)
Indicates if the character at the specified position is acceptable as
part of a word. |
protected boolean | isWordChar(char c)
Indicates if the character at the specified character is acceptable as
part of a word. |
abstract Word | next()
This method scans the text from the end of the last word, and returns
a new Word object corresponding to the next word.
|
void | replace(String newWord)
Replace the current word in the search with a replacement string.
|
protected void | setSentenceIterator(Word wd)
Adjusts the sentence iterator and the startSentence flag according to the
currentWord. |
void | setText(String newText)
Defines the text to search. |
boolean | startsSentence() |
String | toString()
Return the text being searched. |
Parameters: inText the String to iterate through.
Returns: the current word.
Throws: WordNotFoundException current word has not yet been set.
Returns: the text being searched.
Returns: true if there are further words in the string.
startIgnore
, and until the
first non letter or digit character is encountered or end of text is
detected.Parameters: index The start position in text. startIgnore The character that should be at index
position to start skipping through.
Returns: The index position pointing after the skipped characters or the original index if the ignore condition could not be met.
startIgnore
, and until the
endIgnore
character is encountered or end of text is
detected.Parameters: index The start position in text. startIgnore The character that should be at index
position to start skipping through. endIgnore The character which mark the end of skipping through. If
the value of endIgnore is null
, skipping characters stop
at first non letter or digit character.
Returns: The index position pointing after the skipped characters or the original index if the ignore condition could not be met.
startIgnore
, and until the
endIgnore
character is encountered or end of text is
detected.Parameters: index The start position in text. startIgnore The character that should be at index
position to start skipping through. endIgnore The character which mark the end of skipping through. If
the value of endIgnore is null
, skipping characters stop
at first non letter or digit character.
Returns: The index position pointing after the skipped characters or the original index if the ignore condition could not be met.
startIgnore
string, and until the
endIgnore
string is encountered or end of text is
detected.Parameters: index The start position in text. startIgnore The string that should be at index
position to start skipping through. endIgnore The string which mark the end of skipping through.
Returns: The index position pointing after the skipped characters or the original index if the ignore condition could not be met.
Parameters: posn The character position to analyze.
Returns: true if the character is a letter or digit
Parameters: c The character to evaluates if it can be part of a word
Returns: true if the character is a letter, digit or a ' (an apostrophe).
Returns: the following word.
Parameters: newWord the replacement string.
Throws: WordNotFoundException current word has not yet been set.
Parameters: wd the wd parameter is not presently used.
Parameters: newText The text to be analyzed
Returns: true if the current word starts a new sentence.
Throws: WordNotFoundException current word has not yet been set.
Returns: the text being searched.