Package adams.data.io.input

Interface DataContainerReader<T extends DataContainer>

Type Parameters:

T - the type of data to read

All Superinterfaces:

AdditionalInformationHandler, CleanUpHandler, Comparable, Destroyable, FileFormatHandler, OptionHandler, ShallowCopySupporter<DataContainerReader>

All Known Subinterfaces:

StreamableBinaryDataContainerReader<T>, StreamableDataContainerReader<T>, StreamableTextBasedDataContainerReader<T>

All Known Implementing Classes:

AbstractDataContainerReader, AbstractTimeseriesReader, ByteArrayToDataContainer.DummyReader, InstanceReader, SimpleTimeseriesReader, SpreadSheetTimeseriesReader, StringToDataContainer.DummyReader

public interface DataContainerReader<T extends DataContainer>
extends OptionHandler, Comparable, CleanUpHandler, ShallowCopySupporter<DataContainerReader>, FileFormatHandler, AdditionalInformationHandler

Interface for readers that read files in various formats and turn them into data containers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	createDummyReportTipText()	Returns the tip text for this property.
boolean	getCreateDummyReport()	Returns whether to create a dummy report if none present.
PlaceholderFile	getInput()	The file/directory to read.
String	inputTipText()	Returns the tip text for this property.
boolean	isInputFile()	Returns whether the input needs to be a file or directory.
List<T>	read()	Returns the data containers generated from the file.
void	setCreateDummyReport(boolean value)	Sets whether to create a dummy report if none present.
void	setInput(PlaceholderFile value)	Sets the file/directory to read.

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension, getFormatDescription, getFormatExtensions

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Method Detail

isInputFile

boolean isInputFile()

Returns whether the input needs to be a file or directory.

Returns:

true if the input needs to be a file, a directory otherwise

setInput

void setInput(PlaceholderFile value)

Sets the file/directory to read.

Parameters:

value - the file/directory to read

getInput

PlaceholderFile getInput()

The file/directory to read.

Returns:

the file/directory to read

inputTipText

String inputTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setCreateDummyReport

void setCreateDummyReport(boolean value)

Sets whether to create a dummy report if none present.

Parameters:

value - if true then a dummy report is generated if necessary

getCreateDummyReport

boolean getCreateDummyReport()

Returns whether to create a dummy report if none present.

Returns:

true if a dummy report is generated if necessary

createDummyReportTipText

String createDummyReportTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

read

List<T> read()

Returns the data containers generated from the file. If necessary, performs the parsing (e.g., if not yet read).

Returns:

the data containers generated from the file