Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
Lucene.Net.Search.FieldValueHitQueue Class Referenceabstract

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

Inherits PriorityQueue< FieldValueHitQueue.Entry >.

Inherited by Lucene.Net.Search.FieldValueHitQueue.MultiComparatorsFieldValueHitQueue, and Lucene.Net.Search.FieldValueHitQueue.OneComparatorFieldValueHitQueue.

Classes

class  Entry
 

Public Member Functions

abstract override bool LessThan (Entry a, Entry b)
 

Static Public Member Functions

static FieldValueHitQueue Create (SortField[] fields, int size)
 Creates a hit queue sorted by the given list of fields.
 

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.

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

See Also
Searcher.Search(Query,Filter,int,Sort)
See Also
FieldCache

Definition at line 34 of file FieldValueHitQueue.cs.

Member Function Documentation

static FieldValueHitQueue Lucene.Net.Search.FieldValueHitQueue.Create ( SortField[]  fields,
int  size 
)
static

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
fieldsSortField array we are sorting by in priority order (highest priority first); cannot be null or empty
sizeThe number of hits to retain. Must be greater than zero.

<throws> IOException </throws>

Definition at line 169 of file FieldValueHitQueue.cs.

abstract override bool Lucene.Net.Search.FieldValueHitQueue.LessThan ( Entry  a,
Entry  b 
)
pure virtual

The documentation for this class was generated from the following file: