org.apache.arrow.vector

Class StructVectorUnloader

java.lang.Object

org.apache.arrow.vector.StructVectorUnloader

public class StructVectorUnloader
extends Object

Helper class that handles converting a StructVector to a ArrowRecordBatch.

Constructor Summary

Constructors

Constructor and Description
StructVectorUnloader(StructVector root) Constructs a new instance of the given struct vector.
StructVectorUnloader(StructVector root, boolean includeNullCount, boolean alignBuffers) Constructs a new instance.
StructVectorUnloader(StructVector root, boolean includeNullCount, CompressionCodec codec, boolean alignBuffers) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
ArrowRecordBatch	getRecordBatch() Performs the depth first traversal of the Vectors to create an ArrowRecordBatch suitable for serialization.

Methods inherited from class java.lang.Object

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

Constructor Detail

StructVectorUnloader

public StructVectorUnloader(StructVector root)

Constructs a new instance of the given struct vector.

StructVectorUnloader

public StructVectorUnloader(StructVector root,
                            boolean includeNullCount,
                            boolean alignBuffers)

Constructs a new instance.

Parameters:

root - The struct vector to serialize to an ArrowRecordBatch.

includeNullCount - Controls whether null count is copied to the ArrowRecordBatch

alignBuffers - Controls if buffers get aligned to 8-byte boundaries.

StructVectorUnloader

public StructVectorUnloader(StructVector root,
                            boolean includeNullCount,
                            CompressionCodec codec,
                            boolean alignBuffers)

Constructs a new instance.

Parameters:

root - The struct vector to serialize to an ArrowRecordBatch.

includeNullCount - Controls whether null count is copied to the ArrowRecordBatch

codec - the codec for compressing data. If it is null, then no compression is needed.

alignBuffers - Controls if buffers get aligned to 8-byte boundaries.

Method Detail

getRecordBatch

public ArrowRecordBatch getRecordBatch()

Performs the depth first traversal of the Vectors to create an ArrowRecordBatch suitable for serialization.