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

Class SaxResultsSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CalendarSearchComponent

public class SaxResultsSearchComponent
extends AbstractSearchComponent

SearchComponent for saxing results

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

Method Summary

Modifier and Type	Method	Description
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
protected SearchResults<AmetysObject>	getResults(SearchComponentArguments args)	Gets the results
protected Optional<ReturnableSaxer>	getSaxer(AmetysObject hit, SearchComponentArguments args, List<Returnable> returnables, AdditionalParameterValueMap additionalParameterValues)	Gets the Saxer to use for SAXing the given hit
protected void	saxHit(SearchResult<AmetysObject> result, int number, SearchComponentArguments args, List<Returnable> returnables, AdditionalParameterValueMap additionalParameterValues)	SAX the result hit
protected void	saxHits(SearchResults<AmetysObject> results, int start, SearchComponentArguments args, List<Returnable> returnables, AdditionalParameterValueMap additionalParameterValues)	SAX the result hits
protected void	saxPagination(int totalHits, Pagination pagination, ContentHandler contentHandler)	SAX elements for pagination
boolean	supports(SearchComponentArguments args)	Check if an element is supported
protected int	total(SearchResults<AmetysObject> results, SearchServiceInstance serviceInstance)	The total of results

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

SaxResultsSearchComponent

public SaxResultsSearchComponent()

Method Details

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.

Returns:

the priority

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: Supporter

Check if an element is supported

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.

Parameters:

args - the arguments

Throws:

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

getResults

protected SearchResults<AmetysObject> getResults(SearchComponentArguments args)

Gets the results

Parameters:

args - The arguments

Returns:

the results

total

protected int total(SearchResults<AmetysObject> results,
 SearchServiceInstance serviceInstance)

The total of results

Parameters:

results - The results

serviceInstance - The search service instance

Returns:

The total of results

saxHits

protected void saxHits(SearchResults<AmetysObject> results,
 int start,
 SearchComponentArguments args,
 List<Returnable> returnables,
 AdditionalParameterValueMap additionalParameterValues)
                throws SAXException

SAX the result hits

Parameters:

results - The search results

start - The start index of search

args - The arguments

returnables - The returnables

additionalParameterValues - The additional parameter values

Throws:

SAXException - If an error occurs while SAXing

saxHit

protected void saxHit(SearchResult<AmetysObject> result,
 int number,
 SearchComponentArguments args,
 List<Returnable> returnables,
 AdditionalParameterValueMap additionalParameterValues)
               throws SAXException

SAX the result hit

Parameters:

result - The search result

number - The hit number

args - The arguments

returnables - The returnables

additionalParameterValues - The additional parameter values

Throws:

SAXException - If an error occurs while SAXing

getSaxer

protected Optional<ReturnableSaxer> getSaxer(AmetysObject hit,
 SearchComponentArguments args,
 List<Returnable> returnables,
 AdditionalParameterValueMap additionalParameterValues)

Gets the Saxer to use for SAXing the given hit

Parameters:

hit - The hit to SAX

args - The arguments

returnables - The returnables for the current search service instance

additionalParameterValues - The additional parameter values

Returns:

the Saxer to use for SAXing the given hit

saxPagination

protected void saxPagination(int totalHits,
 Pagination pagination,
 ContentHandler contentHandler)
                      throws SAXException

SAX elements for pagination

Parameters:

totalHits - The total number of result

pagination - The pagination object

contentHandler - The content handler

Throws:

SAXException - SAXException If an error occurs while SAXing