BinaryArray (flink-table-runtime-blink 1.10.2 API)

java.lang.Object
- org.apache.flink.table.dataformat.BinarySection
- - org.apache.flink.table.dataformat.BinaryArray

所有已实现的接口:

BaseArray, BinaryFormat, TypeGetterSetters
```
public final class BinaryArray
extends BinarySection
implements BaseArray
```
For fields that hold fixed-length primitive types, such as long, double, or int, we store the value directly in the field, just like the original java array.
[numElements(int)] + [null bits(4-byte word boundaries)] + [values or offset&length] + [variable length part].
BinaryArray are influenced by Apache Spark UnsafeArrayData.

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

构造器概要

构造器
构造器和说明

BinaryArray()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`anyNull()`
`static int`	`calculateFixLengthPartSize(org.apache.flink.table.types.logical.LogicalType type)` It store real value when type is primitive.
`static int`	`calculateHeaderInBytes(int numFields)`
`BinaryArray`	`copy()`
`BinaryArray`	`copy(BinaryArray reuse)`
`static BinaryArray`	`fromPrimitiveArray(boolean[] arr)`
`static BinaryArray`	`fromPrimitiveArray(byte[] arr)`
`static BinaryArray`	`fromPrimitiveArray(double[] arr)`
`static BinaryArray`	`fromPrimitiveArray(float[] arr)`
`static BinaryArray`	`fromPrimitiveArray(int[] arr)`
`static BinaryArray`	`fromPrimitiveArray(long[] arr)`
`static BinaryArray`	`fromPrimitiveArray(short[] arr)`
`BaseArray`	`getArray(int pos)` Get array value, internal format is BaseArray.
`byte[]`	`getBinary(int pos)` Get binary value, internal format is byte[].
`boolean`	`getBoolean(int pos)` Get boolean value.
`byte`	`getByte(int pos)` Get byte value.
`Decimal`	`getDecimal(int pos, int precision, int scale)` Get decimal value, internal format is Decimal.
`double`	`getDouble(int pos)` Get double value.
`float`	`getFloat(int pos)` Get float value.
`<T> BinaryGeneric<T>`	`getGeneric(int pos)` Get generic value, internal format is BinaryGeneric.
`int`	`getInt(int pos)` Get int value.
`long`	`getLong(int pos)` Get long value.
`BaseMap`	`getMap(int pos)` Get map value, internal format is BaseMap.
`BaseRow`	`getRow(int pos, int numFields)` Get row value, internal format is BaseRow.
`short`	`getShort(int pos)` Get short value.
`BinaryString`	`getString(int pos)` Get string value, internal format is BinaryString.
`SqlTimestamp`	`getTimestamp(int pos, int precision)` Get Timestamp value, internal format is SqlTimestamp.
`int`	`hashCode()`
`boolean`	`isNullAt(int pos)` Because the specific row implementation such as BinaryRow uses the binary format.
`int`	`numElements()`
`void`	`pointTo(org.apache.flink.core.memory.MemorySegment[] segments, int offset, int sizeInBytes)`
`void`	`setBoolean(int pos, boolean value)` Set boolean value.
`void`	`setByte(int pos, byte value)` Set byte value.
`void`	`setDecimal(int pos, Decimal value, int precision)` Set the decimal column value.
`void`	`setDouble(int pos, double value)` Set double value.
`void`	`setFloat(int pos, float value)` Set float value.
`void`	`setInt(int pos, int value)` Set int value.
`void`	`setLong(int pos, long value)` Set long value.
`void`	`setNotNullAt(int pos)`
`void`	`setNullAt(int pos)` Set null to this field.
`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)` Set short value.
`void`	`setTimestamp(int pos, SqlTimestamp value, int precision)` Set Timestamp value.
`boolean[]`	`toBooleanArray()`
`byte[]`	`toByteArray()`
`<T> T[]`	`toClassArray(org.apache.flink.table.types.logical.LogicalType elementType, Class<T> elementClass)`
`double[]`	`toDoubleArray()`
`float[]`	`toFloatArray()`
`int[]`	`toIntArray()`
`long[]`	`toLongArray()`
`short[]`	`toShortArray()`

从类继承的方法 org.apache.flink.table.dataformat.BinarySection
equals, getOffset, getSegments, getSizeInBytes, pointTo

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

从接口继承的方法 org.apache.flink.table.dataformat.TypeGetterSetters
get

从接口继承的方法 org.apache.flink.table.dataformat.BinaryFormat
readBinaryFieldFromSegments, readBinaryStringFieldFromSegments

- 构造器详细资料
  - BinaryArray
```
public BinaryArray()
```
- 方法详细资料
  - calculateHeaderInBytes
