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

Class UCharStreamingDataConsumer

java.lang.Object

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

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

public class UCharStreamingDataConsumer
extends StreamingDataConsumer

Specialized class representing a consumer of streaming chunks of UChar data. Created to help handling unsigned data types

Author:

mmilletti

Field Summary

Fields inherited from class com.pacbio.secondary.vis.io.hdf.streaming.StreamingDataConsumer

num_chunks, num_columns, num_rows

Constructor Summary

Constructors

Constructor and Description
UCharStreamingDataConsumer()

Method Summary

Methods

Modifier and Type	Method and Description
void	doneStreamingData() override if need opportunity for additional cleanup
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 com.pacbio.secondary.vis.io.hdf.streaming.StreamingDataConsumer

getNumChunks, getNumColumns, getNumRows

Methods inherited from class java.lang.Object

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

Constructor Detail

UCharStreamingDataConsumer

public UCharStreamingDataConsumer()

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. Override if need opportunity to allocate additional initializers, e.g. stats for percent processing

Overrides:

startStreamingData in class StreamingDataConsumer

Returns:

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

processStreamingDataChunk

public boolean processStreamingDataChunk(java.lang.Object obj)

This method receives a chunk of data as soon as it is read from the file. Override to do something useful with UChar data.. *

Specified by:

processStreamingDataChunk in class StreamingDataConsumer

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()

override if need opportunity for additional cleanup

Overrides:

doneStreamingData in class StreamingDataConsumer