net.agmodel.physical
Interface DataSet

All Superinterfaces:

Serializable, ServerResult

All Known Subinterfaces:

StationDataSet

All Known Implementing Classes:

DataSetImpl, StationDataSetImpl

public interface DataSet

extends ServerResult

Interface to classes encapsulating a set of related data for a given period, resolution

Author:

Matthew Laurenson

Method Summary

String	dumpDuration(DateFormat df, String delimiter, String rowTerminator, String timeHeader, String noData) Returns a string representation of the entire data set
Interval	getInterval() Gets the interval covered by the data set
int	getNumberOfRows() Gets the number of rows of data based on the data set's duration and resolution
int	getNumberOfSequences() Gets the number of data sequences
Duration	getResolution() Gets the resolution of the data set
Sequence	getSequence(Object key) Returns a sequence from the data set.

Method Detail

getInterval

public Interval getInterval()

Gets the interval covered by the data set

Returns:

the interval

getResolution

public Duration getResolution()

Gets the resolution of the data set

Returns:

the resolution (eg hourly or daily)

getNumberOfRows

public int getNumberOfRows()

Gets the number of rows of data based on the data set's duration and resolution

Returns:

the number of rows

getNumberOfSequences

public int getNumberOfSequences()

Gets the number of data sequences

Returns:

the number of sequences

dumpDuration

public String dumpDuration(DateFormat df,
                           String delimiter,
                           String rowTerminator,
                           String timeHeader,
                           String noData)

Returns a string representation of the entire data set

Parameters:

df - a DateFormat to use for the dates and times

delimiter - the delimiter to put between the data items

rowTerminator - the string to use at the end of each row

timeHeader - a string to head the date/time column

noData - a string to show when there is no data

Returns:

a table of data, with colunn headings, and the first column being a date/time.

getSequence

public Sequence getSequence(Object key)

Returns a sequence from the data set.

Parameters:

key - an identifier for the required sequence.

Returns:

the required sequence.