com.opengamma.strata.calc.marketdata

Interface TimeSeriesProvider

public interface TimeSeriesProvider

A provider of time-series.

This plugin point allows a market data supplier of time-series to be provided.

Method Summary

Modifier and Type	Method and Description
static TimeSeriesProvider	empty() Returns a time-series provider that returns an empty time-series for any ID.
static TimeSeriesProvider	none() Returns a time-series provider that is unable to source any time-series.
Result<LocalDateDoubleTimeSeries>	provideTimeSeries(ObservableId identifier) Provides the time-series for the specified identifier.

Method Detail

none

static TimeSeriesProvider none()

Returns a time-series provider that is unable to source any time-series.

All requests for a time-series will return a failure. This is used to validate that no time-series have been requested that were not already supplied in the input to the market data factory.

Returns:

the time-series provider

empty

static TimeSeriesProvider empty()

Returns a time-series provider that returns an empty time-series for any ID.

All requests for a time-series will succeed, returning an empty time-series. This is used for those cases where time-series are considered optional.

Returns:

the time-series provider

provideTimeSeries

Result<LocalDateDoubleTimeSeries> provideTimeSeries(ObservableId identifier)

Provides the time-series for the specified identifier.

The implementation will provide a time-series for the identifier, returning a failure if unable to do so.

Parameters:

identifier - the market data identifier to find

Returns:

the time-series of market data for the specified identifier