lucene::search::TopFieldDocs Class Reference

Expert: Returned by low-level sorted search implementations. More...

#include <FieldDocSortedHitQueue.h>

Inheritance diagram for lucene::search::TopFieldDocs:

List of all members.

Public Member Functions
	TopFieldDocs (int32_t totalHits, FieldDoc **fieldDocs, int32_t scoreDocsLen, SortField **fields)
	Creates one of these objects.
	~TopFieldDocs ()
Public Attributes
SortField **	fields
	The fields which were used to sort results by.
FieldDoc **	fieldDocs

---

Detailed Description

Expert: Returned by low-level sorted search implementations.

See also:

Searchable::search(Query,Filter,int32_t,Sort)

---

Constructor & Destructor Documentation

lucene::search::TopFieldDocs::TopFieldDocs	(	int32_t	totalHits,
		FieldDoc **	fieldDocs,
		int32_t	scoreDocsLen,
		SortField **	fields
	)

Creates one of these objects.

Parameters:

	totalHits	Total number of hits for the query.
	fieldDocs	The top hits for the query.
	scoreDocs	The top hits for the query.
	scoreDocsLen	Length of fieldDocs and scoreDocs
	fields	The sort criteria used to find the top hits.

lucene::search::TopFieldDocs::~TopFieldDocs

(

)

---

Member Data Documentation

FieldDoc** lucene::search::TopFieldDocs::fieldDocs

SortField** lucene::search::TopFieldDocs::fields

The fields which were used to sort results by.

---

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

• FieldDocSortedHitQueue.h