GenericVariant (Paimon : 1.2-SNAPSHOT API)

java.lang.Object
- org.apache.paimon.data.variant.GenericVariant

All Implemented Interfaces:

Variant
```
public final class GenericVariant
extends Object
implements Variant
```
An internal data structure implementing Variant.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GenericVariant.ObjectField
Variant object field.

Nested Classes
Modifier and Type	Class and Description
`static class`	`GenericVariant.ObjectField` Variant object field.

Field Summary
- Fields inherited from interface org.apache.paimon.data.variant.Variant
  METADATA, VALUE

Constructor Summary

Constructors
Constructor and Description

GenericVariant(byte[] value, byte[] metadata)

Constructors
Constructor and Description
`GenericVariant(byte[] value, byte[] metadata)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`arraySize()`
`Variant`	`copy()` Returns a copy of the variant.
`boolean`	`equals(Object o)`
`static Variant`	`fromJson(String json)`
`byte[]`	`getBinary()`
`boolean`	`getBoolean()`
`BigDecimal`	`getDecimal()`
`int`	`getDictionaryIdAtIndex(int index)`
`double`	`getDouble()`
`GenericVariant`	`getElementAtIndex(int index)`
`GenericVariant.ObjectField`	`getFieldAtIndex(int index)`
`GenericVariant`	`getFieldByKey(String key)`
`float`	`getFloat()`
`long`	`getLong()`
`String`	`getString()`
`GenericVariantUtil.Type`	`getType()`
`int`	`getTypeInfo()`
`int`	`hashCode()`
`byte[]`	`metadata()` Returns the variant metadata.
`int`	`objectSize()`
`int`	`pos()`
`byte[]`	`rawValue()`
`long`	`sizeInBytes()` Returns the size of the variant in bytes.
`String`	`toJson()` Parses the variant to json.
`String`	`toJson(java.time.ZoneId zoneId)`
`String`	`toString()`
`byte[]`	`value()` Returns the variant value.
`Object`	`variantGet(String path)` Extracts a sub-variant value according to a path which start with a `$`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GenericVariant
```
public GenericVariant(byte[] value,
                      byte[] metadata)
```
- Method Detail
  - value
```
public byte[] value()
```
    Description copied from interface: Variant
    
    Returns the variant value.
    
    Specified by:
    
    value in interface Variant
  - rawValue
```
public byte[] rawValue()
```
  - metadata
```
public byte[] metadata()
```
    Description copied from interface: Variant
    
    Returns the variant metadata.
    
    Specified by:
    
    metadata in interface Variant
  - pos
```
public int pos()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - fromJson
```
public static Variant fromJson(String json)
```
  - toJson
```
public String toJson()
```
    Description copied from interface: Variant
    
    Parses the variant to json.
    
    Specified by:
    
    toJson in interface Variant
  - toJson
```
public String toJson(java.time.ZoneId zoneId)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - variantGet
```
public Object variantGet(String path)
```
    Description copied from interface: Variant
    
    Extracts a sub-variant value according to a path which start with a `$`. e.g.
    access object's field: `$.key` or `$['key']` or `$["key"]`.
    access array's first elem: `$.array[0]`
    
    Specified by:
    
    variantGet in interface Variant
  - sizeInBytes
```
public long sizeInBytes()
```
    Description copied from interface: Variant
    
    Returns the size of the variant in bytes.
    
    Specified by:
    
    sizeInBytes in interface Variant
  - copy
```
public Variant copy()
```
    Description copied from interface: Variant
    
    Returns a copy of the variant.
    
    Specified by:
    
    copy in interface Variant
  - getBoolean
```
public boolean getBoolean()
```
  - getLong
```
public long getLong()
```
  - getDouble
```
public double getDouble()
```
  - getDecimal
```
public BigDecimal getDecimal()
```
  - getFloat
```
public float getFloat()
```
  - getBinary
```
public byte[] getBinary()
```
  - getString
```
public String getString()
```
  - getTypeInfo
```
public int getTypeInfo()
```
  - getType
```
public GenericVariantUtil.Type getType()
```
  - objectSize
```
public int objectSize()
```
  - getFieldByKey
```
public GenericVariant getFieldByKey(String key)
```
  - getFieldAtIndex
```
public GenericVariant.ObjectField getFieldAtIndex(int index)
```
  - getDictionaryIdAtIndex
```
public int getDictionaryIdAtIndex(int index)
```
  - arraySize
```
public int arraySize()
```
  - getElementAtIndex
```
public GenericVariant getElementAtIndex(int index)
```

Back to Paimon Website

Class GenericVariant

Nested Class Summary

Field Summary

Fields inherited from interface org.apache.paimon.data.variant.Variant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenericVariant

Method Detail

value

rawValue

metadata

pos

equals

hashCode

fromJson

toJson

toJson

toString

variantGet

sizeInBytes

copy

getBoolean

getLong

getDouble

getDecimal

getFloat

getBinary

getString

getTypeInfo

getType

objectSize

getFieldByKey

getFieldAtIndex

getDictionaryIdAtIndex

arraySize

getElementAtIndex

Back to Paimon Website