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

Class SaxGeneralDataSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CalendarSaxGeneralDataSearchComponent

public class SaxGeneralDataSearchComponent
extends AbstractSearchComponent
implements Configurable

SearchComponent executing in two parts: opening 'search' tag and SAXing general data, then closing 'search' tag.

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

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
protected void	saxAdditionalInfos(SearchComponentArguments args)	Generate any additional information.
protected void	saxAdditionalParameters(SearchComponentArguments args)	Generate the value of the AdditionalSearchServiceParameters
protected void	saxCacheable(SearchComponentArguments args, ZoneItem zoneItem)	Generate the "cacheable" status of the service instance
protected void	saxRSSFeedURL(ContentHandler contentHandler, SearchServiceInstance serviceInstance, ZoneItem zoneItem)	Generate the URL for RSS feed
protected void	saxServiceIdentifiers(SearchComponentArguments args, ZoneItem zoneItem)	Generate the service identifiers: service group ID, ZoneItem ID, ...
boolean	supports(SearchComponentArguments args)	Check if an element is supported

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

SaxGeneralDataSearchComponent

public SaxGeneralDataSearchComponent()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getPriority

public int getPriority()

Description copied from interface: Prioritizable

Get the priority for the component. On components using Prioritizable interface, each implementation define the order. In most cases, less is the number, more prior is the component.

Specified by:

getPriority in interface Prioritizable

Returns:

the priority

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: Supporter

Check if an element is supported

Specified by:

supports in interface Supporter<SearchComponentArguments>

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

Parameters:

args - the arguments

Throws:

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

saxServiceIdentifiers

protected void saxServiceIdentifiers(SearchComponentArguments args,
 ZoneItem zoneItem)
                              throws SAXException,
IOException,
ProcessingException

Generate the service identifiers: service group ID, ZoneItem ID, ...

Parameters:

args - The arguments

zoneItem - The zone item

Throws:

SAXException - if an error occurs SAXing data.

IOException - if an error occurs SAXing data.

ProcessingException - if a processing error occurs.

saxCacheable

protected void saxCacheable(SearchComponentArguments args,
 ZoneItem zoneItem)
                     throws SAXException

Generate the "cacheable" status of the service instance

Parameters:

args - The arguments

zoneItem - The zone item

Throws:

SAXException - if an error occurs SAXing data.

saxAdditionalParameters

protected void saxAdditionalParameters(SearchComponentArguments args)
                                throws SAXException

Generate the value of the AdditionalSearchServiceParameters

Parameters:

args - The arguments

Throws:

SAXException - if an error occurs SAXing data.

saxAdditionalInfos

protected void saxAdditionalInfos(SearchComponentArguments args)
                           throws SAXException,
IOException,
ProcessingException

Generate any additional information.

Parameters:

args - The arguments

Throws:

SAXException - if an error occurs SAXing data.

IOException - if an error occurs SAXing data.

ProcessingException - if a processing error occurs.

saxRSSFeedURL

protected void saxRSSFeedURL(ContentHandler contentHandler,
 SearchServiceInstance serviceInstance,
 ZoneItem zoneItem)
                      throws SAXException

Generate the URL for RSS feed

Parameters:

contentHandler - The content handler

serviceInstance - The service instance

zoneItem - The zone item

Throws:

SAXException - if an error occurs SAXing data.