BinaryRecordData (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.BinaryRecordData

所有已实现的接口:

BinaryFormat, NullAwareGetters, RecordData
```
@Internal
public final class BinaryRecordData
extends BinarySection
implements RecordData, NullAwareGetters
```
An implementation of RecordData which is backed by MemorySegment instead of Object. It can significantly reduce the serialization/deserialization of Java objects.
A BinaryRecordData has two part: Fixed-length part and variable-length part.
Fixed-length part contains 1 byte header and null bit set and field values. Null bit set is used for null tracking and is aligned to 8-byte word boundaries. `Field values` holds fixed-length primitive types and variable-length values which can be stored in 8 bytes inside. If it do not fit the variable-length field, then store the length and offset of variable-length part.
Fixed-length part will certainly fall into a MemorySegment, which will speed up the read and write of field. During the write phase, if the target memory segment has less space than fixed length part size, we will skip the space. So the number of fields in a single Row cannot exceed the capacity of a single MemorySegment, if there are too many fields, we suggest that user set a bigger pageSize of MemorySegment.
Variable-length part may fall into multiple MemorySegments.

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

字段概要

字段
限定符和类型字段和说明

static int HEADER_SIZE_IN_BITS

static boolean LITTLE_ENDIAN

static String TIMESTAMP_DELIMITER
- 从类继承的字段 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

字段
限定符和类型	字段和说明
`static int`	`HEADER_SIZE_IN_BITS`
`static boolean`	`LITTLE_ENDIAN`
`static String`	`TIMESTAMP_DELIMITER`

构造器概要

构造器
构造器和说明

BinaryRecordData(int arity)

构造器
构造器和说明
`BinaryRecordData(int arity)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`anyNull()` The bit is 1 when the field is null.
`boolean`	`anyNull(int[] fields)` For the input fields, if no field is null, return false.
`static int`	`calculateBitSetWidthInBytes(int arity)`
`void`	`clear()`
`BinaryRecordData`	`copy()`
`BinaryRecordData`	`copy(BinaryRecordData reuse)`
`boolean`	`equals(Object o)`
`int`	`getArity()` Returns the number of fields in this record.
`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.
`int`	`getFixedLengthPartSize()`
`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`	`getLocalZonedTimestampData(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`	`getRow(int pos, int numFields)` Returns the row 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 field is null at the given position.
`void`	`setTotalSize(int sizeInBytes)`

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

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

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

- 字段详细资料
  - LITTLE_ENDIAN
```
public static final boolean LITTLE_ENDIAN
```
  - HEADER_SIZE_IN_BITS
```
public static final int HEADER_SIZE_IN_BITS
```
    另请参阅:
    
    常量字段值
  - TIMESTAMP_DELIMITER
```
public static final String TIMESTAMP_DELIMITER
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - BinaryRecordData
```
public BinaryRecordData(int arity)
```
- 方法详细资料
  - calculateBitSetWidthInBytes
```
public static int calculateBitSetWidthInBytes(int arity)
```
  - getFixedLengthPartSize
```
public int getFixedLengthPartSize()
```
  - getArity
```
public int getArity()
```
    从接口复制的说明: RecordData
    
    Returns the number of fields in this record.
    
    指定者:
    
    getArity 在接口中 RecordData
  - isNullAt
```
public boolean isNullAt(int pos)
```
    从接口复制的说明: RecordData
    
    Returns true if the field is null at the given position.
    
    指定者:
    
    isNullAt 在接口中 RecordData
  - getBoolean
```
public boolean getBoolean(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the boolean value at the given position.
    
    指定者:
    
    getBoolean 在接口中 RecordData
  - getByte
```
public byte getByte(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the byte value at the given position.
    
    指定者:
    
    getByte 在接口中 RecordData
  - getShort
```
public short getShort(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the short value at the given position.
    
    指定者:
    
    getShort 在接口中 RecordData
  - getInt
```
public int getInt(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the integer value at the given position.
    
    指定者:
    
    getInt 在接口中 RecordData
  - getLong
```
public long getLong(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the long value at the given position.
    
    指定者:
    
    getLong 在接口中 RecordData
  - getFloat
```
public float getFloat(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the float value at the given position.
    
    指定者:
    
    getFloat 在接口中 RecordData
  - getDouble
```
public double getDouble(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the double value at the given position.
    
    指定者:
    
    getDouble 在接口中 RecordData
  - getString
```
public StringData getString(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the string value at the given position.
    
    指定者:
    
    getString 在接口中 RecordData
  - getDecimal
```
public DecimalData getDecimal(int pos,
                              int precision,
                              int scale)
```
    从接口复制的说明: RecordData
    
    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 在接口中 RecordData
  - getTimestamp
```
public TimestampData getTimestamp(int pos,
                                  int precision)
```
    从接口复制的说明: RecordData
    
    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 在接口中 RecordData
  - getZonedTimestamp
```
public ZonedTimestampData getZonedTimestamp(int pos,
                                            int precision)
```
    从接口复制的说明: RecordData
    
    Returns the zoned timestamp value at the given position.
    The precision is required to determine whether the zoned timestamp value was stored in a compact representation (see ZonedTimestampData).
    
    指定者:
    
    getZonedTimestamp 在接口中 RecordData
  - getLocalZonedTimestampData
```
public LocalZonedTimestampData getLocalZonedTimestampData(int pos,
                                                          int precision)
```
    从接口复制的说明: RecordData
    
    Returns the local zoned timestamp value at the given position.
    The precision is required to determine whether the local zoned timestamp value was stored in a compact representation (see LocalZonedTimestampData).
    
    指定者:
    
    getLocalZonedTimestampData 在接口中 RecordData
  - getBinary
```
public byte[] getBinary(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the binary value at the given position.
    
    指定者:
    
    getBinary 在接口中 RecordData
  - getArray
```
public ArrayData getArray(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the array value at the given position.
    
    指定者:
    
    getArray 在接口中 RecordData
  - getMap
```
public MapData getMap(int pos)
```
    从接口复制的说明: RecordData
    
    Returns the map value at the given position.
    
    指定者:
    
    getMap 在接口中 RecordData
  - getRow
```
public RecordData getRow(int pos,
                         int numFields)
```
    从接口复制的说明: RecordData
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the record.
    
    指定者:
    
    getRow 在接口中 RecordData
  - anyNull
```
public boolean anyNull()
```
    The bit is 1 when the field is null. Default is 0.
    
    指定者:
    
    anyNull 在接口中 NullAwareGetters
  - anyNull
```
public boolean anyNull(int[] fields)
```
    从接口复制的说明: NullAwareGetters
    
    For the input fields, if no field is null, return false. Returns true if one of the columns is null.
    
    指定者:
    
    anyNull 在接口中 NullAwareGetters
  - copy
```
public BinaryRecordData copy()
```
  - copy
```
public BinaryRecordData copy(BinaryRecordData reuse)
```
  - clear
```
public void clear()
```
  - equals
```
public boolean equals(Object o)
```
    覆盖:
    
    equals 在类中 BinarySection
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 BinarySection
  - setTotalSize
```
public void setTotalSize(int sizeInBytes)
```

类 BinaryRecordData

嵌套类概要

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

字段概要

从类继承的字段 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.RecordData

字段详细资料

LITTLE_ENDIAN

HEADER_SIZE_IN_BITS

TIMESTAMP_DELIMITER

构造器详细资料

BinaryRecordData

方法详细资料

calculateBitSetWidthInBytes

getFixedLengthPartSize

getArity

isNullAt

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getString

getDecimal

getTimestamp

getZonedTimestamp

getLocalZonedTimestampData

getBinary

getArray

getMap

getRow

anyNull

anyNull

copy

copy

clear

equals

hashCode

setTotalSize