com.pacbio.secondary.vis.io.hdf.streaming

Class StreamingDataConsumer

java.lang.Object

com.pacbio.secondary.vis.io.hdf.streaming.StreamingDataConsumer

Direct Known Subclasses:

UCharStreamingDataConsumer, UIntStreamingDataConsumer

public abstract class StreamingDataConsumer
extends java.lang.Object

Abstract class representing a consumer of streaming chunks of data. Its three methods are called at start of transfer, for each data block and end of transfer. Retrieving of data can be stopped at any time by returning false inside processStreamingDataChunk().

Author:

mmilletti

Field Summary

Fields

Modifier and Type	Field and Description
protected long	num_chunks
protected long	num_columns
protected long	num_rows

Constructor Summary

Constructors

Constructor and Description
StreamingDataConsumer()

Method Summary

Methods

Modifier and Type	Method and Description
void	doneStreamingData() this method is called at the end of data transfer after all data has been read.
long	getNumChunks()
long	getNumColumns()
long	getNumRows()
abstract boolean	processStreamingDataChunk(java.lang.Object obj) this method receives a chunk of data as soon as it is read from the file
boolean	startStreamingData(long num_rows, long num_columns, long num_chunks) this method is called at the start of data transfer and receives the dimensions of the transfer, num_rows and num_columns, and number of chunks that will be streamed.

Methods inherited from class java.lang.Object

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

Field Detail

num_rows

protected long num_rows

num_columns

protected long num_columns

num_chunks

protected long num_chunks

Constructor Detail

StreamingDataConsumer

public StreamingDataConsumer()

Method Detail

startStreamingData

public boolean startStreamingData(long num_rows,
                         long num_columns,
                         long num_chunks)

this method is called at the start of data transfer and receives the dimensions of the transfer, num_rows and num_columns, and number of chunks that will be streamed. This gives the consumer a chance to optimally pre-allocate memory if desired

Parameters:

num_chunks -

Returns:

true if data streaming should start, false to stop further reading

processStreamingDataChunk

public abstract boolean processStreamingDataChunk(java.lang.Object obj)

this method receives a chunk of data as soon as it is read from the file

Parameters:

obj - chunk of data received by hdf library

Returns:

true if data read should continue, false to stop reading of additional data

doneStreamingData

public void doneStreamingData()

this method is called at the end of data transfer after all data has been read. This gives the consumer a chance for cleanup such as freeing memory if desired

getNumRows

public long getNumRows()

Returns:

total number of rows

getNumColumns

public long getNumColumns()

Returns:

total columns

getNumChunks

public long getNumChunks()

Returns:

total number of chunks for the selected data range