org.dts.spell.finder

Class AbstractWordFinder

java.lang.Object

org.dts.spell.finder.AbstractWordFinder

All Implemented Interfaces:

WordFinder

Direct Known Subclasses:

CharSequenceWordFinder

public abstract class AbstractWordFinder
extends Object
implements WordFinder

Defines common methods and behaviour for various word finder subclasses.

You only have to override abstracts methods and call method init when your data is set. For example : class StringWordFinder extends AbstractWordFinder { private String text ; public StringWordFinder(String text) { this.text = text ; init() ; // Remember call this method to setup variables. } }

Author:

Anthony Roy (ajr@antroy.co.uk), DreamTangerine (DreamTangerine@hotmail.com)

Constructor Summary

Constructors

Constructor and Description
AbstractWordFinder() Create a AbstractWordFinder

Method Summary

Modifier and Type	Method and Description
Word	current() Returns the current word in the iteration.
boolean	hasCurrent()
boolean	hasNext() Tests the finder to see if any more words are available.
void	init() Call this function each time you want begin iterations.
void	init(Word initWord) Call this function to init from a word.
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.
protected abstract Word	next(Word currentWord) Find the next Word of the iteration.
void	replace(String newWord) Replace the current word in the search with a replacement string.
protected abstract void	replace(String newWord, Word currentWord) Replace the current word with the new string newWord.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractWordFinder

public AbstractWordFinder()

Create a AbstractWordFinder

Method Detail

next

protected abstract Word next(Word currentWord)

Find the next Word of the iteration.

Parameters:

currentWord - Current interation word. It can be null if the first iteration.

Returns:

The next word or null if not more words are found.

next

public 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.

Specified by:

next in interface WordFinder

Returns:

the next word.

current

public Word current()

Returns the current word in the iteration.

Specified by:

current in interface WordFinder

Returns:

the current word.

Throws:

WordNotFoundException - current word has not yet been set.

hasCurrent

public boolean hasCurrent()

hasNext

public boolean hasNext()

Description copied from interface: WordFinder

Tests the finder to see if any more words are available.

Specified by:

hasNext in interface WordFinder

Returns:

true if there are further words in the string.

replace

protected abstract void replace(String newWord,
                                Word currentWord)

Replace the current word with the new string newWord.

Parameters:

newWord - The new string for the current word.

currentWord - The current word.

replace

public void replace(String newWord)

Replace the current word in the search with a replacement string.

Specified by:

replace in interface WordFinder

Parameters:

newWord - the replacement string.

Throws:

WordNotFoundException - current word has not yet been set.

init

public void init()

Call this function each time you want begin iterations.

init

public void init(Word initWord)

Call this function to init from a word. It can be null.