org.apache.lucene.search.suggest

Class SortedInputIterator

java.lang.Object

org.apache.lucene.search.suggest.SortedInputIterator

All Implemented Interfaces:

InputIterator, BytesRefIterator

public class SortedInputIterator
extends Object
implements InputIterator

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.suggest.InputIterator

InputIterator.InputIteratorWrapper

Field Summary

Fields inherited from interface org.apache.lucene.search.suggest.InputIterator

EMPTY

Constructor Summary

Constructors

Constructor and Description
SortedInputIterator(InputIterator source) Creates a new sorted wrapper, using BytesRef.getUTF8SortedAsUnicodeComparator() for sorting.
SortedInputIterator(InputIterator source, Comparator<BytesRef> comparator) Creates a new sorted wrapper, sorting by BytesRef (ascending) then cost (ascending).

Method Summary

Methods

Modifier and Type	Method and Description
Set<BytesRef>	contexts() A term's contexts context can be used to filter suggestions.
protected long	decode(BytesRef scratch, ByteArrayDataInput tmpInput) decodes the weight at the current position
protected Set<BytesRef>	decodeContexts(BytesRef scratch, ByteArrayDataInput tmpInput) decodes the contexts at the current position
protected BytesRef	decodePayload(BytesRef scratch, ByteArrayDataInput tmpInput) decodes the payload at the current position
protected void	encode(OfflineSorter.ByteSequencesWriter writer, ByteArrayDataOutput output, byte[] buffer, BytesRef spare, BytesRef payload, Set<BytesRef> contexts, long weight) encodes an entry (bytes+(contexts)+(payload)+weight) to the provided writer
Comparator<BytesRef>	getComparator() Return the BytesRef Comparator used to sort terms provided by the iterator.
boolean	hasContexts() Returns true if the iterator has contexts
boolean	hasPayloads() Returns true if the iterator has payloads
BytesRef	next() Increments the iteration to the next BytesRef in the iterator.
BytesRef	payload() An arbitrary byte[] to record per suggestion.
long	weight() A term's weight, higher numbers mean better suggestions.

Methods inherited from class java.lang.Object

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

Constructor Detail

SortedInputIterator

public SortedInputIterator(InputIterator source)
                    throws IOException

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

Throws:

IOException

SortedInputIterator

public SortedInputIterator(InputIterator source,
                   Comparator<BytesRef> comparator)
                    throws IOException

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

Throws:

IOException

Method Detail

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: InputIterator

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

Specified by:

weight in interface InputIterator

payload

public BytesRef payload()

Description copied from interface: InputIterator

An arbitrary byte[] to record per suggestion. See Lookup.LookupResult.payload to retrieve the payload for each suggestion.

Specified by:

payload in interface InputIterator

hasPayloads

public boolean hasPayloads()

Description copied from interface: InputIterator

Returns true if the iterator has payloads

Specified by:

hasPayloads in interface InputIterator

contexts

public Set<BytesRef> contexts()

Description copied from interface: InputIterator

A term's contexts context can be used to filter suggestions. May return null, if suggest entries do not have any context

Specified by:

contexts in interface InputIterator

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

hasContexts

public boolean hasContexts()

Description copied from interface: InputIterator

Returns true if the iterator has contexts

Specified by:

hasContexts in interface InputIterator

encode

protected void encode(OfflineSorter.ByteSequencesWriter writer,
          ByteArrayDataOutput output,
          byte[] buffer,
          BytesRef spare,
          BytesRef payload,
          Set<BytesRef> contexts,
          long weight)
               throws IOException

encodes an entry (bytes+(contexts)+(payload)+weight) to the provided writer

Throws:

IOException

decode

protected long decode(BytesRef scratch,
          ByteArrayDataInput tmpInput)

decodes the weight at the current position

decodeContexts

protected Set<BytesRef> decodeContexts(BytesRef scratch,
                           ByteArrayDataInput tmpInput)

decodes the contexts at the current position

decodePayload

protected BytesRef decodePayload(BytesRef scratch,
                     ByteArrayDataInput tmpInput)

decodes the payload at the current position