com.xpn.xwiki.plugin.calendar
Class CalendarData

java.lang.Object
  com.xpn.xwiki.plugin.calendar.CalendarData

public class CalendarData
extends java.lang.Object

CalendarData stores a list of events that can be displayed in an Event Calendar. The internal data is of type CalendarEvent. The list can be populated with CalendarEvent XWiki objects from a document, with document names retrieved by a custom hibernate query, or with recently changed document names.

Constructor Summary

CalendarData()
Default constructor.

CalendarData(java.lang.String hql, int nb, XWikiContext context)

CalendarData(java.lang.String hql, java.lang.String user, XWikiContext context)

CalendarData(java.lang.String user, XWikiContext context)
The most used constructor, which populates the list with CalendarEvent XWiki objects from the current document.

CalendarData(com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String user, XWikiContext context)

Method Summary

void	addCalendarData(java.util.Calendar dateStart, java.util.Calendar dateEnd, java.lang.String user, java.lang.String description)
void	addCalendarData(CalendarEvent event)
void	addCalendarData(java.util.Date dateStart, java.util.Date dateEnd, java.lang.String user, java.lang.String description)
void	addCalendarData(com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String defaultUser, XWikiContext context) List populating method.
java.util.List	getCalendarData()
java.util.List	getCalendarData(java.util.Calendar date)
java.lang.String	getContent(java.util.Calendar tddate, java.lang.String filteredUser, java.lang.String filteredLocation, java.util.List filteredCategories, XWikiContext context)
java.lang.String	getContent(java.util.Calendar tddate, java.lang.String velocityScript, XWikiContext context)
java.lang.String	getContent(java.util.Calendar tddate, XWikiContext context)
java.util.Map	getMappedCalendarData()

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarData

public CalendarData()

Default constructor. Leaves the list of events empty.

CalendarData

public CalendarData(java.lang.String user,
                    XWikiContext context)
             throws XWikiException

The most used constructor, which populates the list with CalendarEvent XWiki objects from the current document.

Parameters:

user - The default user to be used.

context - The request context

Throws:

XWikiException

CalendarData

public CalendarData(com.xpn.xwiki.doc.XWikiDocument doc,
                    java.lang.String user,
                    XWikiContext context)
             throws XWikiException

Throws:

XWikiException

CalendarData

public CalendarData(java.lang.String hql,
                    java.lang.String user,
                    XWikiContext context)
             throws XWikiException

Throws:

XWikiException

CalendarData

public CalendarData(java.lang.String hql,
                    int nb,
                    XWikiContext context)
             throws XWikiException

Throws:

XWikiException

Method Detail

getCalendarData

public java.util.List getCalendarData()

getMappedCalendarData

public java.util.Map getMappedCalendarData()

getCalendarData

public java.util.List getCalendarData(java.util.Calendar date)

addCalendarData

public void addCalendarData(com.xpn.xwiki.doc.XWikiDocument doc,
                            java.lang.String defaultUser,
                            XWikiContext context)
                     throws XWikiException

List populating method. It iterates the CalendarEvent objects stored in the given document and creates Java wrappers that can be used by the Calendar plugin.

Parameters:

doc - The source document, populated with CalendarEvent objects.

defaultUser - The username to be used ig objects do not have a User field.

Throws:

XWikiException

getContent

public java.lang.String getContent(java.util.Calendar tddate,
                                   XWikiContext context)

getContent

public java.lang.String getContent(java.util.Calendar tddate,
                                   java.lang.String filteredUser,
                                   java.lang.String filteredLocation,
                                   java.util.List filteredCategories,
                                   XWikiContext context)

getContent

public java.lang.String getContent(java.util.Calendar tddate,
                                   java.lang.String velocityScript,
                                   XWikiContext context)

addCalendarData

public void addCalendarData(CalendarEvent event)

addCalendarData

public void addCalendarData(java.util.Calendar dateStart,
                            java.util.Calendar dateEnd,
                            java.lang.String user,
                            java.lang.String description)

addCalendarData

public void addCalendarData(java.util.Date dateStart,
                            java.util.Date dateEnd,
                            java.lang.String user,
                            java.lang.String description)