```
public static int calculateHeaderInBytes(int numFields)
```
  - calculateFixLengthPartSize
```
public static int calculateFixLengthPartSize(org.apache.flink.table.types.logical.LogicalType 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.
  - numElements
```
public int numElements()
```
    指定者:
    
    numElements 在接口中 BaseArray
  - pointTo
```
public void pointTo(org.apache.flink.core.memory.MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)
```
    覆盖:
    
    pointTo 在类中 BinarySection
  - isNullAt
```
public boolean isNullAt(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Because the specific row implementation such as BinaryRow uses the binary format. We must first determine if it is null, and then make a specific get.
    
    指定者:
    
    isNullAt 在接口中 BaseArray
    
    指定者:
    
    isNullAt 在接口中 TypeGetterSetters
    
    返回:
    
    true if this field is null.
  - setNullAt
```
public void setNullAt(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Set null to this field.
    
    指定者:
    
    setNullAt 在接口中 BaseArray
    
    指定者:
    
    setNullAt 在接口中 TypeGetterSetters
  - setNotNullAt
```
public void setNotNullAt(int pos)
```
    指定者:
    
    setNotNullAt 在接口中 BaseArray
  - getLong
```
public long getLong(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get long value.
    
    指定者:
    
    getLong 在接口中 TypeGetterSetters
  - setLong
```
public void setLong(int pos,
                    long value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set long value.
    
    指定者:
    
    setLong 在接口中 TypeGetterSetters
  - setNullLong
```
public void setNullLong(int pos)
```
    指定者:
    
    setNullLong 在接口中 BaseArray
  - getInt
```
public int getInt(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get int value.
    
    指定者:
    
    getInt 在接口中 TypeGetterSetters
  - setInt
```
public void setInt(int pos,
                   int value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set int value.
    
    指定者:
    
    setInt 在接口中 TypeGetterSetters
  - setNullInt
```
public void setNullInt(int pos)
```
    指定者:
    
    setNullInt 在接口中 BaseArray
  - getString
```
public BinaryString getString(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get string value, internal format is BinaryString.
    
    指定者:
    
    getString 在接口中 TypeGetterSetters
  - getDecimal
```
public Decimal getDecimal(int pos,
                          int precision,
                          int scale)
```
    从接口复制的说明: TypeGetterSetters
    
    Get decimal value, internal format is Decimal.
    
    指定者:
    
    getDecimal 在接口中 TypeGetterSetters
  - getTimestamp
```
public SqlTimestamp getTimestamp(int pos,
                                 int precision)
```
    从接口复制的说明: TypeGetterSetters
    
    Get Timestamp value, internal format is SqlTimestamp.
    
    指定者:
    
    getTimestamp 在接口中 TypeGetterSetters
  - getGeneric
```
public <T> BinaryGeneric<T> getGeneric(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get generic value, internal format is BinaryGeneric.
    
    指定者:
    
    getGeneric 在接口中 TypeGetterSetters
  - getBinary
```
public byte[] getBinary(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get binary value, internal format is byte[].
    
    指定者:
    
    getBinary 在接口中 TypeGetterSetters
  - getArray
```
public BaseArray getArray(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get array value, internal format is BaseArray.
    
    指定者:
    
    getArray 在接口中 TypeGetterSetters
  - getMap
```
public BaseMap getMap(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get map value, internal format is BaseMap.
    
    指定者:
    
    getMap 在接口中 TypeGetterSetters
  - getRow
```
public BaseRow getRow(int pos,
                      int numFields)
```
    从接口复制的说明: TypeGetterSetters
    
    Get row value, internal format is BaseRow.
    
    指定者:
    
    getRow 在接口中 TypeGetterSetters
  - getBoolean
```
public boolean getBoolean(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get boolean value.
    
    指定者:
    
    getBoolean 在接口中 TypeGetterSetters
  - setBoolean
```
public void setBoolean(int pos,
                       boolean value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set boolean value.
    
    指定者:
    
    setBoolean 在接口中 TypeGetterSetters
  - setNullBoolean
```
public void setNullBoolean(int pos)
```
    指定者:
    
    setNullBoolean 在接口中 BaseArray
  - getByte
```
public byte getByte(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get byte value.
    
    指定者:
    
    getByte 在接口中 TypeGetterSetters
  - setByte
```
public void setByte(int pos,
                    byte value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set byte value.
    
    指定者:
    
    setByte 在接口中 TypeGetterSetters
  - setNullByte
```
public void setNullByte(int pos)
```
    指定者:
    
    setNullByte 在接口中 BaseArray
  - getShort
```
public short getShort(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get short value.
    
    指定者:
    
    getShort 在接口中 TypeGetterSetters
  - setShort
```
public void setShort(int pos,
                     short value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set short value.
    
    指定者:
    
    setShort 在接口中 TypeGetterSetters
  - setNullShort
```
public void setNullShort(int pos)
```
    指定者:
    
    setNullShort 在接口中 BaseArray
  - getFloat
```
public float getFloat(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get float value.
    
    指定者:
    
    getFloat 在接口中 TypeGetterSetters
  - setFloat
```
public void setFloat(int pos,
                     float value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set float value.
    
    指定者:
    
    setFloat 在接口中 TypeGetterSetters
  - setNullFloat
```
public void setNullFloat(int pos)
```
    指定者:
    
    setNullFloat 在接口中 BaseArray
  - getDouble
```
public double getDouble(int pos)
```
    从接口复制的说明: TypeGetterSetters
    
    Get double value.
    
    指定者:
    
    getDouble 在接口中 TypeGetterSetters
  - setDouble
```
public void setDouble(int pos,
                      double value)
```
    从接口复制的说明: TypeGetterSetters
    
    Set double value.
    
    指定者:
    
    setDouble 在接口中 TypeGetterSetters
  - setNullDouble
```
public void setNullDouble(int pos)
```
    指定者:
    
    setNullDouble 在接口中 BaseArray
  - setDecimal
```
public void setDecimal(int pos,
                       Decimal value,
                       int precision)
```
    从接口复制的说明: TypeGetterSetters
    
    Set the decimal column value.
    Note: Precision is compact: can call setNullAt when decimal is null. Precision is not compact: can not call setNullAt when decimal is null, must call setDecimal(i, null, precision) because we need update var-length-part.
    
    指定者:
    
    setDecimal 在接口中 TypeGetterSetters
  - setTimestamp
```
public void setTimestamp(int pos,
                         SqlTimestamp value,
                         int precision)
```
    从接口复制的说明: TypeGetterSetters
    
    Set Timestamp value.
    Note: If precision is compact: can call setNullAt when SqlTimestamp value is null. Otherwise: can not call setNullAt when SqlTimestamp value is null, must call setTimestamp(ordinal, null, precision) because we need to update var-length-part.
    
    指定者:
    
    setTimestamp 在接口中 TypeGetterSetters
  - anyNull
```
public boolean anyNull()
```
  - toBooleanArray
```
public boolean[] toBooleanArray()
```
    指定者:
    
    toBooleanArray 在接口中 BaseArray
  - toByteArray
```
public byte[] toByteArray()
```
    指定者:
    
    toByteArray 在接口中 BaseArray
  - toShortArray
```
public short[] toShortArray()
```
    指定者:
    
    toShortArray 在接口中 BaseArray
  - toIntArray
```
public int[] toIntArray()
```
    指定者:
    
    toIntArray 在接口中 BaseArray
  - toLongArray
```
public long[] toLongArray()
```
    指定者:
    
    toLongArray 在接口中 BaseArray
  - toFloatArray
```
public float[] toFloatArray()
```
    指定者:
    
    toFloatArray 在接口中 BaseArray
  - toDoubleArray
```
public double[] toDoubleArray()
```
    指定者:
    
    toDoubleArray 在接口中 BaseArray
  - toClassArray
```
public <T> T[] toClassArray(org.apache.flink.table.types.logical.LogicalType elementType,
                            Class<T> elementClass)
```
  - copy
```
public BinaryArray copy()
```
  - copy
```
public BinaryArray copy(BinaryArray reuse)
```
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 BinarySection
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(boolean[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(byte[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(short[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(int[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(long[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(float[] arr)
```
  - fromPrimitiveArray
```
public static BinaryArray fromPrimitiveArray(double[] arr)
```

类 BinaryArray

字段概要

从类继承的字段 org.apache.flink.table.dataformat.BinarySection

从接口继承的字段 org.apache.flink.table.dataformat.BinaryFormat

构造器概要

方法概要

从类继承的方法 org.apache.flink.table.dataformat.BinarySection

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

从接口继承的方法 org.apache.flink.table.dataformat.TypeGetterSetters

从接口继承的方法 org.apache.flink.table.dataformat.BinaryFormat

构造器详细资料

BinaryArray

方法详细资料

calculateHeaderInBytes

calculateFixLengthPartSize

numElements

pointTo

isNullAt

setNullAt

setNotNullAt

getLong

setLong

setNullLong

getInt

setInt

setNullInt

getString

getDecimal

getTimestamp

getGeneric

getBinary

getArray

getMap

getRow

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

toClassArray

copy

copy

hashCode

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray