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.

WARNING: This API is experimental and might change in incompatible ways in the next release.

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
SortedTermFreqIteratorWrapper(TermFreqIterator source, Comparator<BytesRef> comparator)
SortedTermFreqIteratorWrapper(TermFreqIterator source, Comparator<BytesRef> comparator, boolean compareRawBytes)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	decode(BytesRef scratch, ByteArrayDataInput tmpInput)
protected void	encode(Sort.ByteSequencesWriter writer, ByteArrayDataOutput output, byte[] buffer, BytesRef spare, long weight)
Comparator<BytesRef>	getComparator()
BytesRef	next()
long	weight()

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedTermFreqIteratorWrapper

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

Throws:

IOException

SortedTermFreqIteratorWrapper

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

Throws:

IOException

Method Detail

next

public BytesRef next()
              throws IOException

Specified by:

next in interface BytesRefIterator

Throws:

IOException

getComparator

public Comparator<BytesRef> getComparator()

Specified by:

getComparator in interface BytesRefIterator

weight

public long weight()

Specified by:

weight in interface TermFreqIterator

encode

protected void encode(Sort.ByteSequencesWriter writer,
          ByteArrayDataOutput output,
          byte[] buffer,
          BytesRef spare,
          long weight)
               throws IOException

Throws:

IOException

decode

protected long decode(BytesRef scratch,
          ByteArrayDataInput tmpInput)