Package org.elasticsearch.index.fielddata.ordinals

Enum Class GlobalOrdinalsBuilder

java.lang.Object

java.lang.Enum<GlobalOrdinalsBuilder>

org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsBuilder

All Implemented Interfaces:

Serializable, Comparable<GlobalOrdinalsBuilder>, Constable

public enum GlobalOrdinalsBuilder
extends Enum<GlobalOrdinalsBuilder>

Utility class to build global ordinals.

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 IndexOrdinalsFieldData	build(org.apache.lucene.index.IndexReader indexReader, IndexOrdinalsFieldData indexFieldData, CircuitBreakerService breakerService, org.apache.logging.log4j.Logger logger, Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)	Build global ordinals for the provided IndexReader.
static IndexOrdinalsFieldData	buildEmpty(org.apache.lucene.index.IndexReader indexReader, IndexOrdinalsFieldData indexFieldData)
static GlobalOrdinalsBuilder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GlobalOrdinalsBuilder[]	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 GlobalOrdinalsBuilder[] 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 GlobalOrdinalsBuilder 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

build

public static IndexOrdinalsFieldData build(org.apache.lucene.index.IndexReader indexReader,
 IndexOrdinalsFieldData indexFieldData,
 CircuitBreakerService breakerService,
 org.apache.logging.log4j.Logger logger,
 Function<org.apache.lucene.index.SortedSetDocValues,ScriptDocValues<?>> scriptFunction)
                                    throws IOException

Build global ordinals for the provided IndexReader.

Throws:

IOException

buildEmpty

public static IndexOrdinalsFieldData buildEmpty(org.apache.lucene.index.IndexReader indexReader,
 IndexOrdinalsFieldData indexFieldData)
                                         throws IOException

Throws:

IOException