com.xpn.xwiki.stats.impl.xwiki
Class XWikiStatsReader

java.lang.Object
  extended by com.xpn.xwiki.stats.impl.xwiki.XWikiStatsReader

public class XWikiStatsReader
extends Object

Reader statistics from XWiki database.

Since:
1.4M2
Version:
$Id: c2be1e87f1797b8caa59c9226d883ab04be4035c $

Constructor Summary
XWikiStatsReader()
           
 
Method Summary
 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. use getDocumentStatistics(String, Scope, Period, Range , XWikiContext) instead.
 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. use getRefererStatistics(String, Scope, Period, Range, XWikiContext) instead.
 List<VisitStats> getVisitStatistics(String action, Period period, Range range, XWikiContext context)
          Retrieves visit statistics.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XWikiStatsReader

public XWikiStatsReader()
Method Detail

getRecentActions

public Collection<Object> getRecentActions(String action,
                                           int size,
                                           XWikiContext context)
Return the statistics action stored.

Parameters:
action - the action.
size - the maximum size of the list to return.
context - the XWiki context.
Returns:
the list of recent statistics action stored.

getActionStatistics

public 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.

Parameters:
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.
Returns:
a map of (date, actionCount) pairs.

getDocumentStatistics

public List<DocumentStats> getDocumentStatistics(String action,
                                                 Scope scope,
                                                 Period period,
                                                 Range range,
                                                 XWikiContext context)
Retrieves document statistics.

Parameters:
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.
Returns:
A list of DocumentStats objects

getBackLinkStatistics

public List<DocumentStats> getBackLinkStatistics(String domain,
                                                 Scope scope,
                                                 Period period,
                                                 Range range,
                                                 XWikiContext context)
Retrieves back-link statistics.

Parameters:
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.
Returns:
a list of DocumentStats objects.

getRefererStatistics

public List<RefererStats> getRefererStatistics(String domain,
                                               Scope scope,
                                               Period period,
                                               Range range,
                                               XWikiContext context)
Retrieves referrer statistics.

Parameters:
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.
Returns:
a list of RefererStats objects.

getVisitStatistics

public List<VisitStats> getVisitStatistics(String action,
                                           Period period,
                                           Range range,
                                           XWikiContext context)
Retrieves visit statistics.

Parameters:
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.
Returns:
a list of VisitStats objects.

getDocMonthStats

@Deprecated
public DocumentStats getDocMonthStats(String docname,
                                                 String action,
                                                 Date month,
                                                 XWikiContext context)
Deprecated. use getDocumentStatistics(String, Scope, Period, Range , XWikiContext) instead.

Gets monthly statistics on a document for a specific action.

Parameters:
docname - fully qualified document name.
action - can be "view", "edit", "save", etc..
month - the month.
context - the XWiki context.
Returns:
DocumentStats - statistics object.

getRefMonthStats

@Deprecated
public List<?> getRefMonthStats(String docName,
                                           Date month,
                                           XWikiContext context)
                         throws XWikiException
Deprecated. use getRefererStatistics(String, Scope, Period, Range, XWikiContext) instead.

Gets monthly referer statistics.

Parameters:
docName - fully qualified document name.
month - the month.
context - the XWiki context.
Returns:
the monthly referer statistics.
Throws:
XWikiException - error when searching for referer statistics.


Copyright © 2004–2014 XWiki. All rights reserved.