gate.creole.annic.apache.lucene.search
Class TopFieldDocs

java.lang.Object
  gate.creole.annic.apache.lucene.search.TopDocs
      gate.creole.annic.apache.lucene.search.TopFieldDocs

All Implemented Interfaces:

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

Version:

$Id: TopFieldDocs.java 529 2004-10-05 11:55:26Z niraj $

Author:

Tim Jones (Nacimiento Software)

See Also:

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

Field Summary

SortField[]

fields The fields which were used to sort results by.

Fields inherited from class gate.creole.annic.apache.lucene.search.TopDocs

scoreDocs, totalHits

Constructor Summary

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

Method Summary

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

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

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.