org.apache.nifi.serialization.record

Enum RecordFieldType

java.lang.Object

java.lang.Enum<RecordFieldType>

org.apache.nifi.serialization.record.RecordFieldType

All Implemented Interfaces:

Serializable, Comparable<RecordFieldType>

public enum RecordFieldType
extends Enum<RecordFieldType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY An array field type.
BIGINT A bigint field type.
BOOLEAN A boolean field type.
BYTE A byte field type.
CHAR A char field type.
CHOICE A choice field type.
DATE A date field type.
DECIMAL A decimal field type.
DOUBLE A double field type.
ENUM An Enum field type.
FLOAT A float field type.
INT An int field type.
LONG A long field type.
MAP A record field type.
RECORD A record field type.
SHORT A short field type.
STRING A String field type.
TIME A time field type.
TIMESTAMP A timestamp field type.

Field Summary

Fields

Modifier and Type	Field and Description
private DataType	defaultDataType
private String	defaultFormat
private Set<RecordFieldType>	narrowDataTypes
private static Map<String,RecordFieldType>	SIMPLE_NAME_MAP
private String	simpleName

Method Summary

Modifier and Type	Method and Description
DataType	getArrayDataType(DataType elementType) Returns a Data Type that represents an "ARRAY" type with the given element type.
DataType	getArrayDataType(DataType elementType, boolean elementsNullable) Returns a Data Type that represents an "ARRAY" type with the given element type.
DataType	getChoiceDataType(DataType... possibleChildTypes) Returns a Data Type that represents a "CHOICE" of multiple possible types.
DataType	getChoiceDataType(List<DataType> possibleChildTypes) Returns a Data Type that represents a "CHOICE" of multiple possible types.
DataType	getDataType()
DataType	getDataType(String format)
DataType	getDecimalDataType(int precision, int scale) Returns a Data Type that represents a decimal type with the given precision and scale.
String	getDefaultFormat()
DataType	getEnumDataType(List<String> enums)
DataType	getMapDataType(DataType valueDataType) Returns a Data Type that represents a "MAP" type with the given value type.
DataType	getMapDataType(DataType valueDataType, boolean valuesNullable) Returns a Data Type that represents a "MAP" type with the given value type.
Set<RecordFieldType>	getNarrowDataTypes()
DataType	getRecordDataType(RecordSchema childSchema) Returns a Data Type that represents a "RECORD" or "ARRAY" type with the given schema.
DataType	getRecordDataType(Supplier<RecordSchema> childSchemaSupplier) Returns a Data Type that represents a "RECORD" or "ARRAY" type with the given schema which will be lazily evaluated later.
boolean	isWiderThan(RecordFieldType fieldType) Determines whether or this this RecordFieldType is "wider" than the provided type.
static RecordFieldType	of(String typeString)
static RecordFieldType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordFieldType[]	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

Enum Constant Detail

BOOLEAN

public static final RecordFieldType BOOLEAN

A boolean field type. Fields of this type use a boolean value.

BYTE

public static final RecordFieldType BYTE

A byte field type. Fields of this type use a byte value.

SHORT

public static final RecordFieldType SHORT

A short field type. Fields of this type use a short value.

INT

public static final RecordFieldType INT

An int field type. Fields of this type use an int value.

LONG

public static final RecordFieldType LONG

A long field type. Fields of this type use a long value.

BIGINT

public static final RecordFieldType BIGINT

A bigint field type. Fields of this type use a java.math.BigInteger value.

FLOAT

public static final RecordFieldType FLOAT

A float field type. Fields of this type use a float value.

DOUBLE

public static final RecordFieldType DOUBLE

A double field type. Fields of this type use a double value.

DECIMAL

public static final RecordFieldType DECIMAL

A decimal field type. Fields of this type use a java.math.BigDecimal value.

TIMESTAMP

public static final RecordFieldType TIMESTAMP

A timestamp field type. Fields of this type use a java.sql.Timestamp value.

DATE

public static final RecordFieldType DATE

