org.apache.beam.sdk.schemas.logicaltypes

Class EnumerationType

java.lang.Object

org.apache.beam.sdk.schemas.logicaltypes.EnumerationType

All Implemented Interfaces:

java.io.Serializable, Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

@Experimental(value=SCHEMAS)
public class EnumerationType
extends java.lang.Object
implements Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

This Schema.LogicalType represent an enumeration over a fixed set of values.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnumerationType.Value This class represents a single enum value.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IDENTIFIER

Method Summary

Modifier and Type	Method and Description
static EnumerationType	create(java.util.List<java.lang.String> enumValues) Create an enumeration type from a fixed set of String values; integer values will be automatically chosen.
static EnumerationType	create(java.util.Map<java.lang.String,java.lang.Integer> enumValues) Create an enumeration type over a set of String->Integer values.
static EnumerationType	create(java.lang.String... enumValues) Create an enumeration type from a fixed set of String values; integer values will be automatically chosen.
java.util.Map<java.lang.String,java.lang.Integer>	getArgument() An optional argument to configure the type.
Schema.FieldType	getArgumentType() A schema type representing how to interpret the argument.
Schema.FieldType	getBaseType() The base Schema.FieldType used to store values of this type.
java.lang.String	getIdentifier() The unique identifier for this type.
java.util.List<java.lang.String>	getValues()
java.util.Map<java.lang.String,java.lang.Integer>	getValuesMap()
java.lang.Integer	toBaseType(EnumerationType.Value input) Convert the input type to the type Java type used by the base Schema.FieldType.
EnumerationType.Value	toInputType(java.lang.Integer base) Convert the Java type used by the base Schema.FieldType to the input type.
java.lang.String	toString()
java.lang.String	toString(EnumerationType.Value value)
EnumerationType.Value	valueOf(int value) Return an EnumerationType.Value corresponding to one of the enumeration integer values.
EnumerationType.Value	valueOf(java.lang.String stringValue) Return an EnumerationType.Value corresponding to one of the enumeration strings.

Methods inherited from class java.lang.Object

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

Field Detail

IDENTIFIER

public static final java.lang.String IDENTIFIER

See Also:

Constant Field Values

Method Detail

create

public static EnumerationType create(java.util.Map<java.lang.String,java.lang.Integer> enumValues)

Create an enumeration type over a set of String->Integer values.

create

public static EnumerationType create(java.util.List<java.lang.String> enumValues)

Create an enumeration type from a fixed set of String values; integer values will be automatically chosen.

create

public static EnumerationType create(java.lang.String... enumValues)

Create an enumeration type from a fixed set of String values; integer values will be automatically chosen.

valueOf

public EnumerationType.Value valueOf(java.lang.String stringValue)

Return an EnumerationType.Value corresponding to one of the enumeration strings.

valueOf

public EnumerationType.Value valueOf(int value)

Return an EnumerationType.Value corresponding to one of the enumeration integer values.

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: Schema.LogicalType

The unique identifier for this type.

Specified by:

getIdentifier in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

getArgumentType

public Schema.FieldType getArgumentType()

Description copied from interface: Schema.LogicalType

A schema type representing how to interpret the argument. null indicates this logical type is not parameterized by an argument.

Specified by:

getArgumentType in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

getArgument

public java.util.Map<java.lang.String,java.lang.Integer> getArgument()

Description copied from interface: Schema.LogicalType

An optional argument to configure the type.

Specified by:

getArgument in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

getBaseType

public Schema.FieldType getBaseType()

Description copied from interface: Schema.LogicalType

The base Schema.FieldType used to store values of this type.

Specified by:

getBaseType in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

toBaseType

public java.lang.Integer toBaseType(EnumerationType.Value input)

Description copied from interface: Schema.LogicalType

Convert the input type to the type Java type used by the base Schema.FieldType.

Specified by:

toBaseType in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

toInputType

public EnumerationType.Value toInputType(java.lang.Integer base)

Description copied from interface: Schema.LogicalType

Convert the Java type used by the base Schema.FieldType to the input type.

Specified by:

toInputType in interface Schema.LogicalType<EnumerationType.Value,java.lang.Integer>

getValuesMap

public java.util.Map<java.lang.String,java.lang.Integer> getValuesMap()

getValues

public java.util.List<java.lang.String> getValues()

toString

public java.lang.String toString(EnumerationType.Value value)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object