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

Class SaxFormSearchComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CalendarSaxFormSearchComponent

public class SaxFormSearchComponent
extends AbstractSearchComponent
implements Serviceable

SearchComponent for saxing form

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentHelper	_contentHelper	The content helper
protected AmetysObjectResolver	_resolver	The Ametys object 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
SaxFormSearchComponent()

Method Summary

Modifier and Type	Method	Description
protected boolean	_isMandatory(SearchServiceCriterion criterion)	Check if the given criterion is mandatory
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
protected boolean	isMinimalFormSax(Parameters parameters)	Returns true if the Generator is parameterized with a minimal form sax
protected <T> void	saxEnumeratorEntries(ContentHandler contentHandler, SearchServiceCriterion<T> criterion, Map<String,Object> contextualParameters, boolean computeCriteriaCounts)	SAX Enumerator entries
protected <T> void	saxEnumeratorEntry(ContentHandler contentHandler, SearchServiceCriterionDefinition<T> criterionDef, Map.Entry<T,I18nizableText> enumeratorEntry)	SAX Enumerator entry
protected void	saxFacet(ContentHandler contentHandler, I18nizableText facetLabel, String value, Integer count, List<String> selectedFacets)	SAX the facet
protected void	saxFacets(ContentHandler contentHandler, Parameters parameters, Collection<SearchServiceFacetDefinition> facets, Map<String,List<String>> userFacets, Optional<SearchResults<AmetysObject>> searchResults, Map<String,Object> contextualParameters)	SAX the facets
protected void	saxFormFields(ContentHandler contentHandler, Parameters parameters, List<SearchServiceCriterion> nonStaticCriteria, Map<String,Object> contextualParameters, boolean computeCriteriaCounts)	SAX the form criteria
protected void	saxFormSingleValue(ContentHandler contentHandler, Attributes attrs, Object singleUserCriterion)	SAX a single value of a form criterion
protected void	saxFormValue(ContentHandler contentHandler, Attributes attrs, Object userCriterion)	SAX the values of a form criterion
protected void	saxFormValues(ContentHandler contentHandler, Parameters parameters, List<SearchServiceCriterion> nonStaticCriteria, Map<String,Object> userCriteria)	SAX the form criteria values
protected void	saxSorts(ContentHandler contentHandler, Parameters parameters, List<Pair<SearchServiceSortDefinition,SortOrder>> initialSorts, Collection<SearchServiceSortDefinition> sortsToPropose, List<Pair<String,SortOrder>> userSorts)	SAX the sorts
void	service(ServiceManager manager)
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

Field Details

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_contentHelper

protected ContentHelper _contentHelper

The content helper

Constructor Details

SaxFormSearchComponent

public SaxFormSearchComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

isMinimalFormSax

protected boolean isMinimalFormSax(Parameters parameters)

Returns true if the Generator is parameterized with a minimal form sax

Parameters:

parameters - the parameters

Returns:

true if the Generator is parameterized with a minimal form sax

saxFormFields

protected void saxFormFields(ContentHandler contentHandler,
 Parameters parameters,
 List<SearchServiceCriterion> nonStaticCriteria,
 Map<String,Object> contextualParameters,
 boolean computeCriteriaCounts)
                      throws Exception

SAX the form criteria

Parameters:

contentHandler - the content handler

parameters - the parameters

nonStaticCriteria - the non-static criteria

contextualParameters - The contextual parameters

computeCriteriaCounts - true if we compute criteria counts

Throws:

Exception - if an exception occurs

_isMandatory

protected boolean _isMandatory(SearchServiceCriterion criterion)

Check if the given criterion is mandatory

Parameters:

criterion - the criterion to check

Returns:

true if the given criterion is mandatory, false otherwise

saxEnumeratorEntries

protected <T> void saxEnumeratorEntries(ContentHandler contentHandler,
 SearchServiceCriterion<T> criterion,
 Map<String,Object> contextualParameters,
 boolean computeCriteriaCounts)
                                 throws Exception

SAX Enumerator entries

Type Parameters:

T - Type of the criterion value

Parameters:

contentHandler - the content handler

criterion - the (non-static) criterion

contextualParameters - The contextual parameters

computeCriteriaCounts - true if we compute criteria counts

Throws:

Exception - if an exception occurs

saxEnumeratorEntry

protected <T> void saxEnumeratorEntry(ContentHandler contentHandler,
 SearchServiceCriterionDefinition<T> criterionDef,
 Map.Entry<T,I18nizableText> enumeratorEntry)
                               throws Exception

SAX Enumerator entry

Type Parameters:

T - Type of the criterion value

Parameters:

contentHandler - the content handler

criterionDef - the criterion definition

enumeratorEntry - the enumerator entry

Throws:

Exception - if an exception occurs

saxFormValues

protected void saxFormValues(ContentHandler contentHandler,
 Parameters parameters,
 List<SearchServiceCriterion> nonStaticCriteria,
 Map<String,Object> userCriteria)
                      throws SAXException

SAX the form criteria values

Parameters:

contentHandler - the content handler

parameters - the parameters

nonStaticCriteria - the non-static criteria

userCriteria - The user input criteria

Throws:

SAXException - if an error occurs while SAXing

saxFormValue

protected void saxFormValue(ContentHandler contentHandler,
 Attributes attrs,
 Object userCriterion)
                     throws SAXException

SAX the values of a form criterion

Parameters:

contentHandler - the content handler

attrs - The XML attributes

userCriterion - The user input criterion value (is a List if multiple)

Throws:

SAXException - if an error occurs while SAXing

saxFormSingleValue

protected void saxFormSingleValue(ContentHandler contentHandler,
 Attributes attrs,
 Object singleUserCriterion)
                           throws SAXException

SAX a single value of a form criterion

Parameters:

contentHandler - the content handler

attrs - The XML attributes

singleUserCriterion - The user input criterion single value

Throws:

SAXException - if an error occurs while SAXing

saxFacets

protected void saxFacets(ContentHandler contentHandler,
 Parameters parameters,
 Collection<SearchServiceFacetDefinition> facets,
 Map<String,List<String>> userFacets,
 Optional<SearchResults<AmetysObject>> searchResults,
 Map<String,Object> contextualParameters)
                  throws SAXException

SAX the facets

Parameters:

contentHandler - the content handler

parameters - the parameters

facets - The facets

userFacets - The user input facets

searchResults - The search results

contextualParameters - The contextual parameters

Throws:

SAXException - if an error occurs while SAXing

saxFacet

protected void saxFacet(ContentHandler contentHandler,
 I18nizableText facetLabel,
 String value,
 Integer count,
 List<String> selectedFacets)
                 throws SAXException

SAX the facet

Parameters:

contentHandler - the content handler

facetLabel - the facet label

value - the value for the current facet item

count - the value count

selectedFacets - the facets selected by the user

Throws:

SAXException - if an error occurs while generating SAX events

saxSorts

protected void saxSorts(ContentHandler contentHandler,
 Parameters parameters,
 List<Pair<SearchServiceSortDefinition,SortOrder>> initialSorts,
 Collection<SearchServiceSortDefinition> sortsToPropose,
 List<Pair<String,SortOrder>> userSorts)
                 throws SAXException

SAX the sorts

Parameters:

contentHandler - the content handler

parameters - the parameters

initialSorts - The initial sorts

sortsToPropose - The sorts to propose

userSorts - The user input sorts

Throws:

SAXException - if an error occurs while SAXing