org.exoplatform.analytics.api.service

Interface AnalyticsService

public interface AnalyticsService

Method Summary

Modifier and Type	Method and Description
void	addUIWatcherPlugin(StatisticUIWatcherPlugin uiWatcherPlugin) Add watcher plugin
ChartDataList	computeChartData(AnalyticsFilter filter) Retrieve analytics chart data
List<String>	getAdministratorsPermissions()
StatisticWatcher	getUIWatcher(String name)
List<StatisticWatcher>	getUIWatchers()
List<String>	getViewAllPermissions()
List<String>	getViewPermissions()
List<StatisticData>	retrieveData(AnalyticsFilter searchFilter) Retrieve data using search filters
Set<StatisticFieldMapping>	retrieveMapping(boolean forceRefresh)

Method Detail

computeChartData

ChartDataList computeChartData(AnalyticsFilter filter)

Retrieve analytics chart data

Parameters:

filter - used search filters and aggregations to compute data

Returns:

computed analytics chart data

retrieveData

List<StatisticData> retrieveData(AnalyticsFilter searchFilter)

Retrieve data using search filters

Parameters:

searchFilter -

Returns:

List of StatisticData

retrieveMapping

Set<StatisticFieldMapping> retrieveMapping(boolean forceRefresh)

Parameters:

forceRefresh - whether force refresh from ES or not

Returns:

a Set of ES mapping fields

getAdministratorsPermissions

List<String> getAdministratorsPermissions()

Returns:

the analytics permission expression

getViewAllPermissions

List<String> getViewAllPermissions()

Returns:

the List of permission expression of users that can access all analytics datas

getViewPermissions

List<String> getViewPermissions()

Returns:

the List of permission expression of users that can access their (and their spaces they are member of) analytics datas

getUIWatchers

List<StatisticWatcher> getUIWatchers()

Returns:

List of StatisticWatcher containing DOM selectors of elements to watch

getUIWatcher

StatisticWatcher getUIWatcher(String name)

Parameters:

name - corresponding UI watcher name, see StatisticWatcher#getName()

Returns:

StatisticWatcher having switch corresponding name

addUIWatcherPlugin

void addUIWatcherPlugin(StatisticUIWatcherPlugin uiWatcherPlugin)

Add watcher plugin