WindowedSpreadSheetReader (adams-pom 24.5.0-SNAPSHOT API)

All Superinterfaces:

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

All Known Implementing Classes:

AbstractExcelSpreadSheetReader, AccessSpreadSheetReader, CsvSpreadSheetReader, ExcelSpreadSheetReader, ExcelStreamingSpreadSheetReader, FastCsvSpreadSheetReader, FixedTabularSpreadSheetReader, GnumericSpreadSheetReader, ODFSpreadSheetReader
```
public interface WindowedSpreadSheetReader
extends SpreadSheetReader
```
Allows the retrieval of a certain "window" of rows from the data.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`firstRowTipText()`	Returns the tip text for this property.
`int`	`getFirstRow()`	Returns the first row to return.
`int`	`getNumRows()`	Returns the number of data rows to return.
`String`	`numRowsTipText()`	Returns the tip text for this property.
`void`	`setFirstRow(int value)`	Sets the first row to return.
`void`	`setNumRows(int value)`	Sets the number of data rows to return.

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
  - setFirstRow
```
void setFirstRow(int value)
```
    Sets the first row to return.
    
    Parameters:
    
    value - the first row (1-based)
  - getFirstRow
```
int getFirstRow()
```
    Returns the first row to return.
    
    Returns:
    
    the first row (1-based)
  - firstRowTipText
```
String firstRowTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setNumRows
```
void setNumRows(int value)
```
    Sets the number of data rows to return.
    
    Parameters:
    
    value - the number of rows
  - getNumRows
```
int getNumRows()
```
    Returns the number of data rows to return.
    
    Returns:
    
    the number of rows
  - numRowsTipText
```
String numRowsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.