net.sourceforge.openforecast.input

Interface Builder

All Known Implementing Classes:

AbstractBuilder, CSVBuilder, ResultSetBuilder, TimeSeriesBuilder

public interface Builder

An interface that defines the minimal requirements for a class to be considered a "builder". This serves to bring some consistency between the potentially very different builder classes.

A class that implements the Builder interface generally provides some means of obtaining data and using that data to build a DataSet - a collection of DataPoints - or, in some cases, a single DataPoint from that data.

Since:

0.4

Method Summary

Modifier and Type	Method and Description
DataSet	build() Retrieves a DataSet - a collection of DataPoints - from the current input source.

Method Detail

build

DataSet build()
       throws java.lang.Exception

Retrieves a DataSet - a collection of DataPoints - from the current input source. The DataSet should contain all DataPoints defined by the input source.

Returns:

a DataSet built from the current input source.

Throws:

java.lang.Exception - if an error occurred reading from the input source.