BinaryArray (Paimon : Common 0.7.0-incubating API)

java.lang.Object
- org.apache.paimon.data.BinarySection
- - org.apache.paimon.data.BinaryArray

所有已实现的接口:

Serializable, DataGetters, DataSetters, InternalArray
```
@Public
public final class BinaryArray
extends BinarySection
implements InternalArray, DataSetters
```
A binary implementation of InternalArray which is backed by MemorySegments.
For fields that hold fixed-length primitive types, such as long, double or int, they are stored compacted in bytes, just like the original java array.
The binary layout of BinaryArray:
```
 [size(int)] + [null bits(4-byte word boundaries)] + [values or offset&length] + [variable length part].
 
```
从以下版本开始:

0.4.0

另请参阅:

序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.paimon.data.InternalArray
  InternalArray.ElementGetter

字段概要
- 从类继承的字段 org.apache.paimon.data.BinarySection
  HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE, offset, segments, sizeInBytes

构造器概要

构造器
构造器和说明

BinaryArray()

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`anyNull()`
`static int`	`calculateFixLengthPartSize(DataType 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)`
`InternalArray`	`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.
`Decimal`	`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.
`long`	`getLong(int pos)` Returns the long value at the given position.
`InternalMap`	`getMap(int pos)` Returns the map value at the given position.
`InternalRow`	`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.
`BinaryString`	`getString(int pos)` Returns the string value at the given position.
`Timestamp`	`getTimestamp(int pos, int precision)` Returns the 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(MemorySegment[] segments, int offset, int sizeInBytes)`
`void`	`setBoolean(int pos, boolean value)`
`void`	`setByte(int pos, byte value)`
`void`	`setDecimal(int pos, Decimal value, int precision)` Set the decimal column value.
`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, Timestamp value, int precision)` Set Timestamp value.
`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.paimon.data.BinarySection
equals, getOffset, getSegments, getSizeInBytes, pointTo, toBytes

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

从接口继承的方法 org.apache.paimon.data.InternalArray
createElementGetter

- 构造器详细资料
  - BinaryArray
```
public BinaryArray()
```
- 方法详细资料
  - calculateHeaderInBytes
```
public static int calculateHeaderInBytes(int numFields)
```
  - 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()
```
    从接口复制的说明: InternalArray
    
    Returns the number of elements in this array.
    
    指定者:
    
    size 在接口中 InternalArray
  - pointTo
```
public void pointTo(MemorySegment[] segments,
                    int offset,
                    int sizeInBytes)
```
    覆盖:
    
    pointTo 在类中 BinarySection
  - isNullAt
```
public boolean isNullAt(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns true if the element is null at the given position.
    
    指定者:
    
    isNullAt 在接口中 DataGetters
  - setNullAt
```
public void setNullAt(int pos)
```
    指定者:
    
    setNullAt 在接口中 DataSetters
  - setNotNullAt
```
public void setNotNullAt(int pos)
```
  - getLong
```
public long getLong(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the long value at the given position.
    
    指定者:
    
    getLong 在接口中 DataGetters
  - setLong
```
public void setLong(int pos,
                    long value)
```
    指定者:
    
    setLong 在接口中 DataSetters
  - setNullLong
```
public void setNullLong(int pos)
```
  - getInt
```
public int getInt(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the integer value at the given position.
    
    指定者:
    
    getInt 在接口中 DataGetters
  - setInt
```
public void setInt(int pos,
                   int value)
```
    指定者:
    
    setInt 在接口中 DataSetters
  - setNullInt
```
public void setNullInt(int pos)
```
  - getString
```
public BinaryString getString(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the string value at the given position.
    
    指定者:
    
    getString 在接口中 DataGetters
  - getDecimal
```
public Decimal getDecimal(int pos,
                          int precision,
                          int scale)
```
    从接口复制的说明: DataGetters
    
    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 Decimal).
    
    指定者:
    
    getDecimal 在接口中 DataGetters
  - getTimestamp
```
public Timestamp getTimestamp(int pos,
                              int precision)
```
    从接口复制的说明: DataGetters
    
    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 Timestamp).
    
    指定者:
    
    getTimestamp 在接口中 DataGetters
  - getBinary
