public class XWikiStatsReader extends Object
| Constructor and Description |
|---|
XWikiStatsReader() |
| Modifier and Type | Method and Description |
|---|---|
Map<org.joda.time.DateTime,Integer> |
getActionStatistics(String action,
Scope scope,
Period period,
Duration step,
XWikiContext context)
Shows how the statistics for the specified action have evolved over the specified period of time.
|
List<DocumentStats> |
getBackLinkStatistics(String domain,
Scope scope,
Period period,
Range range,
XWikiContext context)
Retrieves back-link statistics.
|
DocumentStats |
getDocMonthStats(String docname,
String action,
Date month,
XWikiContext context)
Deprecated.
|
List<DocumentStats> |
getDocumentStatistics(String action,
Scope scope,
Period period,
Range range,
XWikiContext context)
Retrieves document statistics.
|
Collection<Object> |
getRecentActions(String action,
int size,
XWikiContext context)
Return the statistics action stored.
|
List<RefererStats> |
getRefererStatistics(String domain,
Scope scope,
Period period,
Range range,
XWikiContext context)
Retrieves referrer statistics.
|
List<?> |
getRefMonthStats(String docName,
Date month,
XWikiContext context)
Deprecated.
|
List<VisitStats> |
getVisitStatistics(String action,
Period period,
Range range,
XWikiContext context)
Retrieves visit statistics.
|
public Collection<Object> getRecentActions(String action, int size, XWikiContext context)
action - the action.size - the maximum size of the list to return.context - the XWiki context.public Map<org.joda.time.DateTime,Integer> getActionStatistics(String action, Scope scope, Period period, Duration step, XWikiContext context)
action - the action for which to retrieve statistics.scope - the set of documents to consider.period - the period of time, including its start date but excluding its end date.step - the step used for sampling the period.context - the XWiki context.public List<DocumentStats> getDocumentStatistics(String action, Scope scope, Period period, Range range, XWikiContext context)
action - the action the results should be ordered by. It can be one of: "view", "save" or "download". If the
action is "view" then the documents are ordered by the number of times they have been viewed so far.scope - the set of documents for which to retrieve statistics.period - the period of time, including its start date but excluding its end date.range - the sub-range to return from the entire result set. Use this parameter for pagination.context - the XWiki context.public List<DocumentStats> getBackLinkStatistics(String domain, Scope scope, Period period, Range range, XWikiContext context)
domain - the domain used for filtering the results.scope - the scope of referred documents for which to retrieve statistics.period - the period of time, including its start date but excluding its end date.range - the sub-range to return from the entire result set. Use this parameter for pagination.context - the XWiki context.public List<RefererStats> getRefererStatistics(String domain, Scope scope, Period period, Range range, XWikiContext context)
domain - the domain for which to retrieve statistics. To retrieve statistics for all domains use the empty
string.scope - the scope of referred documents to use for filtering the results.period - the period of time, including its start date but excluding its end date.range - the sub-range to return from the entire result set. Use this parameter for pagination.context - the XWiki context.public List<VisitStats> getVisitStatistics(String action, Period period, Range range, XWikiContext context)
action - the action the results should be ordered by. It can be one of: "view", "save" or "download". If the
action is "view" then the visitors are ordered by the number of pages they have viewed so far.period - the period of time, including its start date but excluding its end date.range - the sub-range to return from the entire result set. Use this parameter for pagination.context - the XWiki context.@Deprecated public DocumentStats getDocMonthStats(String docname, String action, Date month, XWikiContext context)
getDocumentStatistics(String, Scope, Period, Range , XWikiContext) instead.docname - fully qualified document name.action - can be "view", "edit", "save", etc..month - the month.context - the XWiki context.@Deprecated public List<?> getRefMonthStats(String docName, Date month, XWikiContext context) throws XWikiException
getRefererStatistics(String, Scope, Period, Range, XWikiContext) instead.docName - fully qualified document name.month - the month.context - the XWiki context.XWikiException - error when searching for referer statistics.Copyright © 2004–2022 XWiki. All rights reserved.