GenericVariantUtil (Paimon : 1.1-SNAPSHOT API)

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

```
public class GenericVariantUtil
extends Object
```
This class defines constants related to the variant format and provides functions for manipulating variant binaries.
A variant is made up of 2 binaries: value and metadata. A variant value consists of a one-byte header and a number of content bytes (can be zero). The header byte is divided into upper 6 bits (called "type info") and lower 2 bits (called "basic type"). The content format is explained in the below constants for all possible basic type and type info values.
The variant metadata includes a version id and a dictionary of distinct strings (case-sensitive). Its binary format is: - Version: 1-byte unsigned integer. The only acceptable value is 1 currently. - Dictionary size: 4-byte little-endian unsigned integer. The number of keys in the dictionary. - Offsets: (size + 1) * 4-byte little-endian unsigned integers. `offsets[i]` represents the starting position of string i, counting starting from the address of `offsets[0]`. Strings must be stored contiguously, so we don’t need to store the string size, instead, we compute it with `offset[i + 1] - offset[i]`. - UTF-8 string data.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GenericVariantUtil.ArrayHandler<T>` 1.
`static interface`	`GenericVariantUtil.ObjectHandler<T>` 1.
`static class`	`GenericVariantUtil.Type` The value type of variant value.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ARRAY`
`static int`	`BASIC_TYPE_BITS`
`static int`	`BASIC_TYPE_MASK`
`static int`	`BINARY`
`static int`	`BINARY_SEARCH_THRESHOLD`
`static int`	`DATE`
`static int`	`DECIMAL16`
`static int`	`DECIMAL4`
`static int`	`DECIMAL8`
`static int`	`DOUBLE`
`static int`	`FALSE`
`static int`	`FLOAT`
`static int`	`INT1`
`static int`	`INT2`
`static int`	`INT4`
`static int`	`INT8`
`static int`	`LONG_STR`
`static int`	`MAX_DECIMAL16_PRECISION`
`static int`	`MAX_DECIMAL4_PRECISION`
`static int`	`MAX_DECIMAL8_PRECISION`
`static int`	`MAX_SHORT_STR_SIZE`
`static int`	`NULL`
`static int`	`OBJECT`
`static int`	`PRIMITIVE`
`static int`	`SHORT_STR`
`static int`	`SIZE_LIMIT`
`static int`	`TIMESTAMP`
`static int`	`TIMESTAMP_NTZ`
`static int`	`TRUE`
`static int`	`TYPE_INFO_MASK`
`static int`	`U16_MAX`
`static int`	`U24_MAX`
`static int`	`U24_SIZE`
`static int`	`U32_SIZE`
`static int`	`U8_MAX`
`static byte`	`VERSION`
`static byte`	`VERSION_MASK`

Constructor Summary

Constructors
Constructor and Description

GenericVariantUtil()

Constructors
Constructor and Description
`GenericVariantUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static byte`	`arrayHeader(boolean largeSize, int offsetSize)`
`static byte[]`	`getBinary(byte[] value, int pos)`
`static boolean`	`getBoolean(byte[] value, int pos)`
`static BigDecimal`	`getDecimal(byte[] value, int pos)`
`static BigDecimal`	`getDecimalWithOriginalScale(byte[] value, int pos)`
`static double`	`getDouble(byte[] value, int pos)`
`static float`	`getFloat(byte[] value, int pos)`
`static long`	`getLong(byte[] value, int pos)`
`static String`	`getMetadataKey(byte[] metadata, int id)`
`static String`	`getString(byte[] value, int pos)`
`static GenericVariantUtil.Type`	`getType(byte[] value, int pos)`
`static int`	`getTypeInfo(byte[] value, int pos)`
`static <T> T`	`handleArray(byte[] value, int pos, GenericVariantUtil.ArrayHandler<T> handler)`
`static <T> T`	`handleObject(byte[] value, int pos, GenericVariantUtil.ObjectHandler<T> handler)`
`static byte`	`objectHeader(boolean largeSize, int idSize, int offsetSize)`
`static byte`	`primitiveHeader(int type)`
`static byte`	`shortStrHeader(int size)`
`static int`	`valueSize(byte[] value, int pos)`
`static void`	`writeLong(byte[] bytes, int pos, long value, int numBytes)`

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

Field Detail
- BASIC_TYPE_BITS
```
public static final int BASIC_TYPE_BITS
```
  See Also:
  
  Constant Field Values
- BASIC_TYPE_MASK
```
public static final int BASIC_TYPE_MASK
```
  See Also:
  
  Constant Field Values
- TYPE_INFO_MASK
```
public static final int TYPE_INFO_MASK
```
  See Also:
  
  Constant Field Values
- MAX_SHORT_STR_SIZE
```
public static final int MAX_SHORT_STR_SIZE
```
  See Also:
  
  Constant Field Values
- PRIMITIVE
```
public static final int PRIMITIVE
```
  See Also:
  
  Constant Field Values
- SHORT_STR
```
public static final int SHORT_STR
```
  See Also:
  
  Constant Field Values
- OBJECT
```
public static final int OBJECT
```
  See Also:
  
  Constant Field Values
- ARRAY
```
public static final int ARRAY
```
  See Also:
  
  Constant Field Values
- NULL
```
public static final int NULL
```
  See Also:
  
  Constant Field Values
- TRUE
```
public static final int TRUE
```
  See Also:
  
  Constant Field Values
- FALSE
```
public static final int FALSE
```
  See Also:
  
  Constant Field Values
- INT1
```
public static final int INT1
```
  See Also:
  
  Constant Field Values
- INT2
```
public static final int INT2
```
  See Also:
  
  Constant Field Values
