adams.data.io.input
Interface MultiSheetSpreadSheetReader

All Superinterfaces:

Destroyable, OptionHandler, SpreadSheetReader, Stoppable

All Known Implementing Classes:

AbstractMultiSheetSpreadSheetReader, AbstractMultiSheetSpreadSheetReaderWithMissingValueSupport, GnumericSpreadSheetReader

public interface MultiSheetSpreadSheetReader
extends SpreadSheetReader

Interface for spreadsheet readers that can read multiple sheets from the same document.

Version:

$Revision: 7023 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Range	getSheetRange() Returns the range of the sheets to load.
List<SpreadSheet>	readRange(File file) Reads the spreadsheet from the specified file.
List<SpreadSheet>	readRange(InputStream stream) Reads the spreadsheets from the stream.
List<SpreadSheet>	readRange(Reader r) Reads the spreadsheets from the given reader.
List<SpreadSheet>	readRange(String filename) Reads the spreadsheets from the given file.
void	setSheetRange(Range value) Sets the range of the sheets to load.
String	sheetRangeTipText() Returns the tip text for this property.

Methods inherited from interface adams.data.io.input.SpreadSheetReader

dataRowTypeTipText, getDataRowType, getFormatDescription, getFormatExtensions, isStopped, read, read, read, read, setDataRowType, stopExecution

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager

Methods inherited from interface adams.core.Destroyable

destroy

Method Detail

setSheetRange

void setSheetRange(Range value)

Sets the range of the sheets to load.

Parameters:

value - the range (1-based)

getSheetRange

Range getSheetRange()

Returns the range of the sheets to load.

Returns:

the range (1-based)

sheetRangeTipText

String sheetRangeTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

readRange

List<SpreadSheet> readRange(File file)

Reads the spreadsheet from the specified file.

Parameters:

file - the file to read from

Returns:

null in case of an error, otherwise the spreadsheet

readRange

List<SpreadSheet> readRange(String filename)

Reads the spreadsheets from the given file.

Parameters:

filename - the file to read from

Returns:

the spreadsheets or null in case of an error

readRange

List<SpreadSheet> readRange(InputStream stream)

Reads the spreadsheets from the stream. The caller must ensure to close the stream.

Parameters:

stream - the stream to read from

Returns:

the spreadsheets or null in case of an error

readRange

List<SpreadSheet> readRange(Reader r)

Reads the spreadsheets from the given reader. The caller must ensure to close the reader.

Parameters:

r - the reader to read from

Returns:

the spreadsheets or null in case of an error