org.apache.lucene.search.spell

Class TermFreqIterator.TermFreqIteratorWrapper

java.lang.Object

org.apache.lucene.search.spell.TermFreqIterator.TermFreqIteratorWrapper

All Implemented Interfaces:

TermFreqIterator, BytesRefIterator

Enclosing interface:

TermFreqIterator

public static class TermFreqIterator.TermFreqIteratorWrapper
extends Object
implements TermFreqIterator

Wraps a BytesRefIterator as a TermFreqIterator, with all weights set to 1

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.lucene.search.spell.TermFreqIterator

TermFreqIterator.TermFreqIteratorWrapper

Field Summary

Fields inherited from interface org.apache.lucene.util.BytesRefIterator

EMPTY

Constructor Summary

Constructors

Constructor and Description
TermFreqIterator.TermFreqIteratorWrapper(BytesRefIterator wrapped)

Method Summary

Methods

Modifier and Type	Method and Description
Comparator<BytesRef>	getComparator() Return the BytesRef Comparator used to sort terms provided by the iterator.
BytesRef	next() Increments the iteration to the next BytesRef in the iterator.
long	weight()

Methods inherited from class java.lang.Object

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

Constructor Detail

TermFreqIterator.TermFreqIteratorWrapper

public TermFreqIterator.TermFreqIteratorWrapper(BytesRefIterator wrapped)

Method Detail

weight

public long weight()

Specified by:

weight in interface TermFreqIterator

next

public BytesRef next()
              throws IOException

Description copied from interface: BytesRefIterator

Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.

Specified by:

next in interface BytesRefIterator

Returns:

the next BytesRef in the iterator or null if the end of the iterator is reached.

Throws:

IOException

getComparator

public Comparator<BytesRef> getComparator()

Description copied from interface: BytesRefIterator

Return the BytesRef Comparator used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.

Specified by:

getComparator in interface BytesRefIterator