org.apache.lucene.search

Class TopDocs

java.lang.Object

org.apache.lucene.search.TopDocs

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TopFieldDocs

public class TopDocs
extends java.lang.Object
implements java.io.Serializable

Expert: Returned by low-level search implementations.

See Also:

Searcher.search(Query,Filter,int), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ScoreDoc[]	scoreDocs Expert: The top hits for the query.
int	totalHits Expert: The total number of hits for the query.

Constructor Summary

Constructors

Constructor and Description
TopDocs(int totalHits, ScoreDoc[] scoreDocs, float maxScore) Expert: Constructs a TopDocs.

Method Summary

Modifier and Type	Method and Description
float	getMaxScore() Expert: Returns the maximum score value encountered.
void	setMaxScore(float maxScore) Expert: Sets the maximum score value encountered.

Methods inherited from class java.lang.Object

equals, 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

public TopDocs(int totalHits,
               ScoreDoc[] scoreDocs,
               float maxScore)

Expert: Constructs a TopDocs.

Method Detail

getMaxScore

public float getMaxScore()

Expert: Returns the maximum score value encountered.

setMaxScore

public void setMaxScore(float maxScore)

Expert: Sets the maximum score value encountered.