edu.ucla.sspace.text

Class OrderPreservingFilteredIterator

java.lang.Object

edu.ucla.sspace.text.OrderPreservingFilteredIterator

All Implemented Interfaces:

Iterator<String>

public class OrderPreservingFilteredIterator
extends Object
implements Iterator<String>

An iterator over all the tokens in a stream that uses a TokenFilter to remove invalid tokens and replaces them with the IteratorFactory.EMPTY_TOKEN string to signify their position. This class is itended for us when filtering is desired but the original ordering and spacing of the tokens must be preserved.

Constructor Summary

Constructors

Constructor and Description
OrderPreservingFilteredIterator(BufferedReader reader, TokenFilter filter) Creates a filtered iterator using the reader as a source of tokens
OrderPreservingFilteredIterator(Iterator<String> tokens, TokenFilter filter) Creates a filtered iterator using provided iterator as the source of tokens
OrderPreservingFilteredIterator(String str, TokenFilter filter) Creates a filtered iterator using the string as a source of tokens

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if this iterator has additional tokens that would be accepted by the filter
String	next() Returns the next word from the reader that has passed the filter.
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

OrderPreservingFilteredIterator

public OrderPreservingFilteredIterator(String str,
                               TokenFilter filter)

Creates a filtered iterator using the string as a source of tokens

OrderPreservingFilteredIterator

public OrderPreservingFilteredIterator(BufferedReader reader,
                               TokenFilter filter)

Creates a filtered iterator using the reader as a source of tokens

OrderPreservingFilteredIterator

public OrderPreservingFilteredIterator(Iterator<String> tokens,
                               TokenFilter filter)

Creates a filtered iterator using provided iterator as the source of tokens

Method Detail

hasNext

public boolean hasNext()

Returns true if this iterator has additional tokens that would be accepted by the filter

Specified by:

hasNext in interface Iterator<String>

next

public String next()

Returns the next word from the reader that has passed the filter.

Specified by:

next in interface Iterator<String>

remove

public void remove()

Throws an UnsupportedOperationException if called.

Specified by:

remove in interface Iterator<String>