```
public byte[] getBinary(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the binary value at the given position.
    
    指定者:
    
    getBinary 在接口中 DataGetters
  - getArray
```
public InternalArray getArray(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the array value at the given position.
    
    指定者:
    
    getArray 在接口中 DataGetters
  - getMap
```
public InternalMap getMap(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the map value at the given position.
    
    指定者:
    
    getMap 在接口中 DataGetters
  - getRow
```
public InternalRow getRow(int pos,
                          int numFields)
```
    从接口复制的说明: DataGetters
    
    Returns the row value at the given position.
    The number of fields is required to correctly extract the row.
    
    指定者:
    
    getRow 在接口中 DataGetters
  - getBoolean
```
public boolean getBoolean(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the boolean value at the given position.
    
    指定者:
    
    getBoolean 在接口中 DataGetters
  - setBoolean
```
public void setBoolean(int pos,
                       boolean value)
```
    指定者:
    
    setBoolean 在接口中 DataSetters
  - setNullBoolean
```
public void setNullBoolean(int pos)
```
  - getByte
```
public byte getByte(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the byte value at the given position.
    
    指定者:
    
    getByte 在接口中 DataGetters
  - setByte
```
public void setByte(int pos,
                    byte value)
```
    指定者:
    
    setByte 在接口中 DataSetters
  - setNullByte
```
public void setNullByte(int pos)
```
  - getShort
```
public short getShort(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the short value at the given position.
    
    指定者:
    
    getShort 在接口中 DataGetters
  - setShort
```
public void setShort(int pos,
                     short value)
```
    指定者:
    
    setShort 在接口中 DataSetters
  - setNullShort
```
public void setNullShort(int pos)
```
  - getFloat
```
public float getFloat(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the float value at the given position.
    
    指定者:
    
    getFloat 在接口中 DataGetters
  - setFloat
```
public void setFloat(int pos,
                     float value)
```
    指定者:
    
    setFloat 在接口中 DataSetters
  - setNullFloat
```
public void setNullFloat(int pos)
```
  - getDouble
```
public double getDouble(int pos)
```
    从接口复制的说明: DataGetters
    
    Returns the double value at the given position.
    
    指定者:
    
    getDouble 在接口中 DataGetters
  - setDouble
```
public void setDouble(int pos,
                      double value)
```
    指定者:
    
    setDouble 在接口中 DataSetters
  - setNullDouble
```
public void setNullDouble(int pos)
```
  - setDecimal
```
public void setDecimal(int pos,
                       Decimal value,
                       int precision)
```
    从接口复制的说明: DataSetters
    
    Set the decimal column value.
    Note: Precision is compact: can call DataSetters.setNullAt(int) when decimal is null. Precision is not compact: can not call DataSetters.setNullAt(int) when decimal is null, must call setDecimal(pos, null, precision) because we need update var-length-part.
    
    指定者:
    
    setDecimal 在接口中 DataSetters
  - setTimestamp
```
public void setTimestamp(int pos,
                         Timestamp value,
                         int precision)
```
    从接口复制的说明: DataSetters
    
    Set Timestamp value.
    Note: If precision is compact: can call DataSetters.setNullAt(int) when TimestampData value is null. Otherwise: can not call DataSetters.setNullAt(int) when TimestampData value is null, must call setTimestamp(pos, null, precision) because we need to update var-length-part.
    
    指定者:
    
    setTimestamp 在接口中 DataSetters
  - anyNull
```
public boolean anyNull()
```
  - toBooleanArray
```
public boolean[] toBooleanArray()
```
    指定者:
    
    toBooleanArray 在接口中 InternalArray
  - toByteArray
```
public byte[] toByteArray()
```
    指定者:
    
    toByteArray 在接口中 InternalArray
  - toShortArray
```
public short[] toShortArray()
```
    指定者:
    
    toShortArray 在接口中 InternalArray
  - toIntArray
```
public int[] toIntArray()
```
    指定者:
    
    toIntArray 在接口中 InternalArray
  - toLongArray
```
public long[] toLongArray()
```
    指定者:
    
    toLongArray 在接口中 InternalArray
  - toFloatArray
```
public float[] toFloatArray()
```
    指定者:
    
    toFloatArray 在接口中 InternalArray
  - toDoubleArray
```
public double[] toDoubleArray()
```
    指定者:
    
    toDoubleArray 在接口中 InternalArray
  - toObjectArray
```
public <T> T[] toObjectArray(DataType elementType)
```
  - 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.paimon.data.InternalArray

字段概要

从类继承的字段 org.apache.paimon.data.BinarySection

构造器概要

方法概要

从类继承的方法 org.apache.paimon.data.BinarySection

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

从接口继承的方法 org.apache.paimon.data.InternalArray

构造器详细资料

BinaryArray

方法详细资料

calculateHeaderInBytes

calculateFixLengthPartSize

size

pointTo

isNullAt

setNullAt

setNotNullAt

getLong

setLong

setNullLong

getInt

setInt

setNullInt

getString

getDecimal

getTimestamp

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

toObjectArray

copy

copy

hashCode

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray

fromPrimitiveArray