Package org.ametys.plugins.calendar.search

Class CalendarSaxFormSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

org.ametys.plugins.calendar.search.CalendarSaxFormSearchComponent

All Implemented Interfaces:

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

public class CalendarSaxFormSearchComponent
extends SaxFormSearchComponent

SearchComponent for saxing form for calendar search service Reactivate default SaxFormSearchComponent (disabled by "disableDefaultSax" parameter)

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected IcsEventHelper	_icsEventHelper	Helper to get ICS events
protected JSONUtils	_jsonUtils	The JSON utils
protected TagProviderExtensionPoint	_tagProviderEP	The tags provider
protected UserPreferencesManager	_userPrefsManager	The user preferences manager

Fields inherited from class org.ametys.web.frontoffice.search.requesttime.impl.SaxFormSearchComponent

_contentHelper, _resolver

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
CalendarSaxFormSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_getCurrentSearchUserTagsFacet(String serviceId)	Get the current search user tags for the given service.
void	execute(SearchComponentArguments args)	Executes the component.
protected Set<Tag>	getTagCategories(List<String> categoryNames, SearchComponentArguments args)	Get the configured tag categories
protected void	saxTagFacet(ContentHandler handler, Collection<Tag> tags, SearchComponentArguments args)	Generate the list of tags
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.SaxFormSearchComponent

_isMandatory, getPriority, isMinimalFormSax, saxEnumeratorEntries, saxEnumeratorEntry, saxFacet, saxFacets, saxFormFields, saxFormSingleValue, saxFormValue, saxFormValues, saxSorts

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

Field Details

_icsEventHelper

protected IcsEventHelper _icsEventHelper

Helper to get ICS events

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tags provider

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

_userPrefsManager

protected UserPreferencesManager _userPrefsManager

The user preferences manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Details

CalendarSaxFormSearchComponent

public CalendarSaxFormSearchComponent()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class SaxFormSearchComponent

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 SaxFormSearchComponent

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 SaxFormSearchComponent

Parameters:

args - the arguments

Throws:

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

getTagCategories

protected Set<Tag> getTagCategories(List<String> categoryNames,
 SearchComponentArguments args)

Get the configured tag categories

Parameters:

categoryNames - The parent tag category

args - the search arguments

Returns:

the tags

saxTagFacet

protected void saxTagFacet(ContentHandler handler,
 Collection<Tag> tags,
 SearchComponentArguments args)
                    throws SAXException

Generate the list of tags

Parameters:

handler - the content handler

tags - the list of tags

args - the search arguments

Throws:

SAXException - if an error occurs while saxing

_getCurrentSearchUserTagsFacet

protected List<String> _getCurrentSearchUserTagsFacet(String serviceId)

Get the current search user tags for the given service.

Parameters:

serviceId - The service ID

Returns:

the current user tags if the user is authenticated and have saved filters for this service. Otherwise, it returns null.