org.apache.fury.format.row.binary.writer

Class BinaryArrayWriter

java.lang.Object

org.apache.fury.format.row.binary.writer.BinaryWriter

org.apache.fury.format.row.binary.writer.BinaryArrayWriter

public class BinaryArrayWriter
extends BinaryWriter

Writer for binary array. See BinaryArray

Must call reset(numElements) before use this writer to writer an array every time.

Must call reset(numElements) before call fromPrimitiveArray methods, so we can write multiple primitive array into one binary array, and keep api consistent, rather call reset in fromPrimitiveArray.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ROUNDED_ARRAY_LENGTH

Fields inherited from class org.apache.fury.format.row.binary.writer.BinaryWriter

buffer, children, startIndex

Constructor Summary

Constructors

Constructor and Description
BinaryArrayWriter(org.apache.arrow.vector.types.pojo.Field field) Must call reset before using writer constructed by this constructor.
BinaryArrayWriter(org.apache.arrow.vector.types.pojo.Field field, BinaryWriter writer) Write data to writer's buffer.

Method Summary

Modifier and Type	Method and Description
void	fromPrimitiveArray(boolean[] arr)
void	fromPrimitiveArray(byte[] arr)
void	fromPrimitiveArray(double[] arr)
void	fromPrimitiveArray(float[] arr)
void	fromPrimitiveArray(int[] arr)
void	fromPrimitiveArray(long[] arr)
void	fromPrimitiveArray(short[] arr)
org.apache.arrow.vector.types.pojo.Field	getField()
int	getOffset(int ordinal)
void	reset(int numElements) reset BinaryArrayWriter(ArrayType type, BinaryWriter writer) increase writerIndex, which increase writer's writerIndex, we need to record writer's writerIndex before call reset, so we can call writer's setOffsetAndSize(int ordinal, int absoluteOffset, int size) Reset will change writerIndex, please use it very carefully.
BinaryArray	toArray()
void	write(int ordinal, BigDecimal value)
void	write(int ordinal, boolean value)
void	write(int ordinal, byte value)
void	write(int ordinal, float value)
void	write(int ordinal, int value)
void	write(int ordinal, short value)

Methods inherited from class org.apache.fury.format.row.binary.writer.BinaryWriter

copyTo, getBuffer, getStartIndex, grow, increaseWriterIndex, increaseWriterIndexToAligned, isNullAt, roundNumberOfBytesToNearestWord, setBuffer, setNotNullAt, setNullAt, setOffsetAndSize, setOffsetAndSize, size, write, write, write, write, write, write, write, writeAlignedBytes, writeDecimal, writeDirectly, writeDirectly, writerIndex, writeUnaligned, writeUnaligned, zeroOutPaddingBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_ROUNDED_ARRAY_LENGTH

public static int MAX_ROUNDED_ARRAY_LENGTH

Constructor Detail

BinaryArrayWriter

public BinaryArrayWriter(org.apache.arrow.vector.types.pojo.Field field)

Must call reset before using writer constructed by this constructor.

BinaryArrayWriter

public BinaryArrayWriter(org.apache.arrow.vector.types.pojo.Field field,
                         BinaryWriter writer)

Write data to writer's buffer.

Must call reset before using writer constructed by this constructor

Method Detail

reset

public void reset(int numElements)

reset BinaryArrayWriter(ArrayType type, BinaryWriter writer) increase writerIndex, which increase writer's writerIndex, we need to record writer's writerIndex before call reset, so we can call writer's setOffsetAndSize(int ordinal, int absoluteOffset, int size) Reset will change writerIndex, please use it very carefully.

getOffset

public int getOffset(int ordinal)

Specified by:

getOffset in class BinaryWriter

write

public void write(int ordinal,
                  byte value)

Specified by:

write in class BinaryWriter

write

public void write(int ordinal,
                  boolean value)

Specified by:

write in class BinaryWriter

write

public void write(int ordinal,
                  short value)

Specified by:

write in class BinaryWriter

write

public void write(int ordinal,
                  int value)

Specified by:

write in class BinaryWriter

write

public void write(int ordinal,
                  float value)

Specified by:

write in class BinaryWriter

write

public void write(int ordinal,
                  BigDecimal value)

Specified by:

write in class BinaryWriter

fromPrimitiveArray

public void fromPrimitiveArray(byte[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(boolean[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(short[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(int[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(long[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(float[] arr)

fromPrimitiveArray

public void fromPrimitiveArray(double[] arr)

toArray

public BinaryArray toArray()

getField

public org.apache.arrow.vector.types.pojo.Field getField()