Package hec.io

Class TimeSeriesContainerFactory

java.lang.Object

hec.io.TimeSeriesContainerFactory

public final class TimeSeriesContainerFactory
extends Object

Factory class for converting data to/from TimeSeriesContainer objects

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TimeSeriesContainerFactory.TimeSeriesContainerConverter

Method Summary

Modifier and Type	Method	Description
static mil.army.usace.hec.data.timeseries.TimeSeries	toTimeSeries(TimeSeriesContainer timeSeriesContainer)	Converts a TimeSeriesContainer to a TimeSeries object.
static mil.army.usace.hec.data.timeseries.TimeSeries	toTimeSeries(TimeSeriesContainer timeSeriesContainer, ZoneId defaultDataZoneId)	Converts a TimeSeriesContainer to a TimeSeries object.
static mil.army.usace.hec.data.timeseries.TimeSeries	toTimeSeries(TimeSeriesContainer timeSeriesContainer, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier identifier)	Converts a TimeSeriesContainer object along with a TimeSeriesIdentifier for conversion to a TimeSeries object.
static mil.army.usace.hec.data.timeseries.TimeSeries	toTimeSeries(TimeSeriesContainer timeSeriesContainer, mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier identifier, ZoneId defaultDataZoneId)	Converts a TimeSeriesContainer object along with a TimeSeriesIdentifier for conversion to a TimeSeries object.
static TimeSeriesContainer	toTimeSeriesContainer(mil.army.usace.hec.data.timeseries.TimeSeries timeSeries)	Converts a TimeSeries to a TimeSeriesContainer object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toTimeSeries

public static mil.army.usace.hec.data.timeseries.TimeSeries toTimeSeries(TimeSeriesContainer timeSeriesContainer,
 mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier identifier)
                                                                  throws mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException

Converts a TimeSeriesContainer object along with a TimeSeriesIdentifier for conversion to a TimeSeries object. Some metadata like office id and interval logic (for local regular intervals specifically) are not provided by TimeSeriesContainer so the TimeSeriesIdentifier parameter is used to allow for full metadata coverage.

Parameters:

timeSeriesContainer - container with timeseries data and metadata

identifier - metadata from the identifier will be used instead of the metadata in the TimeSeriesContainer

Throws:

mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException - thrown if TimeSeriesContainer cannot extract hec-nucleus data types or if the timeSeriesContainer does not have a data time zone.

toTimeSeries

public static mil.army.usace.hec.data.timeseries.TimeSeries toTimeSeries(TimeSeriesContainer timeSeriesContainer,
 mil.army.usace.hec.metadata.timeseries.TimeSeriesIdentifier identifier,
 ZoneId defaultDataZoneId)
                                                                  throws mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException

Converts a TimeSeriesContainer object along with a TimeSeriesIdentifier for conversion to a TimeSeries object. Some metadata like office id and interval logic (for local regular intervals specifically) are not provided by TimeSeriesContainer so the TimeSeriesIdentifier parameter is used to allow for full metadata coverage.

Parameters:

timeSeriesContainer - container with timeseries data and metadata

identifier - metadata from the identifier will be used instead of the metadata in the TimeSeriesContainer

defaultDataZoneId - used if the timeSeriesContainer does not have a time zone for the data

Throws:

mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException - thrown if TimeSeriesContainer cannot extract hec-nucleus data types

toTimeSeries

public static mil.army.usace.hec.data.timeseries.TimeSeries toTimeSeries(TimeSeriesContainer timeSeriesContainer)
                                                                  throws mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException

Converts a TimeSeriesContainer to a TimeSeries object. Some metadata like office id and interval logic (for local regular intervals specifically) are not provided by TimeSeriesContainer. If that extra metadata is needed, use the TimeSeriesIdentifier overload instead.

Parameters:

timeSeriesContainer - container with timeseries data and metadata

Throws:

mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException - thrown if TimeSeriesContainer cannot extract hec-nucleus data types or if the timeSeriesContainer does not have a data time zone.

toTimeSeries

public static mil.army.usace.hec.data.timeseries.TimeSeries toTimeSeries(TimeSeriesContainer timeSeriesContainer,
 ZoneId defaultDataZoneId)
                                                                  throws mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException

Converts a TimeSeriesContainer to a TimeSeries object. Some metadata like office id and interval logic (for local regular intervals specifically) are not provided by TimeSeriesContainer. If that extra metadata is needed, use the TimeSeriesIdentifier overload instead.

Parameters:

timeSeriesContainer - container with timeseries data and metadata

defaultDataZoneId - used if the timeSeriesContainer does not have a time zone for the data

Throws:

mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException - thrown if TimeSeriesContainer cannot extract hec-nucleus data types

toTimeSeriesContainer

public static TimeSeriesContainer toTimeSeriesContainer(mil.army.usace.hec.data.timeseries.TimeSeries timeSeries)
                                                 throws mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException

Converts a TimeSeries to a TimeSeriesContainer object.

Parameters:

timeSeries - timeseries data and metadata

Throws:

mil.army.usace.hec.metadata.timeseries.DataSetTimeSeriesException - thrown if TimeSeriesContainer cannot extract hec-nucleus data types