org.apache.lucene.search: public class: TopDocs

org.apache.lucene.search
public class: TopDocs [javadoc | source]

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

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
TopFieldDocs

Expert: Returned by low-level search implementations.

Also see:

Searcher#search(Query,Filter,int)

Field Summary
public int	totalHits	Expert: The total number of hits for the query. Also see: Hits#length()
public ScoreDoc[]	scoreDocs	Expert: The top hits for the query.

Constructor:
public TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore) { this.totalHits = totalHits; this.scoreDocs = scoreDocs; this.maxScore = maxScore; } Expert: Constructs a TopDocs.

Constructor:

 public TopDocs(int totalHits,
    ScoreDoc[] scoreDocs,
    float maxScore) {
    this.totalHits = totalHits;
    this.scoreDocs = scoreDocs;
    this.maxScore = maxScore;
}

Expert: Constructs a TopDocs.

Method from org.apache.lucene.search.TopDocs Summary:
getMaxScore, setMaxScore

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.lucene.search.TopDocs Detail:
public float getMaxScore() { return maxScore; } Expert: Returns the maximum score value encountered.
public void setMaxScore(float maxScore) { this.maxScore=maxScore; } Expert: Sets the maximum score value encountered.

Method from org.apache.lucene.search.TopDocs Detail:

 public float getMaxScore() {
      return maxScore;
}

Expert: Returns the maximum score value encountered.

 public  void setMaxScore(float maxScore) {
      this.maxScore=maxScore;
}

Expert: Sets the maximum score value encountered.