org.apache.lucene.search.suggest.fst

Class ExternalRefSorter

java.lang.Object

org.apache.lucene.search.suggest.fst.ExternalRefSorter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BytesRefSorter

public class ExternalRefSorter
extends java.lang.Object
implements BytesRefSorter, java.io.Closeable

Builds and iterates over sequences stored on disk.

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

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Constructor Summary

Constructors

Constructor and Description
ExternalRefSorter(Sort sort) Will buffer all sequences to a temporary file and then sort (all on-disk).

Method Summary

Modifier and Type	Method and Description
void	add(BytesRef utf8) Adds a single suggestion entry (possibly compound with its bucket).
void	close() Removes any written temporary files.
java.util.Comparator<BytesRef>	getComparator()
BytesRefIterator	iterator() Sorts the entries added in BytesRefSorter.add(BytesRef) and returns an iterator over all sorted entries.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalRefSorter

public ExternalRefSorter(Sort sort)
                  throws java.io.IOException

Will buffer all sequences to a temporary file and then sort (all on-disk).

Throws:

java.io.IOException

Method Detail

add

public void add(BytesRef utf8)
         throws java.io.IOException

Description copied from interface: BytesRefSorter

Adds a single suggestion entry (possibly compound with its bucket).

Specified by:

add in interface BytesRefSorter

Throws:

java.io.IOException - If an I/O exception occurs.

iterator

public BytesRefIterator iterator()
                          throws java.io.IOException

Description copied from interface: BytesRefSorter

Sorts the entries added in BytesRefSorter.add(BytesRef) and returns an iterator over all sorted entries.

Specified by:

iterator in interface BytesRefSorter

Throws:

java.io.IOException - If an I/O exception occurs.

close

public void close()
           throws java.io.IOException

Removes any written temporary files.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getComparator

public java.util.Comparator<BytesRef> getComparator()

Specified by:

getComparator in interface BytesRefSorter