Package com.illumon.iris.binarystore

Class DelegatingBinaryStoreV2BufferProcessor

java.lang.Object

com.illumon.iris.binarystore.DelegatingBinaryStoreV2BufferProcessor

All Implemented Interfaces:

BinaryStoreBufferProcessor, BinaryStoreReader, TableReader

public final class DelegatingBinaryStoreV2BufferProcessor
extends Object
implements BinaryStoreBufferProcessor

Buffer processor for version 2 of the binary store protocol which delegates row buffer consumption to a BinaryStoreV2RowBufferProcessor rather than support the legacy RowGetter approach. This enables batch-oriented row processing for high-throughput ingestion.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DelegatingBinaryStoreV2BufferProcessor.UninitializedRecordHandler	Record handler to use when a real one has not yet been set, and hence records are unexpected.

Nested classes/interfaces inherited from interface com.illumon.iris.binarystore.BinaryStoreBufferProcessor

BinaryStoreBufferProcessor.ReadDataException

Nested classes/interfaces inherited from interface com.illumon.iris.binarystore.TableReader

TableReader.MissingPropertyGetterException

Constructor Summary

Constructors

Constructor	Description
DelegatingBinaryStoreV2BufferProcessor()	Construct a new delegating binary store V2 buffer processor.

Method Summary

Modifier and Type	Method	Description
void	close()	Close the input source for this TableReader.
boolean	delegatesRowBufferProcessing()	Check if this buffer processor delegates row buffer processing to a BinaryStoreV2RowBufferProcessor.
int	getApplicationVersion()	Get the application version associated with the file being read by this TableReader.
String[]	getColumnNames()	Get an array of all known column names.
SupportedType	getColumnType(String columnName)	Get the SupportedType of the named column.
RowGetter<Row.Flags>	getFlagGetter()	Retrieve the getter for the row flags.
RowGetter	getGetter(String name)	Return a raw RowGetter for the column with the given name.
<T> RowGetter<T>	getGetter(String name, Class<T> tClass)	Return a typed RowGetter for the column with the given name.
BinaryStoreV2HeaderInfo	getHeaderInfo()	Get information extracted from the last binary store header read.
<T> RowGetter<T>	getPropertyGetter(String property)	Retrieve a getter for the specified internal property.
Supplier<RecordData>	getRecordDataGetter()	Retrieve the getter for the RecordData.
boolean	isDirty()	Does this buffer processor contain inconsistent state that should prevent checkpointing?
boolean	readEntry()	Read a record from the source, expecting that not all records will be Row records.
void	readHeader(ByteBuffer headerBuffer)	Read a binary header from the given buffer.
boolean	readRow()	Deprecated.
void	setDataBuffer(ByteBuffer dataBuffer, long txTimestampMicros, long rxTimestampMicros)	The BinaryStoreBufferProcessors do not read their own data, but rather receive it externally through this call.
Runnable	setRecordHandler(Runnable recordHandler)	Set a record handler callback for this buffer processor.
BinaryStoreV2RowBufferProcessor	setRowBufferProcessor(BinaryStoreV2RowBufferProcessor rowBufferProcessor)	Set the BinaryStoreV2RowBufferProcessor that will be used to parse and process all row entries.
Runnable	setRowHandler(Runnable handler)	Set a row handler callback for this buffer processor.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.binarystore.TableReader

readAllEntries, readAllEntries

Constructor Details

DelegatingBinaryStoreV2BufferProcessor

public DelegatingBinaryStoreV2BufferProcessor()

Construct a new delegating binary store V2 buffer processor.

Method Details

readHeader

public void readHeader(@NotNull
 ByteBuffer headerBuffer)
                throws IOException

Read a binary header from the given buffer. This interface does not dictate anything about the BinaryStore implementation in the buffer. Implementations might make implementation-dependent actions to fill the buffer if there isn't enough data. byteBuffer.position will be advanced by the size of the header.

Specified by:

readHeader in interface BinaryStoreReader

Parameters:

headerBuffer - buffer containing the header, in reading mode

Throws:

IOException - an exception derived from IOException may be thrown if there isn't enough data in the buffer.

getHeaderInfo

public BinaryStoreV2HeaderInfo getHeaderInfo()

Description copied from interface: BinaryStoreBufferProcessor

Get information extracted from the last binary store header read. Only supported for delegating buffer processors.

Specified by:

getHeaderInfo in interface BinaryStoreBufferProcessor

Returns:

The header information

getColumnNames

public String[] getColumnNames()

Description copied from interface: TableReader

Get an array of all known column names. These can be used to determine valid column names for use in TableReader.getGetter(String).

Specified by:

getColumnNames in interface TableReader

Returns:

a new array of all known column names.

getColumnType

public SupportedType getColumnType(@NotNull
 String columnName)

Description copied from interface: TableReader

Get the SupportedType of the named column.

Specified by:

getColumnType in interface TableReader

Parameters:

columnName - the name of the column

Returns:

the SupportedType value for the named column

getApplicationVersion

public int getApplicationVersion()

Description copied from interface: TableReader

Get the application version associated with the file being read by this TableReader.

Specified by:

getApplicationVersion in interface TableReader

Returns:

the file's application version

setDataBuffer

public void setDataBuffer(@NotNull
 ByteBuffer dataBuffer,
 long txTimestampMicros,
 long rxTimestampMicros)

Description copied from interface: BinaryStoreBufferProcessor

The BinaryStoreBufferProcessors do not read their own data, but rather receive it externally through this call.

