Package io.deephaven.extensions.barrage.chunk

Interface ChunkReader

All Known Implementing Classes:

BooleanChunkReader, ByteChunkReader, CharChunkReader, DoubleChunkReader, FloatChunkReader, IntChunkReader, LongChunkReader, ShortChunkReader, VarListChunkReader, VectorChunkReader

public interface ChunkReader

Consumes Flight/Barrage streams and transforms them into WritableChunks.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChunkReader.Factory	Supports creation of ChunkReader instances to use when processing a flight stream.
static class	ChunkReader.TypeInfo	Describes type info used by factory implementations when creating a ChunkReader.

Method Summary

Modifier and Type	Method	Description
WritableChunk<Values>	readChunk(Iterator<ChunkInputStreamGenerator.FieldNodeInfo> fieldNodeIter, PrimitiveIterator.OfLong bufferInfoIter, DataInput is, WritableChunk<Values> outChunk, int outOffset, int totalRows)	Reads the given DataInput to extract the next Arrow buffer as a Deephaven Chunk.
static ChunkReader.TypeInfo	typeInfo(ChunkType chunkType, Class<?> type, Class<?> componentType, org.apache.arrow.flatbuf.Field arrowField)	Factory method to create a TypeInfo instance.

Method Details

readChunk

WritableChunk<Values> readChunk(Iterator<ChunkInputStreamGenerator.FieldNodeInfo> fieldNodeIter,
 PrimitiveIterator.OfLong bufferInfoIter,
 DataInput is,
 WritableChunk<Values> outChunk,
 int outOffset,
 int totalRows)
                         throws IOException

Reads the given DataInput to extract the next Arrow buffer as a Deephaven Chunk.

Parameters:

fieldNodeIter - iterator to read fields from the stream

bufferInfoIter - iterator to read buffers from the stream

is - input stream containing buffers to be read

outChunk - chunk to write to

outOffset - offset within the outChunk to begin writing

totalRows - total rows to write to the outChunk

Returns:

a Chunk containing the data from the stream

Throws:

IOException - if an error occurred while reading the stream

typeInfo

static ChunkReader.TypeInfo typeInfo(ChunkType chunkType,
 Class<?> type,
 Class<?> componentType,
 org.apache.arrow.flatbuf.Field arrowField)

Factory method to create a TypeInfo instance.

Parameters:

chunkType - the output chunk type

type - the Java type to be read into the chunk

componentType - the Java type of nested components

arrowField - the Arrow type to be read into the chunk

Returns:

a TypeInfo instance