A date field type. Fields of this type use a java.sql.Date value.

TIME

public static final RecordFieldType TIME

A time field type. Fields of this type use a java.sql.Time value.

CHAR

public static final RecordFieldType CHAR

A char field type. Fields of this type use a char value.

ENUM

public static final RecordFieldType ENUM

An Enum field type.

STRING

public static final RecordFieldType STRING

A String field type. Fields of this type use a java.lang.String value.

RECORD

public static final RecordFieldType RECORD

A record field type. Fields of this type use a org.apache.nifi.serialization.record.Record value. A Record DataType should be created by providing the RecordSchema for the record:

final DataType recordType = RecordFieldType.RECORD.getRecordDataType(recordSchema);

A field of type RECORD should always have a RecordDataType, so the following idiom is acceptable for use:

 final DataType dataType = ...;
 if (dataType.getFieldType() == RecordFieldType.RECORD) {
     final RecordDataType recordDataType = (RecordDataType) dataType;
     final RecordSchema childSchema = recordDataType.getChildSchema();
     ...
 }
 

CHOICE

public static final RecordFieldType CHOICE

A choice field type. A field of type choice can be one of any number of different types, which are defined by the DataType that is used. For example, if a field should allow either a Long or an Integer, this can be accomplished by using:

final DataType choiceType = RecordFieldType.CHOICE.getChoiceDataType( RecordFieldType.INT.getDataType(), RecordFieldType.LONG.getDataType() );

A field of type CHOICE should always have a ChoiceDataType, so the following idiom is acceptable for use:

 final DataType dataType = ...;
 if (dataType.getFieldType() == RecordFieldType.CHOICE) {
     final ChoiceDataType choiceDataType = (ChoiceDataType) dataType;
     final List<DataType> allowableTypes = choiceDataType.getPossibleSubTypes();
     ...
 }
 

ARRAY

public static final RecordFieldType ARRAY

An array field type. Fields of this type use a Object[] value. Note that we are explicitly indicating that Object[] should be used here and not primitive array types. For instance, setting a value of int[] is not allowed. The DataType for this field should be created using the getArrayDataType(DataType) method:

final DataType arrayType = RecordFieldType.ARRAY.getArrayDataType( RecordFieldType.INT.getDataType() );

A field of type ARRAY should always have an ArrayDataType, so the following idiom is acceptable for use:

 final DataType dataType = ...;
 if (dataType.getFieldType() == RecordFieldType.ARRAY) {
     final ArrayDataType arrayDataType = (ArrayDataType) dataType;
     final DataType elementType = arrayDataType.getElementType();
     ...
 }
 

MAP

public static final RecordFieldType MAP

A record field type. Fields of this type use a Map<String, Object> value. A Map DataType should be created by providing the DataType for the values:

final DataType recordType = RecordFieldType.MAP.getRecordDataType( RecordFieldType.STRING.getDataType() );

A field of type MAP should always have a MapDataType, so the following idiom is acceptable for use:

 final DataType dataType = ...;
 if (dataType.getFieldType() == RecordFieldType.MAP) {
     final MapDataType mapDataType = (MapDataType) dataType;
     final DataType valueType = mapDataType.getValueType();
     ...
 }
 

Field Detail

SIMPLE_NAME_MAP

private static final Map<String,RecordFieldType> SIMPLE_NAME_MAP

simpleName

private final String simpleName

defaultFormat

private final String defaultFormat

defaultDataType

private final DataType defaultDataType

narrowDataTypes

private final Set<RecordFieldType> narrowDataTypes

Method Detail

values

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

Returns:

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

valueOf

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

getDefaultFormat

public String getDefaultFormat()

getDataType

public DataType getDataType()

Returns:

the DataType with the default format

getDataType

public DataType getDataType(String format)

getRecordDataType

public DataType getRecordDataType(RecordSchema childSchema)

Returns a Data Type that represents a "RECORD" or "ARRAY" type with the given schema.

Parameters:

childSchema - the Schema for the Record or Array

