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

java.lang.Object
  extended by gate.creole.annic.apache.lucene.search.TopDocs
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
TopFieldDocs

public class TopDocs
extends Object
implements Serializable

Expert: Returned by low-level search implementations.

See Also:
Searchable.search(Query,Filter,int), Serialized Form

Field Summary
 ScoreDoc[] scoreDocs
          Expert: The top hits for the query.
 int totalHits
          Expert: The total number of hits for the query.
 
Constructor Summary
TopDocs(int totalHits, ScoreDoc[] scoreDocs)
          Expert: Constructs a TopDocs.
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

totalHits

public int totalHits
Expert: The total number of hits for the query.

See Also:
Hits.length()

scoreDocs

public ScoreDoc[] scoreDocs
Expert: The top hits for the query.

Constructor Detail

TopDocs

TopDocs(int totalHits,
        ScoreDoc[] scoreDocs)
Expert: Constructs a TopDocs.