edu.ucla.sspace.text

Class WordReplacementIterator

java.lang.Object

edu.ucla.sspace.text.WordReplacementIterator

All Implemented Interfaces:

Iterator<String>

public class WordReplacementIterator
extends Object
implements Iterator<String>

An iterator over all tokens in a stream that replaces tokens if they have a known replacement value. This simplifies term substitutions, such as mapping the both "banana" and "cat" to "bananacat".

Constructor Summary

Constructors

Constructor and Description
WordReplacementIterator(Iterator<String> base, Map<String,String> map)

Method Summary

Methods

Modifier and Type	Method and Description
void	advance() Advances to the next word in the token stream.
boolean	hasNext() Returns true if this iterator has additional tokens to return.
String	next() Return the next token's replacement if such a replacement exists.
void	remove() Throws an UnsupportedOperationException if called.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordReplacementIterator

public WordReplacementIterator(Iterator<String> base,
                       Map<String,String> map)

Method Detail

advance

public void advance()

Advances to the next word in the token stream.

hasNext

public boolean hasNext()

Returns true if this iterator has additional tokens to return.

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Return the next token's replacement if such a replacement exists. If no replacement for the next token exists, the original token is returned.

Specified by:

next in interface Iterator<String>

Returns:

The next token stored in this iterator, replaced with a subsituted value if one exists.

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<String>