Returns:

a DataType that represents a Record or Array with the given schema, or null if this RecordFieldType is not the RECORD or ARRAY type.

getRecordDataType

public DataType getRecordDataType(Supplier<RecordSchema> childSchemaSupplier)

Returns a Data Type that represents a "RECORD" or "ARRAY" type with the given schema which will be lazily evaluated later. This method can be used to define a DataType containing recursive type structure.

Parameters:

childSchemaSupplier - the Schema for the Record or Array, the child schema will be evaluated when it is accessed at the first time

Returns:

a DataType that represents a Record or Array with the given schema, or null if this RecordFieldType is not the RECORD or ARRAY type.

getArrayDataType

public DataType getArrayDataType(DataType elementType)

Returns a Data Type that represents an "ARRAY" type with the given element type. The returned array data type can't contain null elements.

Parameters:

elementType - the type of the arrays in the element

Returns:

a DataType that represents an Array with the given element type, or null if this RecordFieldType is not the ARRAY type.

getArrayDataType

public DataType getArrayDataType(DataType elementType,
                                 boolean elementsNullable)

Returns a Data Type that represents an "ARRAY" type with the given element type.

Parameters:

elementType - the type of the arrays in the element

elementsNullable - indicates whether the array can contain null elements

Returns:

a DataType that represents an Array with the given element type, or null if this RecordFieldType is not the ARRAY type.

getEnumDataType

public DataType getEnumDataType(List<String> enums)

getChoiceDataType

public DataType getChoiceDataType(List<DataType> possibleChildTypes)

Returns a Data Type that represents a "CHOICE" of multiple possible types. This method is only applicable for a RecordFieldType of CHOICE.

Parameters:

possibleChildTypes - the possible types that are allowable

Returns:

a DataType that represents a "CHOICE" of multiple possible types, or null if this RecordFieldType is not the CHOICE type.

getChoiceDataType

public DataType getChoiceDataType(DataType... possibleChildTypes)

Returns a Data Type that represents a "CHOICE" of multiple possible types. This method is only applicable for a RecordFieldType of CHOICE.

Parameters:

possibleChildTypes - the possible types that are allowable

Returns:

a DataType that represents a "CHOICE" of multiple possible types, or null if this RecordFieldType is not the CHOICE type.

getMapDataType

public DataType getMapDataType(DataType valueDataType)

Returns a Data Type that represents a "MAP" type with the given value type. The returned map data type can't contain null values.

Parameters:

valueDataType - the type of the values in the map

Returns:

a DataType that represents a Map with the given value type, or null if this RecordFieldType is not the MAP type.

getMapDataType

public DataType getMapDataType(DataType valueDataType,
                               boolean valuesNullable)

Returns a Data Type that represents a "MAP" type with the given value type.

Parameters:

valueDataType - the type of the values in the map

valuesNullable - indicates whether the map can contain null values

Returns:

a DataType that represents a Map with the given value type, or null if this RecordFieldType is not the MAP type.

getDecimalDataType

public DataType getDecimalDataType(int precision,
                                   int scale)

Returns a Data Type that represents a decimal type with the given precision and scale.

Parameters:

precision - the precision of the decimal

scale - the scale of the decimal

Returns:

a DataType that represents a decimal with added information about it's precision and scale.

isWiderThan

public boolean isWiderThan(RecordFieldType fieldType)

Determines whether or this this RecordFieldType is "wider" than the provided type. A type "A" is said to be wider than another type "B" iff A encompasses all values of B and more. For example, the LONG type is wider than INT, and INT is wider than SHORT. "Complex" types (MAP, RECORD, ARRAY, CHOICE) are not wider than any other type, and no other type is wider than a complex type. The STRING type is wider than all types with the exception of complex types.

Parameters:

fieldType - the type to compare against

Returns:

true if this is wider than the provided type, false otherwise.

of

public static RecordFieldType of(String typeString)

getNarrowDataTypes

public Set<RecordFieldType> getNarrowDataTypes()