@Public public final class BinaryRow extends BinarySection implements InternalRow, DataSetters
InternalRow
which is backed by MemorySegment
instead of
Object. It can significantly reduce the serialization/deserialization of Java objects.
A Row 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.
InternalRow.FieldGetter
Modifier and Type | Field and Description |
---|---|
static BinaryRow |
EMPTY_ROW |
static int |
HEADER_SIZE_IN_BITS |
static boolean |
LITTLE_ENDIAN |
HIGHEST_FIRST_BIT, HIGHEST_SECOND_TO_EIGHTH_BIT, MAX_FIX_PART_DATA_SIZE, offset, segments, sizeInBytes
Constructor and Description |
---|
BinaryRow(int arity) |
Modifier and Type | Method and Description |
---|---|
boolean |
anyNull()
The bit is 1 when the field is null.
|
boolean |
anyNull(int[] fields) |
static int |
calculateBitSetWidthInBytes(int arity) |
static int |
calculateFixPartSizeInBytes(int arity) |
void |
clear() |
BinaryRow |
copy() |
BinaryRow |
copy(BinaryRow reuse) |
boolean |
equals(Object o) |
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.
|
int |
getFieldCount()
Returns the number of fields in this row.
|
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.
|
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.
|
RowKind |
getRowKind()
Returns the kind of change that this row describes in a changelog.
|
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 |
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 |
setNullAt(int i) |
void |
setRowKind(RowKind kind)
Sets the kind of change that this row describes in a changelog.
|
void |
setShort(int pos,
short value) |
void |
setTimestamp(int pos,
Timestamp value,
int precision)
Set Timestamp value.
|
void |
setTotalSize(int sizeInBytes) |
static BinaryRow |
singleColumn(BinaryString string) |
static BinaryRow |
singleColumn(Integer i) |
static BinaryRow |
singleColumn(String string) |
getOffset, getSegments, getSizeInBytes, pointTo, pointTo, toBytes
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
createFieldGetter, getDataClass
public static final boolean LITTLE_ENDIAN
public static final int HEADER_SIZE_IN_BITS
public static final BinaryRow EMPTY_ROW
public static int calculateBitSetWidthInBytes(int arity)
public static int calculateFixPartSizeInBytes(int arity)
public int getFixedLengthPartSize()
public int getFieldCount()
InternalRow
The number does not include RowKind
. It is kept separately.
getFieldCount
in interface InternalRow
public RowKind getRowKind()
InternalRow
getRowKind
in interface InternalRow
RowKind
public void setRowKind(RowKind kind)
InternalRow
setRowKind
in interface InternalRow
RowKind
public void setTotalSize(int sizeInBytes)
public boolean isNullAt(int pos)
DataGetters
isNullAt
in interface DataGetters
public void setNullAt(int i)
setNullAt
in interface DataSetters
public void setInt(int pos, int value)
setInt
in interface DataSetters
public void setLong(int pos, long value)
setLong
in interface DataSetters
public void setDouble(int pos, double value)
setDouble
in interface DataSetters
public void setDecimal(int pos, Decimal value, int precision)
DataSetters
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
in interface DataSetters
public void setTimestamp(int pos, Timestamp value, int precision)
DataSetters
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
in interface DataSetters
public void setBoolean(int pos, boolean value)
setBoolean
in interface DataSetters
public void setShort(int pos, short value)
setShort
in interface DataSetters
public void setByte(int pos, byte value)
setByte
in interface DataSetters
public void setFloat(int pos, float value)
setFloat
in interface DataSetters
public boolean getBoolean(int pos)
DataGetters
getBoolean
in interface DataGetters
public byte getByte(int pos)
DataGetters
getByte
in interface DataGetters
public short getShort(int pos)
DataGetters
getShort
in interface DataGetters
public int getInt(int pos)
DataGetters
getInt
in interface DataGetters
public long getLong(int pos)
DataGetters
getLong
in interface DataGetters
public float getFloat(int pos)
DataGetters
getFloat
in interface DataGetters
public double getDouble(int pos)
DataGetters
getDouble
in interface DataGetters
public BinaryString getString(int pos)
DataGetters
getString
in interface DataGetters
public Decimal getDecimal(int pos, int precision, int scale)
DataGetters
The precision and scale are required to determine whether the decimal value was stored in
a compact representation (see Decimal
).
getDecimal
in interface DataGetters
public Timestamp getTimestamp(int pos, int precision)
DataGetters
The precision is required to determine whether the timestamp value was stored in a compact
representation (see Timestamp
).
getTimestamp
in interface DataGetters
public byte[] getBinary(int pos)
DataGetters
getBinary
in interface DataGetters
public InternalArray getArray(int pos)
DataGetters
getArray
in interface DataGetters
public InternalMap getMap(int pos)
DataGetters
getMap
in interface DataGetters
public InternalRow getRow(int pos, int numFields)
DataGetters
The number of fields is required to correctly extract the row.
getRow
in interface DataGetters
public boolean anyNull()
public boolean anyNull(int[] fields)
public BinaryRow copy()
public void clear()
public boolean equals(Object o)
equals
in class BinarySection
public int hashCode()
hashCode
in class BinarySection
public static BinaryRow singleColumn(@Nullable BinaryString string)
Copyright © 2023–2024 The Apache Software Foundation. All rights reserved.