Lucene.Net.Search.TopFieldDocs Class Reference

Represents hits returned by Searcher.Search(Query,Filter,int,Sort). More...

Inherits Lucene.Net.Search.TopDocs.

Public Member Functions
	TopFieldDocs (int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore)
	Creates one of these objects.
Public Member Functions inherited from Lucene.Net.Search.TopDocs
	TopDocs (int totalHits, ScoreDoc[] scoreDocs, float maxScore)

Public Attributes
SortField[]	fields
	The fields which were used to sort results by.

Additional Inherited Members
Properties inherited from Lucene.Net.Search.TopDocs
int	TotalHits [get, set]
	The total number of hits for the query.
ScoreDoc[]	ScoreDocs [get, set]
	The top hits for the query.
float	MaxScore [get, set]
	Gets or sets the maximum score value encountered, needed for normalizing. Note that in case scores are not tracked, this returns float.NaN.

Detailed Description

Represents hits returned by Searcher.Search(Query,Filter,int,Sort).

Definition at line 27 of file TopFieldDocs.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.TopFieldDocs.TopFieldDocs	(	int	totalHits,
		ScoreDoc[]	scoreDocs,
		SortField[]	fields,
		float	maxScore
	)

Creates one of these objects.

Parameters

totalHits	Total number of hits for the query.
scoreDocs	The top hits for the query.
fields	The sort criteria used to find the top hits.
maxScore	The maximum score encountered.

Definition at line 42 of file TopFieldDocs.cs.

Member Data Documentation

SortField [] Lucene.Net.Search.TopFieldDocs.fields

The fields which were used to sort results by.

Definition at line 31 of file TopFieldDocs.cs.

---

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

• core/Search/TopFieldDocs.cs