lucene::search::FieldDoc Class Reference

Expert: A ScoreDoc which also contains information about how to sort the referenced document. More...

#include <FieldDoc.h>

Public Member Functions
	FieldDoc (int32_t doc, float_t score)
	Expert: Creates one of these objects with empty sort information.
	FieldDoc (int32_t doc, float_t score, lucene::util::Comparable **fields)
	Expert: Creates one of these objects with the given sort information.
	~FieldDoc ()
Data Fields
struct ScoreDoc	scoreDoc
lucene::util::Comparable **	fields
	Expert: The values which are used to sort the referenced document.

---

Detailed Description

Expert: A ScoreDoc which also contains information about how to sort the referenced document.

In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the fields object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either Integer, Float or String depending on the type of values in the terms of each field.

See also:

ScoreDoc

TopFieldDocs

---

Constructor & Destructor Documentation

lucene::search::FieldDoc::FieldDoc	(	int32_t	doc,
		float_t	score
	)

Expert: Creates one of these objects with empty sort information.

lucene::search::FieldDoc::FieldDoc	(	int32_t	doc,
		float_t	score,
		lucene::util::Comparable **	fields
	)

Expert: Creates one of these objects with the given sort information.

lucene::search::FieldDoc::~FieldDoc

(

)

---

Field Documentation

struct ScoreDoc lucene::search::FieldDoc::scoreDoc [read]

lucene:: util ::Comparable** lucene::search::FieldDoc::fields

Expert: The values which are used to sort the referenced document.

The order of these will match the original sort criteria given by a Sort object. Each Object will be either an Integer, Float or String, depending on the type of values in the terms of the original field.

See also:

Sort

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

---

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

• FieldDoc.h