Package org.opencastproject.statistics.api

Interface TimeSeriesProvider

All Superinterfaces:

StatisticsProvider

All Known Implementing Classes:

InfluxRunningTotalStatisticsProvider, InfluxTimeSeriesStatisticsProvider, MatomoTimeSeriesStatisticsProvider, RandomStatisticsProvider

public interface TimeSeriesProvider
extends StatisticsProvider

A provider which provied time series data.

Method Summary

Modifier and Type	Method	Description
Set<DataResolution>	getDataResolutions()
TimeSeries	getValues(String resourceId, Instant from, Instant to, DataResolution resolution, ZoneId zoneId)	Get the time series data provided by this provider.

Methods inherited from interface org.opencastproject.statistics.api.StatisticsProvider

getDescription, getId, getResourceType, getTitle

Method Details

getValues

TimeSeries getValues(String resourceId,
 Instant from,
 Instant to,
 DataResolution resolution,
 ZoneId zoneId)

Get the time series data provided by this provider.

Parameters:

resourceId - The id to access the resource to get statistics for (e.g. episode Id, organization Id or series Id).

from - The start date to calculate the statistics for.

to - The end date to calculate the statistics for.

resolution - The resolution to get the statistics with.

zoneId - The timezone to use for date calculations.

Returns:

The time series data.

getDataResolutions

Set<DataResolution> getDataResolutions()

Returns:

A set of DataResolutions supported by this provider.