core/org.gnit.lucenekmp.search/FieldDoc

FieldDoc

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

Since

lucene 1.4

Constructors

FieldDoc

constructor(doc: Int, score: Float)

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

constructor(doc: Int, score: Float, fields: Array<Any?>?)

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

constructor(doc: Int, score: Float, fields: Array<Any?>?, shardIndex: Int)

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

Properties

doc

var doc: Int

A hit document's number.

fields

var fields: Array<Any?>?

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 have been returned from the value method corresponding FieldComparator used to sort this field.

score

var score: Float

The score of this document for the query.

shardIndex

var shardIndex: Int

Only set by TopDocs.merge

Functions

toString

open override fun toString(): String

Constructs a ScoreDoc.

FieldDoc

Since

See also

Constructors

Properties

Functions