Specified by:

setDataBuffer in interface BinaryStoreBufferProcessor

Parameters:

dataBuffer - The buffer that this BinaryStoreBufferProcessor should consume data from.

txTimestampMicros - The time the buffer was produced, in microseconds from the epoch, or QueryConstants.NULL_LONG if unknown/unavailable

rxTimestampMicros - The timestamp when the buffer was received, in microseconds from the epoch

readEntry

public boolean readEntry()
                  throws IOException

Description copied from interface: TableReader

Read a record from the source, expecting that not all records will be Row records.
Note: The default implementation delegates to the now-deprecated TableReader.readRow(), which cannot handle record entries.

Specified by:

readEntry in interface TableReader

Returns:

true if successful, false if EOF or an error is encountered.

Throws:

IOException - if EOF is encountered mid-entry or any invalid data is encountered.

readRow

@Deprecated
public boolean readRow()
                throws IOException

Deprecated.

Description copied from interface: TableReader

Read a row from the source, expecting that all entries will be Rows. If a record entry is encountered, an IllegalStateException will be thrown.

Specified by:

readRow in interface TableReader

Returns:

true if successful, false if EOF or an error is encountered.

Throws:

IOException - if EOF is encountered mid-row or any invalid data is encountered.

setRowBufferProcessor

public BinaryStoreV2RowBufferProcessor setRowBufferProcessor(@NotNull
 BinaryStoreV2RowBufferProcessor rowBufferProcessor)

Description copied from interface: BinaryStoreBufferProcessor

Set the BinaryStoreV2RowBufferProcessor that will be used to parse and process all row entries. Only supported for delegating buffer processors.

Specified by:

setRowBufferProcessor in interface BinaryStoreBufferProcessor

Parameters:

rowBufferProcessor - The new BinaryStoreV2RowBufferProcessor

Returns:

The previous BinaryStoreV2RowBufferProcessor, or null if none was set

isDirty

public boolean isDirty()

Description copied from interface: BinaryStoreBufferProcessor

Does this buffer processor contain inconsistent state that should prevent checkpointing?

Specified by:

isDirty in interface BinaryStoreBufferProcessor

Returns:

Whether this buffer processor contains inconsistent state that should prevent checkpointing

getRecordDataGetter

public Supplier<RecordData> getRecordDataGetter()

Description copied from interface: TableReader

Retrieve the getter for the RecordData.

Specified by:

getRecordDataGetter in interface TableReader

Returns:

a getter that returns the data for the currently read record.

setRecordHandler

public Runnable setRecordHandler(@NotNull
 Runnable recordHandler)

Description copied from interface: BinaryStoreBufferProcessor

Set a record handler callback for this buffer processor.

Specified by:

setRecordHandler in interface BinaryStoreBufferProcessor

Parameters:

recordHandler - The replacement record handler

Returns:

The previous record handler

close

public void close()

Description copied from interface: TableReader

Close the input source for this TableReader.

Specified by:

close in interface TableReader

delegatesRowBufferProcessing

public boolean delegatesRowBufferProcessing()

Description copied from interface: BinaryStoreBufferProcessor

Check if this buffer processor delegates row buffer processing to a BinaryStoreV2RowBufferProcessor.

Delegating buffer processors do not support the following methods:

• BinaryStoreBufferProcessor.setRowHandler(Runnable)
• TableReader.getGetter(String)
• TableReader.getGetter(String, Class)
• TableReader.getFlagGetter()
• TableReader.getPropertyGetter(String)

Delegating buffer processors are the only ones that support the following methods:

• BinaryStoreBufferProcessor.getHeaderInfo()
• BinaryStoreBufferProcessor.setRowBufferProcessor(BinaryStoreV2RowBufferProcessor)

Specified by:

delegatesRowBufferProcessing in interface BinaryStoreBufferProcessor

Returns:

True of this buffer processor delegates row buffer processing

setRowHandler

public Runnable setRowHandler(@NotNull
 Runnable handler)

Description copied from interface: BinaryStoreBufferProcessor

Set a row handler callback for this buffer processor. Not supported for delegating buffer processors.

Specified by:

setRowHandler in interface BinaryStoreBufferProcessor

Parameters:

handler - The replacement row handler

Returns:

The previous row handler

getGetter

public RowGetter getGetter(String name)

Description copied from interface: TableReader

Return a raw RowGetter for the column with the given name. RowGetter.get() will return Object.

Specified by:

getGetter in interface TableReader

Parameters:

name - the column name

Returns:

a RowGetter

getGetter

public <T> RowGetter<T> getGetter(String name,
 Class<T> tClass)

Description copied from interface: TableReader

Return a typed RowGetter for the column with the given name. RowGetter.get() will return type tClass.

Specified by:

getGetter in interface TableReader

Parameters:

name - the column name

Returns:

a RowGetter of type tClass

getFlagGetter

public RowGetter<Row.Flags> getFlagGetter()

Description copied from interface: TableReader

Retrieve the getter for the row flags.

Specified by:

getFlagGetter in interface TableReader

Returns:

a getter that returns the flags for each row.

getPropertyGetter

public <T> RowGetter<T> getPropertyGetter(String property)

Description copied from interface: TableReader

Retrieve a getter for the specified internal property.

This method is intended for use with instrumentation.

Specified by:

getPropertyGetter in interface TableReader

Parameters:

property - The property to get a getter for

Returns:

A correctly typed getter for the property.