Package org.hibernate.search.engine.search.query.spi

Class SimpleSearchResultTotal

java.lang.Object

org.hibernate.search.engine.search.query.spi.SimpleSearchResultTotal

All Implemented Interfaces:

SearchResultTotal

public class SimpleSearchResultTotal
extends Object
implements SearchResultTotal

Method Summary

Modifier and Type	Method	Description
static SimpleSearchResultTotal	exact(long totalHitCount)
long	hitCount()
long	hitCountLowerBound()
boolean	isHitCountExact()
boolean	isHitCountLowerBound()
static SimpleSearchResultTotal	lowerBound(long totalHitCount)
static SimpleSearchResultTotal	of(long totalHitCount, boolean isExact)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

of

public static SimpleSearchResultTotal of(long totalHitCount,
                                         boolean isExact)

exact

public static SimpleSearchResultTotal exact(long totalHitCount)

lowerBound

public static SimpleSearchResultTotal lowerBound(long totalHitCount)

isHitCountExact

public boolean isHitCountExact()

Specified by:

isHitCountExact in interface SearchResultTotal

Returns:

Whether the total hit count is exact. The total hit count is exact by default, but that can change when a SearchQueryOptionsStep.totalHitCountThreshold(long) or a SearchQueryOptionsStep.truncateAfter(long, TimeUnit) has been defined for the current query.

isHitCountLowerBound

public boolean isHitCountLowerBound()

Specified by:

isHitCountLowerBound in interface SearchResultTotal

Returns:

Whether the total hit count is a lower-bound estimate. The total hit count can be a lower bound only when a SearchQueryOptionsStep.totalHitCountThreshold(long) or a SearchQueryOptionsStep.truncateAfter(long, TimeUnit) has been defined for the current query.

hitCount

public long hitCount()

Specified by:

hitCount in interface SearchResultTotal

Returns:

The exact value of the total hit count, if available. Unless you used particular search options, you can safely assume the exact value of the total hit count is available.

hitCountLowerBound

public long hitCountLowerBound()

Specified by:

hitCountLowerBound in interface SearchResultTotal

Returns:

A lower-bound estimate of the total hit count. If the total hit count is known exactly, the exact total hit count is returned.

toString

public String toString()

Overrides:

toString in class Object