Package org.ametys.plugins.calendar.icsreader

Class IcsEventHelper

java.lang.Object

org.ametys.plugins.calendar.icsreader.IcsEventHelper

All Implemented Interfaces:

Component, Serviceable

public class IcsEventHelper
extends Object
implements Component, Serviceable

Helper from ICS events

Field Summary

Fields

Modifier and Type	Field	Description
protected IcsReader	_icsReader	The ICS reader
protected TagProviderExtensionPoint	_tagProviderEP	The tag provider extention point
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
IcsEventHelper()

Method Summary

Modifier and Type	Method	Description
protected void	_saxAllDay(ContentHandler handler, LocalVEvent icsEvent)	Sax all day property
protected void	_saxDate(ContentHandler handler, String tagName, Date date)	Sax ICS date
List<IcsReader.IcsEvents>	getICSEvents(ZoneItem zoneItem, String siteName, EventsFilterHelper.DateTimeRange dateRange)	Read the configured distant ics sources into a list of IcsReader.IcsEvents
List<IcsReader.IcsEvents>	getICSEvents(ZoneItem zoneItem, String siteName, EventsFilterHelper.DateTimeRange dateRange, Long nbEvents, Long maxFileSize)	Read the configured distant ics sources into a list of IcsReader.IcsEvents
Set<Tag>	getIcsTags(ZoneItem zoneItem, String siteName)	Get the ICS tags from search service
void	saxICSErrors(List<IcsReader.IcsEvents> icsResults, ContentHandler handler)	Sax ICS errors
void	saxIcsEvent(ContentHandler handler, LocalVEvent icsEvent)	SAX a ics event
void	saxIcsEventHit(ContentHandler handler, LocalVEvent icsEvent, int number)	SAX a ics events hit
void	saxIcsEventHits(ContentHandler handler, List<LocalVEvent> icsEvents, int startNumber)	SAX ics events hits
void	service(ServiceManager smanager)
Pair<List<LocalVEvent>,String>	toLocalIcsEvent(List<IcsReader.IcsEvents> icsEventsList, EventsFilterHelper.DateTimeRange dateRange)	Get a list of LocalVEvent form the list of IcsReader.IcsEvents
Pair<List<LocalVEvent>,String>	toLocalIcsEvent(List<IcsReader.IcsEvents> icsEventsList, EventsFilterHelper.DateTimeRange dateRange, List<String> filteredTags)	Get a list of LocalVEvent form the list of IcsReader.IcsEvents
String	toVTimeZone(List<IcsReader.IcsEvents> icsEventsList, EventsFilterHelper.DateTimeRange dateRange, List<String> filteredTags)	Get a list of LocalVEvent form the list of IcsReader.IcsEvents

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

_icsReader

protected IcsReader _icsReader

The ICS reader

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tag provider extention point

Constructor Details

IcsEventHelper

public IcsEventHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getICSEvents

public List<IcsReader.IcsEvents> getICSEvents(ZoneItem zoneItem,
 String siteName,
 EventsFilterHelper.DateTimeRange dateRange)

Read the configured distant ics sources into a list of IcsReader.IcsEvents

Parameters:

zoneItem - zoneItem where the configuration will be fetched

siteName - name of the current site

dateRange - range of dates to limit

Returns:

a list of IcsReader.IcsEvents

getICSEvents

public List<IcsReader.IcsEvents> getICSEvents(ZoneItem zoneItem,
 String siteName,
 EventsFilterHelper.DateTimeRange dateRange,
 Long nbEvents,
 Long maxFileSize)

Read the configured distant ics sources into a list of IcsReader.IcsEvents

Parameters:

zoneItem - zoneItem where the configuration will be fetched

siteName - name of the current site

dateRange - range of dates to limit

nbEvents - number of events to read

maxFileSize - max ics file size (in bytes)

Returns:

a list of IcsReader.IcsEvents

getIcsTags

public Set<Tag> getIcsTags(ZoneItem zoneItem,
 String siteName)

Get the ICS tags from search service

Parameters:

zoneItem - The zone item id

siteName - the site name

Returns:

the ICS tags

toLocalIcsEvent

public Pair<List<LocalVEvent>,String> toLocalIcsEvent(List<IcsReader.IcsEvents> icsEventsList,
 EventsFilterHelper.DateTimeRange dateRange)

Get a list of LocalVEvent form the list of IcsReader.IcsEvents

Parameters:

icsEventsList - the list of IcsReader.IcsEvents

dateRange - range of dates to limit

Returns:

a list of LocalVEvent

toLocalIcsEvent

public Pair<List<LocalVEvent>,String> toLocalIcsEvent(List<IcsReader.IcsEvents> icsEventsList,
 EventsFilterHelper.DateTimeRange dateRange,
 List<String> filteredTags)

Get a list of LocalVEvent form the list of IcsReader.IcsEvents

Parameters:

icsEventsList - the list of IcsReader.IcsEvents

dateRange - range of dates to limit

filteredTags - A list of tag's name to filter ICS events. Can be empty to no filter on tags.

Returns:

a list of LocalVEvent

toVTimeZone

public String toVTimeZone(List<IcsReader.IcsEvents> icsEventsList,
 EventsFilterHelper.DateTimeRange dateRange,
 List<String> filteredTags)

Get a list of LocalVEvent form the list of IcsReader.IcsEvents

Parameters:

icsEventsList - the list of IcsReader.IcsEvents

dateRange - range of dates to limit

filteredTags - A list of tag's name to filter ICS events. Can be empty to no filter on tags.

Returns:

a list of LocalVEvent

saxIcsEventHits

public void saxIcsEventHits(ContentHandler handler,
 List<LocalVEvent> icsEvents,
 int startNumber)
                     throws SAXException

SAX ics events hits

Parameters:

handler - the content handler

icsEvents - The ics events

startNumber - the start index

Throws:

SAXException - if an error occurred while saxing

saxIcsEventHit

public void saxIcsEventHit(ContentHandler handler,
 LocalVEvent icsEvent,
 int number)
                    throws SAXException

SAX a ics events hit

Parameters:

handler - the content handler

icsEvent - The ics event

number - the hit index

Throws:

SAXException - if an error occurred while saxing

saxIcsEvent

public void saxIcsEvent(ContentHandler handler,
 LocalVEvent icsEvent)
                 throws SAXException

SAX a ics event

Parameters:

handler - the content handler

icsEvent - The ics event

Throws:

SAXException - if an error occurred while saxing

_saxAllDay

protected void _saxAllDay(ContentHandler handler,
 LocalVEvent icsEvent)
                   throws SAXException

Sax all day property

Parameters:

handler - the content handler

icsEvent - the ICS event

Throws:

SAXException - if an error occurred while saxing

_saxDate

protected void _saxDate(ContentHandler handler,
 String tagName,
 Date date)
                 throws SAXException

Sax ICS date

Parameters:

handler - the content handler

tagName - the xml tag name

date - the date to sax

Throws:

SAXException - if an error occurred while saxing

saxICSErrors

public void saxICSErrors(List<IcsReader.IcsEvents> icsResults,
 ContentHandler handler)
                  throws SAXException

Sax ICS errors

Parameters:

icsResults - the ICS events

handler - the content handler

Throws:

SAXException - if an error occurred