org.apache.lucene.search
Class TopFieldDocs

java.lang.Object
  org.apache.lucene.search.TopDocs
      org.apache.lucene.search.TopFieldDocs

All Implemented Interfaces:

java.io.Serializable

public class TopFieldDocs
extends TopDocs

Expert: Returned by low-level sorted search implementations.

Created: Feb 12, 2004 8:58:46 AM

Since:

lucene 1.4

See Also:

Searcher.search(Query,Filter,int,Sort), Serialized Form

Field Summary

SortField[]

fields The fields which were used to sort results by.

Fields inherited from class org.apache.lucene.search.TopDocs

scoreDocs, totalHits

Constructor Summary

TopFieldDocs(int totalHits, ScoreDoc[] scoreDocs, SortField[] fields, float maxScore)
Creates one of these objects.

Method Summary

Methods inherited from class org.apache.lucene.search.TopDocs

getMaxScore, setMaxScore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fields

public SortField[] fields

The fields which were used to sort results by.

Constructor Detail

TopFieldDocs

public TopFieldDocs(int totalHits,
                    ScoreDoc[] scoreDocs,
                    SortField[] fields,
                    float maxScore)

Creates one of these objects.

Parameters:

totalHits - Total number of hits for the query.

scoreDocs - The top hits for the query.

fields - The sort criteria used to find the top hits.

maxScore - The maximum score encountered.