public class

FieldDoc

extends ScoreDoc
java.lang.Object
   ↳ org.apache.lucene.search.ScoreDoc
     ↳ org.apache.lucene.search.FieldDoc

Class Overview

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

Summary

Fields
public Comparable[] fields Expert: The values which are used to sort the referenced document.
[Expand]
Inherited Fields
From class org.apache.lucene.search.ScoreDoc
Public Constructors
FieldDoc(int doc, float score)
Expert: Creates one of these objects with empty sort information.
FieldDoc(int doc, float score, Comparable[] fields)
Expert: Creates one of these objects with the given sort information.
Public Methods
String toString()
[Expand]
Inherited Methods
From class org.apache.lucene.search.ScoreDoc
From class java.lang.Object

Fields

public Comparable[] 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

Public Constructors

public FieldDoc (int doc, float score)

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

public FieldDoc (int doc, float score, Comparable[] fields)

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

Public Methods

public String toString ()