org.apache.lucene.search
Class TopFieldDocs

java.lang.Object
  extended by org.apache.lucene.search.TopDocs
      extended by org.apache.lucene.search.TopFieldDocs
All Implemented Interfaces:
Serializable

public class TopFieldDocs
extends TopDocs

Represents hits returned by Searcher.search(Query,Filter,int,Sort).

See Also:
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, merge, 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.