Package org.opensearch.search.aggregations.support

Enum Class MissingValues

java.lang.Object

java.lang.Enum<MissingValues>

org.opensearch.search.aggregations.support.MissingValues

All Implemented Interfaces:

Serializable, Comparable<MissingValues>, Constable

public enum MissingValues
extends Enum<MissingValues>

Utility class that allows to return views of ValuesSources that replace the missing value with a configured value.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Method Summary

Modifier and Type	Method	Description
static SortedBinaryDocValues	replaceMissing(SortedBinaryDocValues values, org.apache.lucene.util.BytesRef missing)
static ValuesSource.Bytes	replaceMissing(ValuesSource.Bytes.WithOrdinals valuesSource, org.apache.lucene.util.BytesRef missing)
static ValuesSource.Bytes	replaceMissing(ValuesSource.Bytes valuesSource, org.apache.lucene.util.BytesRef missing)
static ValuesSource.GeoPoint	replaceMissing(ValuesSource.GeoPoint valuesSource, GeoPoint missing)
static ValuesSource.Numeric	replaceMissing(ValuesSource.Numeric valuesSource, Number missing)
static MissingValues	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MissingValues[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

values

public static MissingValues[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MissingValues valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

replaceMissing

public static ValuesSource.Bytes replaceMissing(ValuesSource.Bytes valuesSource,
 org.apache.lucene.util.BytesRef missing)

replaceMissing

public static SortedBinaryDocValues replaceMissing(SortedBinaryDocValues values,
 org.apache.lucene.util.BytesRef missing)

replaceMissing

public static ValuesSource.Numeric replaceMissing(ValuesSource.Numeric valuesSource,
 Number missing)

replaceMissing

public static ValuesSource.Bytes replaceMissing(ValuesSource.Bytes.WithOrdinals valuesSource,
 org.apache.lucene.util.BytesRef missing)

replaceMissing

public static ValuesSource.GeoPoint replaceMissing(ValuesSource.GeoPoint valuesSource,
 GeoPoint missing)