Package org.apache.druid.data.input.impl.systemfield

Enum SystemField

java.lang.Object

java.lang.Enum<SystemField>

org.apache.druid.data.input.impl.systemfield.SystemField

All Implemented Interfaces:

Serializable, Comparable<SystemField>

public enum SystemField
extends Enum<SystemField>

System fields that can appear when reading data. These are generated by the system itself, rather than actually being present in the data being scanned. Currently these are only used by SystemFieldInputSource, and are therefore part of the package that contains things related to InputSource. Perhaps, in the future, system fields may be generated from segment scans as well (for example "__segment_id" returning the SegmentId). At that point this enum may move to a more central location.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUCKET
PATH
URI

Method Summary

Modifier and Type	Method	Description
static SystemField	fromFieldName(String fieldName)
ColumnType	getColumnType()	Type of this system field.
String	getFieldName()	Name of this system field.
String	toString()
static SystemField	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SystemField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

URI

public static final SystemField URI

BUCKET

public static final SystemField BUCKET

PATH

public static final SystemField PATH

Method Detail

values

public static SystemField[] 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 (SystemField c : SystemField.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemField 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

fromFieldName

public static SystemField fromFieldName(String fieldName)

getFieldName

public String getFieldName()

Name of this system field.

getColumnType

public ColumnType getColumnType()

Type of this system field.

toString

public String toString()

Overrides:

toString in class Enum<SystemField>