Package org.apache.lucene.sandbox.facet.iterators

Class TopnOrdinalIterator<T extends Comparable<T>>

java.lang.Object

org.apache.lucene.sandbox.facet.iterators.TopnOrdinalIterator<T>

All Implemented Interfaces:

OrdinalIterator

public final class TopnOrdinalIterator<T extends Comparable<T>>
extends Object
implements OrdinalIterator

Class that consumes incoming ordinals, sorts them by provided Comparable, and returns first top N ordinals only.

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

Field Summary

Fields inherited from interface org.apache.lucene.sandbox.facet.iterators.OrdinalIterator

EMPTY, NO_MORE_ORDS

Constructor Summary

Constructors

Constructor	Description
TopnOrdinalIterator(OrdinalIterator sourceOrds, ComparableSupplier<T> comparableSupplier, int topN)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	nextOrd()	Returns next ord or OrdinalIterator.NO_MORE_ORDS.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.sandbox.facet.iterators.OrdinalIterator

toArray

Constructor Detail

TopnOrdinalIterator

public TopnOrdinalIterator(OrdinalIterator sourceOrds,
                           ComparableSupplier<T> comparableSupplier,
                           int topN)

Constructor.

Method Detail

nextOrd

public int nextOrd()
            throws IOException

Description copied from interface: OrdinalIterator

Returns next ord or OrdinalIterator.NO_MORE_ORDS. *

Specified by:

nextOrd in interface OrdinalIterator

Throws:

IOException