Package org.opencastproject.statistics.api

Interface StatisticsProvider

All Known Subinterfaces:

TimeSeriesProvider

All Known Implementing Classes:

InfluxRunningTotalStatisticsProvider, InfluxStatisticsProvider, InfluxTimeSeriesStatisticsProvider, MatomoStatisticsProvider, MatomoTimeSeriesStatisticsProvider, RandomStatisticsProvider

public interface StatisticsProvider

Provider for statistics. A provider may provide statistics for only one ResourceType, but for different DataResolutions. So e.g. there may be an "EpisodeViewsProvider" which provides the view counts of episodes on a daily, monthly, and yearly basis.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getId()
ResourceType	getResourceType()
String	getTitle()

Method Details

getId

String getId()

Returns:

The unique identifier of the provider.

getResourceType

ResourceType getResourceType()

Returns:

The type of resources this provider provides statistics for.

getTitle

String getTitle()

Returns:

A title to display with the charts generated from the statistics provided by this provider. This should be a translation string key.

getDescription

String getDescription()

Returns:

A description to display with the charts generated from the statistics provided by this provider. This should be a translation string key.