BinaryArrayData (flink-cdc-common 3.3.0 API)

java.lang.Object
- org.apache.flink.cdc.common.data.binary.BinarySection
- - org.apache.flink.cdc.common.data.binary.BinaryArrayData

所有已实现的接口:

ArrayData, BinaryFormat
```
public final class BinaryArrayData
extends BinarySection
implements ArrayData
```
A binary implementation of ArrayData which is backed by MemorySegments.
This class provides a way to store array data in a binary format that is compact and efficient. It uses MemorySegments to manage the binary representation of the data, allowing for efficient storage and access.
The binary layout of BinaryArrayData is structured as follows:
```
 [size(int)] + [null bits(4-byte word boundaries)] + [values or offset&length] + [variable length part].
 
```
- size: The first 4 bytes store the number of elements in the array.
- null bits: A bitmap to track null values, aligned to 4-byte word boundaries. Each bit represents whether an element is null.
- values or offset&length: The values of the array elements. For fixed-length primitive types, the values are stored directly. For variable-length types (e.g., strings, maps), this part stores the offset and length of the actual data in the variable length part.
- variable length part: This part of the memory segment stores the actual data for variable-length types (e.g., strings, maps).
The header size is calculated based on the number of elements in the array, ensuring efficient alignment and access.
For fields that hold fixed-length primitive types, such as long, double, or int, they are stored compactly in bytes, just like the original Java array.
The class also provides methods to convert the binary data back into Java primitive arrays, handling various types such as boolean, byte, short, int, long, float, and double.

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.flink.cdc.common.data.ArrayData
  ArrayData.ElementGetter

字段概要
- 从类继承的字段 org.apache.flink.cdc.common.data.binary.BinarySection
  offset, segments, sizeInBytes
- 从接口继承的字段 org.apache.flink.cdc.common.data.binary.BinaryFormat
  HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE

构造器概要

构造器
构造器和说明

BinaryArrayData()

