org.apache.lucene.search

Class FieldValueHitQueue<T extends FieldValueHitQueue.Entry>

java.lang.Object

org.apache.lucene.util.PriorityQueue<T>

org.apache.lucene.search.FieldValueHitQueue<T>

public abstract class FieldValueHitQueue<T extends FieldValueHitQueue.Entry>
extends PriorityQueue<T>

Expert: A hit queue for sorting by hits by terms in more than one field. Uses FieldCache.DEFAULT for maintaining internal term lookup tables.

Since:

2.9

See Also:

IndexSearcher.search(Query,Filter,int,Sort), FieldCache

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldValueHitQueue.Entry Extension of ScoreDoc to also store the FieldComparator slot.

Method Summary

Modifier and Type	Method and Description
static <T extends FieldValueHitQueue.Entry> FieldValueHitQueue<T>	create(SortField[] fields, int size) Creates a hit queue sorted by the given list of fields.
FieldComparator<?>[]	getComparators()
int[]	getReverseMul()
void	setComparator(int pos, FieldComparator<?> comparator)

Methods inherited from class org.apache.lucene.util.PriorityQueue

add, clear, insertWithOverflow, pop, size, top, updateTop

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T extends FieldValueHitQueue.Entry> FieldValueHitQueue<T> create(SortField[] fields,
                                                                                int size)
                                                                         throws IOException

Creates a hit queue sorted by the given list of fields.

NOTE: The instances returned by this method pre-allocate a full array of length numHits.

Parameters:

fields - SortField array we are sorting by in priority order (highest priority first); cannot be null or empty

size - The number of hits to retain. Must be greater than zero.

Throws:

IOException - if there is a low-level IO error

getComparators

public FieldComparator<?>[] getComparators()

getReverseMul

public int[] getReverseMul()

setComparator

public void setComparator(int pos,
                          FieldComparator<?> comparator)