ChunkedSpreadSheetReader (adams-pom 24.11.0-SNAPSHOT API)

All Superinterfaces:

Destroyable, ErrorProvider, FileFormatHandler, OptionHandler, Serializable, SpreadSheetReader, Stoppable, StoppableWithFeedback

All Known Implementing Classes:

AccessSpreadSheetReader, CsvSpreadSheetReader, FastCsvSpreadSheetReader, SimpleCsvSpreadSheetReader, SimpleStreamSpreadSheetReader, SqlDumpSpreadSheetReader, TsvSpreadSheetReader
```
public interface ChunkedSpreadSheetReader
extends SpreadSheetReader
```
Interface for spreadsheet readers that can read data in chunks rather than only all at once.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`chunkSizeTipText()`	Returns the tip text for this property.
`int`	`getChunkSize()`	Returns the current chunk size.
`boolean`	`hasMoreChunks()`	Checks whether there is more data to read.
`SpreadSheet`	`nextChunk()`	Returns the next chunk.
`void`	`setChunkSize(int value)`	Sets the maximum chunk size.

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.data.io.input.SpreadSheetReader
dataRowTypeTipText, getCorrespondingWriter, getDataRowType, getDefaultFormatExtension, getFormatDescription, getFormatExtensions, getLastError, getSpreadSheetType, hasLastError, isStopped, read, read, read, read, setDataRowType, setSpreadSheetType, spreadSheetTypeTipText, stopExecution

- Method Detail
  - setChunkSize
```
void setChunkSize(int value)
```
    Sets the maximum chunk size.
    
    Parameters:
    
    value - the size of the chunks, < 1 denotes infinity
  - getChunkSize
```
int getChunkSize()
```
    Returns the current chunk size.
    
    Returns:
    
    the size of the chunks, < 1 denotes infinity
  - chunkSizeTipText
```
String chunkSizeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the gui
  - hasMoreChunks
```
boolean hasMoreChunks()
```
    Checks whether there is more data to read.
    
    Returns:
    
    true if there is more data available
  - nextChunk
```
SpreadSheet nextChunk()
```
    Returns the next chunk.
    
    Returns:
    
    the next chunk