- INT4
```
public static final int INT4
```
  See Also:
  
  Constant Field Values
- INT8
```
public static final int INT8
```
  See Also:
  
  Constant Field Values
- DOUBLE
```
public static final int DOUBLE
```
  See Also:
  
  Constant Field Values
- DECIMAL4
```
public static final int DECIMAL4
```
  See Also:
  
  Constant Field Values
- DECIMAL8
```
public static final int DECIMAL8
```
  See Also:
  
  Constant Field Values
- DECIMAL16
```
public static final int DECIMAL16
```
  See Also:
  
  Constant Field Values
- DATE
```
public static final int DATE
```
  See Also:
  
  Constant Field Values
- TIMESTAMP
```
public static final int TIMESTAMP
```
  See Also:
  
  Constant Field Values
- TIMESTAMP_NTZ
```
public static final int TIMESTAMP_NTZ
```
  See Also:
  
  Constant Field Values
- FLOAT
```
public static final int FLOAT
```
  See Also:
  
  Constant Field Values
- BINARY
```
public static final int BINARY
```
  See Also:
  
  Constant Field Values
- LONG_STR
```
public static final int LONG_STR
```
  See Also:
  
  Constant Field Values
- VERSION
```
public static final byte VERSION
```
  See Also:
  
  Constant Field Values
- VERSION_MASK
```
public static final byte VERSION_MASK
```
  See Also:
  
  Constant Field Values
- U8_MAX
```
public static final int U8_MAX
```
  See Also:
  
  Constant Field Values
- U16_MAX
```
public static final int U16_MAX
```
  See Also:
  
  Constant Field Values
- U24_MAX
```
public static final int U24_MAX
```
  See Also:
  
  Constant Field Values
- U24_SIZE
```
public static final int U24_SIZE
```
  See Also:
  
  Constant Field Values
- U32_SIZE
```
public static final int U32_SIZE
```
  See Also:
  
  Constant Field Values
- SIZE_LIMIT
```
public static final int SIZE_LIMIT
```
  See Also:
  
  Constant Field Values
- MAX_DECIMAL4_PRECISION
```
public static final int MAX_DECIMAL4_PRECISION
```
  See Also:
  
  Constant Field Values
- MAX_DECIMAL8_PRECISION
```
public static final int MAX_DECIMAL8_PRECISION
```
  See Also:
  
  Constant Field Values
- MAX_DECIMAL16_PRECISION
```
public static final int MAX_DECIMAL16_PRECISION
```
  See Also:
  
  Constant Field Values
- BINARY_SEARCH_THRESHOLD
```
public static final int BINARY_SEARCH_THRESHOLD
```
  See Also:
  
  Constant Field Values

Constructor Detail
- GenericVariantUtil
```
public GenericVariantUtil()
```

Method Detail

writeLong

public static void writeLong(byte[] bytes,
                             int pos,
                             long value,
                             int numBytes)

primitiveHeader

public static byte primitiveHeader(int type)

shortStrHeader

public static byte shortStrHeader(int size)

objectHeader

public static byte objectHeader(boolean largeSize,
                                int idSize,
                                int offsetSize)

arrayHeader

public static byte arrayHeader(boolean largeSize,
                               int offsetSize)

getTypeInfo

public static int getTypeInfo(byte[] value,
                              int pos)

getType

public static GenericVariantUtil.Type getType(byte[] value,
                                              int pos)

valueSize

public static int valueSize(byte[] value,
                            int pos)

getBoolean

public static boolean getBoolean(byte[] value,
                                 int pos)

getLong

public static long getLong(byte[] value,
                           int pos)

getDouble

public static double getDouble(byte[] value,
                               int pos)

getDecimalWithOriginalScale

public static BigDecimal getDecimalWithOriginalScale(byte[] value,
                                                     int pos)

getDecimal

public static BigDecimal getDecimal(byte[] value,
                                    int pos)

getFloat

public static float getFloat(byte[] value,
                             int pos)

getBinary

public static byte[] getBinary(byte[] value,
                               int pos)

getString

public static String getString(byte[] value,
                               int pos)

handleObject

public static <T> T handleObject(byte[] value,
                                 int pos,
                                 GenericVariantUtil.ObjectHandler<T> handler)

handleArray

public static <T> T handleArray(byte[] value,
                                int pos,
                                GenericVariantUtil.ArrayHandler<T> handler)

getMetadataKey

public static String getMetadataKey(byte[] metadata,
                                    int id)

Back to Paimon Website

Class GenericVariantUtil

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BASIC_TYPE_BITS

BASIC_TYPE_MASK

TYPE_INFO_MASK

MAX_SHORT_STR_SIZE

PRIMITIVE

SHORT_STR

OBJECT

ARRAY

NULL

TRUE

FALSE

INT1

INT2

INT4

INT8

DOUBLE

DECIMAL4

DECIMAL8

DECIMAL16

DATE

TIMESTAMP

TIMESTAMP_NTZ

FLOAT

BINARY

LONG_STR

VERSION

VERSION_MASK

U8_MAX

U16_MAX

U24_MAX

U24_SIZE

U32_SIZE

SIZE_LIMIT

MAX_DECIMAL4_PRECISION

MAX_DECIMAL8_PRECISION

MAX_DECIMAL16_PRECISION

BINARY_SEARCH_THRESHOLD

Constructor Detail

GenericVariantUtil

Method Detail

writeLong

primitiveHeader

shortStrHeader

objectHeader

arrayHeader

getTypeInfo

getType

valueSize

getBoolean

getLong

getDouble

getDecimalWithOriginalScale

getDecimal

getFloat

getBinary

getString

handleObject

handleArray

getMetadataKey

Back to Paimon Website