lucene::search::FieldSortedHitQueue Class Reference

Expert: A hit queue for sorting by hits by terms in more than one field. More...

#include <FieldSortedHitQueue.h>

Inheritance diagram for lucene::search::FieldSortedHitQueue:


Public Member Functions
	FieldSortedHitQueue (lucene::index::IndexReader reader, SortField *fields, int32_t size)
	Creates a hit queue sorted by the given list of fields.
	~FieldSortedHitQueue ()
FieldDoc *	fillFields (FieldDoc *doc) const
	Given a FieldDoc object, stores the values used to sort the given document.
void	setFields (SortField **fields)
SortField **	getFields ()
	Returns the SortFields being used by this hit queue.
Static Public Member Functions
static void	shutdown ()
static void	closeCallback (lucene::index::IndexReader reader, void param)
	Callback for when IndexReader closes.
Static Public Attributes
static hitqueueCacheType *	Comparators
	Internal cache of comparators.
Protected Member Functions
bool	lessThan (FieldDoc docA, FieldDoc docB)
	Returns whether `a` is less relevant than `b`.
Protected Attributes
ScoreDocComparator **	comparators
	Stores a comparator corresponding to each field being sorted by.
int32_t	comparatorsLen
SortField **	fields
	Stores the sort criteria being used.
int32_t	fieldsLen
float_t	maxscore
	Stores the maximum score value encountered, for normalizing.

Detailed Description

Expert: A hit queue for sorting by hits by terms in more than one field.

Uses FieldCache.DEFAULT for maintaining internal term lookup tables.

See also:: Searchable::search(Query,Filter,int32_t,Sort)
FieldCache

Constructor & Destructor Documentation

lucene::search::FieldSortedHitQueue::FieldSortedHitQueue	(	lucene::index::IndexReader *	reader,
		SortField **	fields,
		int32_t	size
	)

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

Parameters:

	reader	Index to use.
	fields	Field names, in priority order (highest priority first). Cannot be `null` or empty.
	size	The number of hits to retain. Must be greater than zero.

Exceptions:

IOException

lucene::search::FieldSortedHitQueue::~FieldSortedHitQueue ( )

Member Function Documentation

static void lucene::search::FieldSortedHitQueue::shutdown ( ) [static]

bool lucene::search::FieldSortedHitQueue::lessThan	(	FieldDoc *	docA,
		FieldDoc *	docB
	)			`[protected]`

Returns whether a is less relevant than b.

Parameters:

	a	ScoreDoc
	b	ScoreDoc

Returns:: true if document a should be sorted after document b.

static void lucene::search::FieldSortedHitQueue::closeCallback	(	lucene::index::IndexReader *	reader,
		void *	param
	)			`[static]`

Callback for when IndexReader closes.

This causes any Comparators to be removed for the specified reader.

FieldDoc* lucene::search::FieldSortedHitQueue::fillFields ( FieldDoc * doc ) const

Given a FieldDoc object, stores the values used to sort the given document.

These values are not the raw values out of the index, but the internal representation of them. This is so the given search hit can be collated by a MultiSearcher with other search hits.

Parameters:

doc

The FieldDoc to store sort values into.