Package org.ametys.plugins.calendar.search

Class CalendarSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

org.ametys.web.frontoffice.search.requesttime.impl.SaxResultsSearchComponent

org.ametys.plugins.calendar.search.CalendarSearchComponent

All Implemented Interfaces:

LogEnabled, PluginAware, Prioritizable, Supporter<SearchComponentArguments>, SearchComponent, Serviceable

public class CalendarSearchComponent
extends SaxResultsSearchComponent
implements Serviceable

SearchComponent to sax calendar events results resulting of contents' search and/or external ICS

Field Summary

Fields inherited from interface org.ametys.web.frontoffice.search.requesttime.SearchComponent

DISABLE_DEFAULT_SAX_PARAMETER_NAME, MAX_PRIORITY, MIN_PRIORITY, SEARCH_PRIORITY

Constructor Summary

Constructors

Constructor	Description
CalendarSearchComponent()

Method Summary

Modifier and Type	Method	Description
void	execute(SearchComponentArguments args)	Executes the component.
protected void	saxDangeRange(ContentHandler handler, EventsFilterHelper.DateTimeRange dateRange, int total)	SAx date range
protected void	saxICSHits(ContentHandler handler, List<IcsReader.IcsEvents> icsResults, EventsFilterHelper.DateTimeRange dateRange, List<String> filteredTags, int start)	SAX results resulting of external ICS
void	service(ServiceManager smanager)
boolean	supports(SearchComponentArguments args)	Check if an element is supported

Methods inherited from class org.ametys.web.frontoffice.search.requesttime.impl.SaxResultsSearchComponent

getPriority, getResults, getSaxer, saxHit, saxHits, saxPagination, total

Methods inherited from class org.ametys.web.frontoffice.search.requesttime.AbstractSearchComponent

getId, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarSearchComponent

public CalendarSearchComponent()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<SearchComponentArguments>

Overrides:

supports in class SaxResultsSearchComponent

Parameters:

args - The element

Returns:

true if the element is supported, false otherwise

execute

public void execute(SearchComponentArguments args)
             throws Exception

Description copied from interface: SearchComponent

Executes the component.

Specified by:

execute in interface SearchComponent

Overrides:

execute in class SaxResultsSearchComponent

Parameters:

args - the arguments

Throws:

Exception - if an exception occurs. Other search components will be attempted to be executed

saxICSHits

protected void saxICSHits(ContentHandler handler,
 List<IcsReader.IcsEvents> icsResults,
 EventsFilterHelper.DateTimeRange dateRange,
 List<String> filteredTags,
 int start)
                   throws SAXException

SAX results resulting of external ICS

Parameters:

handler - the content handler

icsResults - the ICS events

dateRange - the date range

filteredTags - A list of tag's name to filter ICS events. If empty no filter is applied.

start - the start index

Throws:

SAXException - if an error occured

saxDangeRange

protected void saxDangeRange(ContentHandler handler,
 EventsFilterHelper.DateTimeRange dateRange,
 int total)
                      throws SAXException

SAx date range

Parameters:

handler - the content handler

dateRange - the date range

total - the total hits in date range

Throws:

SAXException - if an error occured