构造器
构造器和说明
`BinaryArrayData()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`anyNull()`
`static int`	`calculateFixLengthPartSize(DataType type)` It store real value when type is primitive.
`static int`	`calculateHeaderInBytes(int numFields)` Calculates the size of the header in bytes for an array with the specified number of fields.
`BinaryArrayData`	`copy()`
`BinaryArrayData`	`copy(BinaryArrayData reuse)`
`static BinaryArrayData`	`fromPrimitiveArray(boolean[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(byte[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(double[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(float[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(int[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(long[] arr)`
`static BinaryArrayData`	`fromPrimitiveArray(short[] arr)`
`ArrayData`	`getArray(int pos)` Returns the array value at the given position.
`byte[]`	`getBinary(int pos)` Returns the binary value at the given position.
`boolean`	`getBoolean(int pos)` Returns the boolean value at the given position.
`byte`	`getByte(int pos)` Returns the byte value at the given position.
`DecimalData`	`getDecimal(int pos, int precision, int scale)` Returns the decimal value at the given position.
`double`	`getDouble(int pos)` Returns the double value at the given position.
`float`	`getFloat(int pos)` Returns the float value at the given position.
`int`	`getInt(int pos)` Returns the integer value at the given position.
`LocalZonedTimestampData`	`getLocalZonedTimestamp(int pos, int precision)` Returns the local zoned timestamp value at the given position.
`long`	`getLong(int pos)` Returns the long value at the given position.
`MapData`	`getMap(int pos)` Returns the map value at the given position.
`RecordData`	`getRecord(int pos, int numFields)` Returns the record value at the given position.
`short`	`getShort(int pos)` Returns the short value at the given position.
`StringData`	`getString(int pos)` Returns the string value at the given position.
`TimestampData`	`getTimestamp(int pos, int precision)` Returns the timestamp value at the given position.
`ZonedTimestampData`	`getZonedTimestamp(int pos, int precision)` Returns the zoned timestamp value at the given position.
`int`	`hashCode()`
`boolean`	`isNullAt(int pos)` Returns true if the element is null at the given position.
`void`	`pointTo(org.apache.flink.core.memory.MemorySegment[] segments, int offset, int sizeInBytes)`
`void`	`setBoolean(int pos, boolean value)`
`void`	`setByte(int pos, byte value)`
`void`	`setDecimal(int pos, DecimalData value, int precision)`
`void`	`setDouble(int pos, double value)`
`void`	`setFloat(int pos, float value)`
`void`	`setInt(int pos, int value)`
`void`	`setLong(int pos, long value)`
`void`	`setNotNullAt(int pos)`
`void`	`setNullAt(int pos)`
`void`	`setNullBoolean(int pos)`
`void`	`setNullByte(int pos)`
`void`	`setNullDouble(int pos)`
`void`	`setNullFloat(int pos)`
`void`	`setNullInt(int pos)`
`void`	`setNullLong(int pos)`
`void`	`setNullShort(int pos)`
`void`	`setShort(int pos, short value)`
`void`	`setTimestamp(int pos, TimestampData value, int precision)`
`int`	`size()` Returns the number of elements in this array.
`boolean[]`	`toBooleanArray()`
`byte[]`	`toByteArray()`
`double[]`	`toDoubleArray()`
`float[]`	`toFloatArray()`
`int[]`	`toIntArray()`
`long[]`	`toLongArray()`
`<T> T[]`	`toObjectArray(DataType elementType)`
`short[]`	`toShortArray()`

从类继承的方法 org.apache.flink.cdc.common.data.binary.BinarySection
equals, getOffset, getSegments, getSizeInBytes, pointTo

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.flink.cdc.common.data.ArrayData
createElementGetter

- 构造器详细资料
  - BinaryArrayData
```
public BinaryArrayData()
```
- 方法详细资料
  - calculateHeaderInBytes
```
public static int calculateHeaderInBytes(int numFields)
```
    Calculates the size of the header in bytes for an array with the specified number of fields.
    The header consists of:
    - 4 bytes to store the size of the array (number of elements).
    - A bitmap to track null values, where each bit represents whether an element is null. This bitmap is aligned to 4-byte word boundaries for efficient memory access and to facilitate the use of bitwise operations.
    The size of the bitmap is determined by the number of elements in the array:
    - Each element requires 1 bit in the bitmap.
    - The total number of bits is rounded up to the nearest multiple of 32 to ensure alignment to 4-byte word boundaries (i.e., a 32-bit integer).
    The formula for calculating the size of the header is:
```
   header size = 4 bytes (for array size) + ((numFields + 31) / 32) * 4 bytes (for null bitmap)
 
```
    参数:
    
    numFields - the number of elements in the array
    
    返回:
    
    the size of the header in bytes
  - calculateFixLengthPartSize
```
public static int calculateFixLengthPartSize(DataType type)
```
    It store real value when type is primitive. It store the length and offset of variable-length part when type is string, map, etc.
  - size
```
public int size()
```
    从接口复制的说明: ArrayData
    
    Returns the number of elements in this array.
    
    指定者:
    
    size 在接口中 ArrayData
  - pointTo
```
public void pointTo(org.apache.flink.core.memory.MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)
```
    覆盖:
    
    pointTo 在类中 BinarySection
  - isNullAt
```
public boolean isNullAt(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns true if the element is null at the given position.
    
    指定者:
    
    isNullAt 在接口中 ArrayData
  - setNullAt
```
public void setNullAt(int pos)
```
  - setNotNullAt
```
public void setNotNullAt(int pos)
```
  - getLong
```
public long getLong(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the long value at the given position.
    
    指定者:
    
    getLong 在接口中 ArrayData
  - setLong
```
public void setLong(int pos,
                    long value)
```
  - setNullLong
```
public void setNullLong(int pos)
```
  - getInt
```
public int getInt(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the integer value at the given position.
    
    指定者:
    
    getInt 在接口中 ArrayData
  - setInt
```
public void setInt(int pos,
                   int value)
```
  - setNullInt
```
public void setNullInt(int pos)
```
  - getString
```
public StringData getString(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the string value at the given position.
    
    指定者:
    
    getString 在接口中 ArrayData
  - getDecimal
```
public DecimalData getDecimal(int pos,
                              int precision,
                              int scale)
```
    从接口复制的说明: ArrayData
    
    Returns the decimal value at the given position.
    The precision and scale are required to determine whether the decimal value was stored in a compact representation (see DecimalData).
    
    指定者:
    
    getDecimal 在接口中 ArrayData
  - getTimestamp
```
public TimestampData getTimestamp(int pos,
                                  int precision)
```
    从接口复制的说明: ArrayData
    
    Returns the timestamp value at the given position.
    The precision is required to determine whether the timestamp value was stored in a compact representation (see TimestampData).
    
    指定者:
    
    getTimestamp 在接口中 ArrayData
  - getLocalZonedTimestamp
```
public LocalZonedTimestampData getLocalZonedTimestamp(int pos,
                                                      int precision)
```
    从接口复制的说明: ArrayData
    
    Returns the local zoned timestamp value at the given position.
    The precision is required to determine whether the timestamp value was stored in a compact representation (see LocalZonedTimestampData).
    
    指定者:
    
    getLocalZonedTimestamp 在接口中 ArrayData
  - getZonedTimestamp
```
public ZonedTimestampData getZonedTimestamp(int pos,
                                            int precision)
```
    从接口复制的说明: ArrayData
    
    Returns the zoned timestamp value at the given position.
    The precision is required to determine whether the timestamp value was stored in a compact representation (see ZonedTimestampData).
    
    指定者:
    
    getZonedTimestamp 在接口中 ArrayData
  - getBinary
```
public byte[] getBinary(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the binary value at the given position.
    
    指定者:
    
    getBinary 在接口中 ArrayData
  - getArray
```
public ArrayData getArray(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the array value at the given position.
    
    指定者:
    
    getArray 在接口中 ArrayData
  - getMap
```
public MapData getMap(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the map value at the given position.
    
    指定者:
    
    getMap 在接口中 ArrayData
  - getRecord
```
public RecordData getRecord(int pos,
                            int numFields)
```
    从接口复制的说明: ArrayData
    
    Returns the record value at the given position.
    The number of fields is required to correctly extract the row.
    
    指定者:
    
    getRecord 在接口中 ArrayData
  - getBoolean
```
public boolean getBoolean(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the boolean value at the given position.
    
    指定者:
    
    getBoolean 在接口中 ArrayData
  - setBoolean
```
public void setBoolean(int pos,
                       boolean value)
```
  - setNullBoolean
```
public void setNullBoolean(int pos)
```
  - getByte
```
public byte getByte(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the byte value at the given position.
    
    指定者:
    
    getByte 在接口中 ArrayData
  - setByte
```
public void setByte(int pos,
                    byte value)
```
  - setNullByte
```
public void setNullByte(int pos)
```
  - getShort
```
public short getShort(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the short value at the given position.
    
    指定者:
    
    getShort 在接口中 ArrayData
  - setShort
```
public void setShort(int pos,
                     short value)
```
  - setNullShort
```
public void setNullShort(int pos)
```
  - getFloat
```
public float getFloat(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the float value at the given position.
    
    指定者:
    
    getFloat 在接口中 ArrayData
  - setFloat
```
public void setFloat(int pos,
                     float value)
```
  - setNullFloat
```
public void setNullFloat(int pos)
```
  - getDouble
```
public double getDouble(int pos)
```
    从接口复制的说明: ArrayData
    
    Returns the double value at the given position.
    
    指定者:
    
    getDouble 在接口中 ArrayData
  - setDouble
```
public void setDouble(int pos,
                      double value)
```
  - setNullDouble
```
public void setNullDouble(int pos)
```
  - setDecimal
```
public void setDecimal(int pos,
                       DecimalData value,
                       int precision)
```
  - setTimestamp
```
public void setTimestamp(int pos,
                         TimestampData value,
                         int precision)
```
  - anyNull
```
public boolean anyNull()
```
  - toBooleanArray
```
public boolean[] toBooleanArray()
```
    指定者:
    
    toBooleanArray 在接口中 ArrayData
  - toByteArray
```
public byte[] toByteArray()
```
    指定者:
    
    toByteArray 在接口中 ArrayData
  - toShortArray
```
public short[] toShortArray()
```
    指定者:
    
    toShortArray 在接口中 ArrayData
  - toIntArray
```
public int[] toIntArray()
```
    指定者:
    
    toIntArray 在接口中 ArrayData
  - toLongArray
```
public long[] toLongArray()
```
    指定者:
    
    toLongArray 在接口中 ArrayData
  - toFloatArray
```
public float[] toFloatArray()
```
    指定者:
    
    toFloatArray 在接口中 ArrayData
  - toDoubleArray
```
public double[] toDoubleArray()
```
    指定者:
    
    toDoubleArray 在接口中 ArrayData
  - toObjectArray
```
public <T> T[] toObjectArray(DataType elementType)
```
  - copy
```
public BinaryArrayData copy()
```
  - copy
```
public BinaryArrayData copy(BinaryArrayData reuse)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 BinarySection
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(boolean[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(byte[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(short[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(int[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(long[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(float[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArrayData fromPrimitiveArray(double[] arr)
```

类 BinaryArrayData

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.cdc.common.data.ArrayData

字段概要

从类继承的字段 org.apache.flink.cdc.common.data.binary.BinarySection

从接口继承的字段 org.apache.flink.cdc.common.data.binary.BinaryFormat

构造器概要

方法概要

从类继承的方法 org.apache.flink.cdc.common.data.binary.BinarySection

从类继承的方法 java.lang.Object

从接口继承的方法 org.apache.flink.cdc.common.data.ArrayData

构造器详细资料

BinaryArrayData

方法详细资料

calculateHeaderInBytes

calculateFixLengthPartSize

size

pointTo

isNullAt

setNullAt

setNotNullAt

getLong

setLong

setNullLong

getInt

setInt

setNullInt

getString

getDecimal

getTimestamp

getLocalZonedTimestamp

getZonedTimestamp

getBinary

getArray

getMap

getRecord

getBoolean

setBoolean

setNullBoolean

getByte

setByte

setNullByte

getShort

setShort

setNullShort

getFloat

setFloat

setNullFloat

getDouble

setDouble

setNullDouble

setDecimal

setTimestamp

anyNull

toBooleanArray

toByteArray

toShortArray

toIntArray

toLongArray

toFloatArray

toDoubleArray

toObjectArray

copy

copy

hashCode

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray