Package org.apache.flink.types.variant

Interface Variant

All Known Implementing Classes:

BinaryVariant

@PublicEvolving
public interface Variant

Variant represent a semi-structured data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Variant.Type	The type of variant.

Method Summary

Modifier and Type	Method	Description
Object	get()	Get the scalar value of variant.
<T> T	getAs()	Get the scalar value of variant.
boolean	getBoolean()	Get the scalar value of variant as boolean, if the variant type is Variant.Type.BOOLEAN.
byte	getByte()	Get the scalar value of variant as byte, if the variant type is Variant.Type.TINYINT.
byte[]	getBytes()	Get the scalar value of variant as byte array, if the variant type is Variant.Type.BYTES.
LocalDate	getDate()	Get the scalar value of variant as LocalDate, if the variant type is Variant.Type.DATE.
LocalDateTime	getDateTime()	Get the scalar value of variant as LocalDateTime, if the variant type is Variant.Type.TIMESTAMP.
BigDecimal	getDecimal()	Get the scalar value of variant as BigDecimal, if the variant type is Variant.Type.DECIMAL.
double	getDouble()	Get the scalar value of variant as double, if the variant type is Variant.Type.DOUBLE.
Variant	getElement(int index)	Access value of the specified element of an array variant.
Variant	getField(String fieldName)	Access value of the specified field of an object variant.
float	getFloat()	Get the scalar value of variant as float, if the variant type is Variant.Type.FLOAT.
Instant	getInstant()	Get the scalar value of variant as Instant, if the variant type is Variant.Type.TIMESTAMP.
int	getInt()	Get the scalar value of variant as int, if the variant type is Variant.Type.INT.
long	getLong()	Get the scalar value of variant as long, if the variant type is Variant.Type.BIGINT.
short	getShort()	Get the scalar value of variant as short, if the variant type is Variant.Type.SMALLINT.
String	getString()	Get the scalar value of variant as string, if the variant type is Variant.Type.STRING.
Variant.Type	getType()	Get the type of variant.
boolean	isArray()	Returns true if this variant is an Array, false otherwise.
boolean	isNull()	Check If this variant is null.
boolean	isObject()	Returns true if this variant is an Object, false otherwise.
boolean	isPrimitive()	Returns true if the variant is a primitive typed value, such as INT, DOUBLE, STRING, etc.
static VariantBuilder	newBuilder()
String	toJson()	Parses the variant to json.

Method Detail

isPrimitive

boolean isPrimitive()

Returns true if the variant is a primitive typed value, such as INT, DOUBLE, STRING, etc.

isArray

boolean isArray()

Returns true if this variant is an Array, false otherwise.

isObject

boolean isObject()

Returns true if this variant is an Object, false otherwise.

isNull

boolean isNull()

Check If this variant is null.

getType

Variant.Type getType()

Get the type of variant.

getBoolean

boolean getBoolean()
            throws VariantTypeException

Get the scalar value of variant as boolean, if the variant type is Variant.Type.BOOLEAN.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.BOOLEAN.

getByte

byte getByte()
      throws VariantTypeException

Get the scalar value of variant as byte, if the variant type is Variant.Type.TINYINT.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.TINYINT.

getShort

short getShort()
        throws VariantTypeException

Get the scalar value of variant as short, if the variant type is Variant.Type.SMALLINT.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.SMALLINT.

getInt

int getInt()
    throws VariantTypeException

Get the scalar value of variant as int, if the variant type is Variant.Type.INT.

Throws:

VariantTypeException - if this variant is not a scalar value or is not Variant.Type.INT.

getLong

long getLong()
      throws VariantTypeException

Get the scalar value of variant as long, if the variant type is Variant.Type.BIGINT.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.BIGINT.

getFloat

float getFloat()
        throws VariantTypeException

Get the scalar value of variant as float, if the variant type is Variant.Type.FLOAT.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.FLOAT.

getDecimal

BigDecimal getDecimal()
               throws VariantTypeException

Get the scalar value of variant as BigDecimal, if the variant type is Variant.Type.DECIMAL.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.DECIMAL.

getDouble

double getDouble()
          throws VariantTypeException

Get the scalar value of variant as double, if the variant type is Variant.Type.DOUBLE.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.DOUBLE.

getString

String getString()
          throws VariantTypeException

Get the scalar value of variant as string, if the variant type is Variant.Type.STRING.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.STRING.

getDate

LocalDate getDate()
           throws VariantTypeException

Get the scalar value of variant as LocalDate, if the variant type is Variant.Type.DATE.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.DATE.

getDateTime

LocalDateTime getDateTime()
                   throws VariantTypeException

Get the scalar value of variant as LocalDateTime, if the variant type is Variant.Type.TIMESTAMP.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.TIMESTAMP.

getInstant

Instant getInstant()
            throws VariantTypeException

Get the scalar value of variant as Instant, if the variant type is Variant.Type.TIMESTAMP.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.TIMESTAMP.

getBytes

byte[] getBytes()
         throws VariantTypeException

Get the scalar value of variant as byte array, if the variant type is Variant.Type.BYTES.

Throws:

VariantTypeException - If this variant is not a scalar value or is not Variant.Type.BYTES.

get

Object get()
    throws VariantTypeException

Get the scalar value of variant.

Throws:

VariantTypeException - If this variant is not a scalar value.

getAs

<T> T getAs()
     throws VariantTypeException

Get the scalar value of variant.

Throws:

VariantTypeException - If this variant is not a scalar value.

getElement

Variant getElement(int index)
            throws VariantTypeException

Access value of the specified element of an array variant. If index is out of range, null is returned.

NOTE: if the element value has been explicitly set as null (which is different from removal!), a variant that @isNull() returns true will be returned, not null.

Throws:

VariantTypeException - If this variant is not an array.

getField

Variant getField(String fieldName)
          throws VariantTypeException

Access value of the specified field of an object variant. If there is no field with the specified name, null is returned.

NOTE: if the property value has been explicitly set as null, a variant that @isNull() returns true will be returned, not null.

Throws:

VariantTypeException - If this variant is not an object.

toJson

String toJson()

Parses the variant to json.

newBuilder

static VariantBuilder newBuilder()