Package adams.data.io.input

Interface NestedFlowReader

All Superinterfaces:

Destroyable, FileFormatHandler, FlowReader, OptionHandler

All Known Implementing Classes:

AbstractNestedFlowReader, DefaultFlowReader

public interface NestedFlowReader
extends FlowReader

Interface for flow readers that support the faster nested format.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
List	readNested(File file)	Reads the flow in nested format from the specified file.
List	readNested(InputStream stream)	Reads the flow in nested format from the stream.
List	readNested(String filename)	Reads the flow in nested format from the given file.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.io.FileFormatHandler

getDefaultFormatExtension, getFormatDescription, getFormatExtensions

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

getCorrespondingWriter, getErrors, getWarnings, readActor, readActor, readActor, readActor

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Method Detail

readNested

List readNested(File file)

Reads the flow in nested format from the specified file.

Parameters:

file - the file to read from

Returns:

null in case of an error, otherwise the flow

readNested

List readNested(String filename)

Reads the flow in nested format from the given file.

Parameters:

filename - the file to read from

Returns:

the flow or null in case of an error

readNested

List readNested(InputStream stream)

Reads the flow in nested format from the stream. The caller must ensure to close the stream.

Parameters:

stream - the stream to read from

Returns:

the flow or null in case of an error