org.apache.lucene.search

Class TopDocs

Implemented Interfaces:
Serializable
Known Direct Subclasses:
TopFieldDocs

public class TopDocs
extends Object
implements Serializable

Expert: Returned by low-level search implementations.
See Also:
Searcher.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.

Method Summary

float
getMaxScore()
Expert: Returns the maximum score value encountered.
void
setMaxScore(float maxScore)
Expert: Sets the maximum score value encountered.

Field Details

scoreDocs

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

totalHits

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

Method Details

getMaxScore

public float getMaxScore()
Expert: Returns the maximum score value encountered.

setMaxScore

public void setMaxScore(float maxScore)
Expert: Sets the maximum score value encountered.

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.