org.elasticsearch.index.fielddata.ordinals

Enum GlobalOrdinalsBuilder

java.lang.Object

java.lang.Enum<GlobalOrdinalsBuilder>

org.elasticsearch.index.fielddata.ordinals.GlobalOrdinalsBuilder

All Implemented Interfaces:

Serializable, Comparable<GlobalOrdinalsBuilder>

public enum GlobalOrdinalsBuilder
extends Enum<GlobalOrdinalsBuilder>

Utility class to build global ordinals.

Method Summary

Methods

Modifier and Type	Method and Description
static IndexOrdinalsFieldData	build(org.apache.lucene.index.IndexReader indexReader, IndexOrdinalsFieldData indexFieldData, Settings settings, CircuitBreakerService breakerService, ESLogger logger) Build global ordinals for the provided IndexReader.
static IndexOrdinalsFieldData	buildEmpty(Index index, Settings settings, org.apache.lucene.index.IndexReader indexReader, IndexOrdinalsFieldData indexFieldData)
static GlobalOrdinalsBuilder	valueOf(String name) Returns the enum constant of this type with the specified name.
static GlobalOrdinalsBuilder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static GlobalOrdinalsBuilder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GlobalOrdinalsBuilder c : GlobalOrdinalsBuilder.values())
    System.out.println(c);

Returns:

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

valueOf

public static GlobalOrdinalsBuilder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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,
                           Settings settings,
                           CircuitBreakerService breakerService,
                           ESLogger logger)
                                    throws IOException

Build global ordinals for the provided IndexReader.

Throws:

IOException

buildEmpty

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

Throws:

IOException