Lucene.Net.Search.FieldDoc Class Reference

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. More...

Inherits Lucene.Net.Search.ScoreDoc.

Public Member Functions
	FieldDoc (int doc, float score)
	Expert: Creates one of these objects with empty sort information.
	FieldDoc (int doc, float score, System.IComparable[] fields)
	Expert: Creates one of these objects with the given sort information.
override System.String	ToString ()
Public Member Functions inherited from Lucene.Net.Search.ScoreDoc
	ScoreDoc (int doc, float score)
	Expert: Constructs a ScoreDoc.
override System.String	ToString ()

Public Attributes
System.IComparable[]	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.

Additional Inherited Members
Properties inherited from Lucene.Net.Search.ScoreDoc
float	Score [get, set]
	Expert: The score of this document for the query.
int	Doc [get, set]
	Expert: A hit document's number.

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.

Created: Feb 11, 2004 1:23:38 PM

See Also

ScoreDoc

See Also

TopFieldDocs

Definition at line 41 of file FieldDoc.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.FieldDoc.FieldDoc	(	int	doc,
		float	score
	)

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

Definition at line 57 of file FieldDoc.cs.

Lucene.Net.Search.FieldDoc.FieldDoc	(	int	doc,
		float	score,
		System.IComparable[]	fields
	)

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

Definition at line 62 of file FieldDoc.cs.

Member Function Documentation

override System.String Lucene.Net.Search.FieldDoc.ToString

(

)

Definition at line 68 of file FieldDoc.cs.

Member Data Documentation

System.IComparable [] Lucene.Net.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

See Also

Searcher.Search(Query,Filter,int,Sort)

Definition at line 54 of file FieldDoc.cs.

---

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

• core/Search/FieldDoc.cs