Package org.apache.lucene.search

Class NumericFieldStats

java.lang.Object

org.apache.lucene.search.NumericFieldStats

public final class NumericFieldStats
extends Object

Utility class for retrieving global numeric field statistics from index metadata structures, without accessing individual documents. It probes PointValues first and falls back to DocValuesSkipper. Returns null when neither structure is available for the field.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	NumericFieldStats.Stats	Holds the global statistics for a numeric field.

Method Summary

Modifier and Type	Method	Description
static NumericFieldStats.Stats	getStats(IndexReader reader, String field)	Returns the global statistics for the given numeric field across all segments.

Methods inherited from class java.lang.Object

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

Method Details

getStats

public static NumericFieldStats.Stats getStats(IndexReader reader,
 String field)
                                        throws IOException

Returns the global statistics for the given numeric field across all segments. Probes PointValues first; if unavailable, falls back to DocValuesSkipper.

Parameters:

reader - the IndexReader to query

field - the name of the numeric field

Returns:

a NumericFieldStats.Stats containing the global min, max, and doc count, or null if neither PointValues nor DocValuesSkipper are available for the field

Throws:

IOException - if an I/O error occurs