org.bytedeco.parquet

Class RecordReader

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.parquet.RecordReader

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

BinaryRecordReader, DictionaryRecordReader

@Namespace(value="parquet::internal")
 @Properties(inherit=parquet.class)
public class RecordReader
extends Pointer

\brief Stateful column reader that delimits semantic records for both flat and nested columns \note API EXPERIMENTAL

Since:

1.3.0

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
RecordReader(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	DebugPrintState()
ShortPointer	def_levels() \brief Decoded definition levels
boolean	HasMoreData() \brief Return true if the record reader has more internal data yet to process
long	levels_position() \brief Number of definition / repetition levels (from those that have been decoded) that have been consumed inside the reader.
long	levels_written() \brief Number of definition / repetition levels that have been written internally in the reader
static RecordReader	Make(ColumnDescriptor descr, LevelInfo leaf_info)
static RecordReader	Make(ColumnDescriptor descr, LevelInfo leaf_info, MemoryPool pool, boolean read_dictionary)
long	null_count() \brief Number of nulls in the leaf
boolean	nullable_values() \brief True if the leaf values are nullable
boolean	read_dictionary() \brief True if reading directly as Arrow dictionary-encoded
long	ReadRecords(long num_records) \brief Attempt to read indicated number of records from column chunk
ResizableBuffer	ReleaseIsValid() \brief Transfer filled validity bitmap buffer to caller.
ResizableBuffer	ReleaseValues() \brief Transfer filled values buffer to caller.
ShortPointer	rep_levels() \brief Decoded repetition levels
void	Reserve(long num_values) \brief Pre-allocate space for data.
void	Reset() \brief Clear consumed values and repetition/definition levels as the result of calling ReadRecords
void	SetPageReader(PageReader reader) \brief Advance record reader to the next row group
long	values_written() \brief Number of values written including nulls (if any)
BytePointer	values() \brief Decoded values, including nulls, if any

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordReader

public RecordReader(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Make

@SharedPtr
public static RecordReader Make(@Const
                                            ColumnDescriptor descr,
                                            @ByVal
                                            LevelInfo leaf_info,
                                            MemoryPool pool,
                                            @Cast(value="const bool")
                                            boolean read_dictionary)

Make

@SharedPtr
public static RecordReader Make(@Const
                                            ColumnDescriptor descr,
                                            @ByVal
                                            LevelInfo leaf_info)

ReadRecords

@Cast(value="int64_t")
public long ReadRecords(@Cast(value="int64_t")
                                                long num_records)

\brief Attempt to read indicated number of records from column chunk

Returns:

number of records read

Reserve

public void Reserve(@Cast(value="int64_t")
                    long num_values)

\brief Pre-allocate space for data. Results in better flat read performance

Reset

public void Reset()

\brief Clear consumed values and repetition/definition levels as the result of calling ReadRecords

ReleaseValues

@SharedPtr
public ResizableBuffer ReleaseValues()

\brief Transfer filled values buffer to caller. A new one will be allocated in subsequent ReadRecords calls

ReleaseIsValid

@SharedPtr
public ResizableBuffer ReleaseIsValid()

\brief Transfer filled validity bitmap buffer to caller. A new one will be allocated in subsequent ReadRecords calls

HasMoreData

@Cast(value="bool")
public boolean HasMoreData()

\brief Return true if the record reader has more internal data yet to process

SetPageReader

public void SetPageReader(@UniquePtr
                          PageReader reader)

\brief Advance record reader to the next row group

Parameters:

reader - [in] obtained from RowGroupReader::GetColumnPageReader

DebugPrintState

public void DebugPrintState()

def_levels

public ShortPointer def_levels()

\brief Decoded definition levels

rep_levels

public ShortPointer rep_levels()

\brief Decoded repetition levels

values

@Cast(value="uint8_t*")
public BytePointer values()

\brief Decoded values, including nulls, if any

values_written

@Cast(value="int64_t")
public long values_written()

\brief Number of values written including nulls (if any)

levels_position

@Cast(value="int64_t")
public long levels_position()

\brief Number of definition / repetition levels (from those that have been decoded) that have been consumed inside the reader.

levels_written

@Cast(value="int64_t")
public long levels_written()

\brief Number of definition / repetition levels that have been written internally in the reader

null_count

@Cast(value="int64_t")
public long null_count()

\brief Number of nulls in the leaf

nullable_values

@Cast(value="bool")
public boolean nullable_values()

\brief True if the leaf values are nullable

read_dictionary

@Cast(value="bool")
public boolean read_dictionary()

\brief True if reading directly as Arrow dictionary-encoded