com.xpn.xwiki.plugin.watchlist
Class WatchListEventMatcher

java.lang.Object
  com.xpn.xwiki.plugin.watchlist.WatchListEventMatcher

public class WatchListEventMatcher
extends java.lang.Object

Matcher for WatchList events. This class store all the events fired during a given interval. It also allows to perform a match between events and elements watched by a user.

Version:

$Id: WatchListEventMatcher.java 24715 2009-10-26 11:42:49Z jvdrean $

Constructor Summary

WatchListEventMatcher(java.util.Date start, com.xpn.xwiki.XWikiContext context)
Constructor.

Method Summary

int	getEventNumber()
java.util.List<WatchListEvent>	getMatchingEvents(java.util.List<java.lang.String> wikis, java.util.List<java.lang.String> spaces, java.util.List<java.lang.String> documents, java.util.List<java.lang.String> users, java.lang.String userName, com.xpn.xwiki.XWikiContext context) Get the events matching criteria.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WatchListEventMatcher

public WatchListEventMatcher(java.util.Date start,
                             com.xpn.xwiki.XWikiContext context)

Constructor. Gets all the events fired during the interval between the given date and the current date.

Parameters:

context - the XWiki context

start - start date to use for document matching

Method Detail

getEventNumber

public int getEventNumber()

Returns:

the number of events the matcher will work with.

getMatchingEvents

public java.util.List<WatchListEvent> getMatchingEvents(java.util.List<java.lang.String> wikis,
                                                        java.util.List<java.lang.String> spaces,
                                                        java.util.List<java.lang.String> documents,
                                                        java.util.List<java.lang.String> users,
                                                        java.lang.String userName,
                                                        com.xpn.xwiki.XWikiContext context)

Get the events matching criteria.

Parameters:

wikis - a list of wikis from which events should match

spaces - a list of spaces from which events should match

documents - a list of documents from which events should match

users - a list of users from which events should match

userName - notification recipient

context - the XWiki context

Returns:

the list of events matching the given scopes