Package org.apache.lucene.search.suggest

Class SortedTermFreqIteratorWrapper

java.lang.Object

org.apache.lucene.search.suggest.SortedTermFreqIteratorWrapper

All Implemented Interfaces:

TermFreqIterator, BytesRefIterator

public class SortedTermFreqIteratorWrapper
extends Object
implements TermFreqIterator

This wrapper buffers incoming elements and makes sure they are sorted based on given comparator.

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	Description
SortedTermFreqIteratorWrapper(TermFreqIterator source)	Creates a new sorted wrapper, using BytesRef.getUTF8SortedAsUnicodeComparator() for sorting.
SortedTermFreqIteratorWrapper(TermFreqIterator source, Comparator<BytesRef> comparator)	Creates a new sorted wrapper, sorting by BytesRef (ascending) then cost (ascending).

Method Summary

Modifier and Type	Method	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()	A term's weight, higher numbers mean better suggestions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedTermFreqIteratorWrapper

public SortedTermFreqIteratorWrapper(TermFreqIterator source)
                              throws IOException

Creates a new sorted wrapper, using BytesRef.getUTF8SortedAsUnicodeComparator() for sorting.

Throws:

IOException

SortedTermFreqIteratorWrapper

public SortedTermFreqIteratorWrapper(TermFreqIterator source,
                                     Comparator<BytesRef> comparator)
                              throws IOException

Creates a new sorted wrapper, sorting by BytesRef (ascending) then cost (ascending).

Throws:

IOException

Method Detail

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

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 - If there is a low-level I/O error.

weight

public long weight()

Description copied from interface: TermFreqIterator

A term's weight, higher numbers mean better suggestions.

Specified by:

weight in interface TermFreqIterator