Package org.apache.flink.types.variant

Class BinaryVariant

java.lang.Object

org.apache.flink.types.variant.BinaryVariant

All Implemented Interfaces:

Variant

@Internal
public final class BinaryVariant
extends Object
implements Variant

A data structure that represents a semi-structured value. It consists of two binary values: value and metadata. The value encodes types and values, but not field names. The metadata currently contains a version flag and a list of field names. We can extend/modify the detailed binary format given the version flag.

See Also:

Variant Binary Encoding for the detail layout of the data structure.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.types.variant.Variant

Variant.Type

Constructor Summary

Constructors

Constructor	Description
BinaryVariant(byte[] value, byte[] metadata)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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.
byte[]	getMetadata()
int	getPos()
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.
byte[]	getValue()
int	hashCode()
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.
String	toJson()	Parses the variant to json.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BinaryVariant

public BinaryVariant(byte[] value,
                     byte[] metadata)

Method Detail

isPrimitive

public boolean isPrimitive()

Description copied from interface: Variant

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

Specified by:

isPrimitive in interface Variant

isArray

public boolean isArray()

Description copied from interface: Variant

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

Specified by:

isArray in interface Variant

isObject

public boolean isObject()

Description copied from interface: Variant

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

Specified by:

isObject in interface Variant

isNull

public boolean isNull()

Description copied from interface: Variant

Check If this variant is null.

Specified by:

isNull in interface Variant

getType

public Variant.Type getType()

Description copied from interface: Variant

Get the type of variant.

Specified by:

getType in interface Variant

getBoolean

public boolean getBoolean()
                   throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getBoolean in interface Variant

Throws:

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

getByte

public byte getByte()
             throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getByte in interface Variant

Throws:

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

getShort

public short getShort()
               throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getShort in interface Variant

Throws:

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

getInt

public int getInt()
           throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getInt in interface Variant

Throws:

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

getLong

public long getLong()
             throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getLong in interface Variant

Throws:

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

getFloat

public float getFloat()
               throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getFloat in interface Variant

Throws:

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

getDecimal

public BigDecimal getDecimal()
                      throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getDecimal in interface Variant

Throws:

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

getDouble

public double getDouble()
                 throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getDouble in interface Variant

Throws:

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

getString

public String getString()
                 throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getString in interface Variant

Throws:

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

getDate

public LocalDate getDate()
                  throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getDate in interface Variant

Throws:

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

getDateTime

public LocalDateTime getDateTime()
                          throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getDateTime in interface Variant

Throws:

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

getInstant

public Instant getInstant()
                   throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getInstant in interface Variant

Throws:

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

getBytes

public byte[] getBytes()
                throws VariantTypeException

Description copied from interface: Variant

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

Specified by:

getBytes in interface Variant

Throws:

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

get

public Object get()
           throws VariantTypeException

Description copied from interface: Variant

Get the scalar value of variant.

Specified by:

get in interface Variant

Throws:

VariantTypeException - If this variant is not a scalar value.

getAs

public <T> T getAs()
            throws VariantTypeException

Description copied from interface: Variant

Get the scalar value of variant.

Specified by:

getAs in interface Variant

Throws:

VariantTypeException - If this variant is not a scalar value.

getElement

public Variant getElement(int index)
                   throws VariantTypeException

Description copied from interface: Variant

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 @Variant.isNull() returns true will be returned, not null.

Specified by:

getElement in interface Variant

Throws:

VariantTypeException - If this variant is not an array.

getField

public Variant getField(String fieldName)
                 throws VariantTypeException

Description copied from interface: Variant

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 @Variant.isNull() returns true will be returned, not null.

Specified by:

getField in interface Variant

Throws:

VariantTypeException - If this variant is not an object.

toJson

public String toJson()

Description copied from interface: Variant

Parses the variant to json.

Specified by:

toJson in interface Variant

getValue

public byte[] getValue()

getMetadata

public byte[] getMetadata()

getPos

public int getPos()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object