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

Class SaxEnumeratedCriteriaComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

SaxDegreeUniversityEnumeratedCriteriaComponent

public class SaxEnumeratedCriteriaComponent
extends AbstractSearchComponent
implements Serviceable

SearchComponent for saxing number of results for each values of enumerated criteria

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSearchHelper	_contentSearchHelper	The content search helper
protected RightManager	_rightManager	The right manager
protected SearchComponentHelper	_searchComponentHelper	The helper for search component
protected SearcherFactory	_searcherFactory	The searcher factory

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

Method Summary

Modifier and Type	Method	Description
protected Map<SearchServiceFacetDefinition,SearchServiceCriterion>	_getFacetDefinitions(SearchServiceInstance serviceInstance)	Transform each enumerated criteria in facet definition to have the number of result for each enumerated values
protected <T> Map<String,Integer>	_getFacetValues(Map<String,Integer> facetResult, SearchServiceCriterion<T> criterion, Map<String,Object> contextualParameters)	Retrieves the values of the current facet
protected void	_saxCountEnumeratedCriteria(ContentHandler contentHandler, Parameters parameters, Map<SearchServiceFacetDefinition,SearchServiceCriterion> facets, SearchResults<AmetysObject> searchResults, Map<String,Object> contextualParameters)	SAX the enumerated criteria
protected void	_saxFacetItemsWithCount(ContentHandler contentHandler, SearchServiceFacetDefinition facet, Map<String,Integer> valuesForCurrentFacetDef, Map<String,Object> contextualParameters)	SAX the facet items with the count
protected void	_saxFacetItemWithCount(ContentHandler contentHandler, I18nizableText facetLabel, String value, Integer count)	SAX the facet item with the count
protected void	_setRight(SearcherFactory.Searcher searcher, SearchComponentArguments args)	Set right to the searcher
void	execute(SearchComponentArguments args)	Executes the component.
int	getPriority()	Get the priority for the component.
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

_searcherFactory

protected SearcherFactory _searcherFactory

The searcher factory

_searchComponentHelper

protected SearchComponentHelper _searchComponentHelper

The helper for search component

_rightManager

protected RightManager _rightManager

The right manager

_contentSearchHelper

protected ContentSearchHelper _contentSearchHelper

The content search helper

Constructor Details

SaxEnumeratedCriteriaComponent

public SaxEnumeratedCriteriaComponent()

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

_getFacetDefinitions

protected Map<SearchServiceFacetDefinition,SearchServiceCriterion> _getFacetDefinitions(SearchServiceInstance serviceInstance)

Transform each enumerated criteria in facet definition to have the number of result for each enumerated values

Parameters:

serviceInstance - the service instance

Returns:

the collection of facet definition

_setRight

protected void _setRight(SearcherFactory.Searcher searcher,
 SearchComponentArguments args)

Set right to the searcher

Parameters:

searcher - the searcher

args - the arguments

_saxCountEnumeratedCriteria

protected void _saxCountEnumeratedCriteria(ContentHandler contentHandler,
 Parameters parameters,
 Map<SearchServiceFacetDefinition,SearchServiceCriterion> facets,
 SearchResults<AmetysObject> searchResults,
 Map<String,Object> contextualParameters)
                                    throws SAXException

SAX the enumerated criteria

Parameters:

contentHandler - the content handler

parameters - the parameters

facets - The facets

searchResults - The search results

contextualParameters - The contextual parameters

Throws:

SAXException - if an error occurs while generating SAX events

_getFacetValues

protected <T> Map<String,Integer> _getFacetValues(Map<String,Integer> facetResult,
 SearchServiceCriterion<T> criterion,
 Map<String,Object> contextualParameters)

Retrieves the values of the current facet

Type Parameters:

T - Type of the criterion value

Parameters:

facetResult - the result of the current facet

criterion - the criterion corresponding to the current facet

contextualParameters - the contextual parameters

Returns:

the values of the current facet

_saxFacetItemsWithCount

protected void _saxFacetItemsWithCount(ContentHandler contentHandler,
 SearchServiceFacetDefinition facet,
 Map<String,Integer> valuesForCurrentFacetDef,
 Map<String,Object> contextualParameters)
                                throws SAXException

SAX the facet items with the count

Parameters:

contentHandler - the content handler

facet - the facet definition

valuesForCurrentFacetDef - The values for the current facet definition

contextualParameters - The contextual parameters

Throws:

SAXException - if an error occurs while generating SAX events

_saxFacetItemWithCount

protected void _saxFacetItemWithCount(ContentHandler contentHandler,
 I18nizableText facetLabel,
 String value,
 Integer count)
                               throws SAXException

SAX the facet item with the count

Parameters:

contentHandler - the content handler

facetLabel - the facet label

value - the value for the current facet item

count - the value count

Throws:

SAXException - if an error occurs while generating SAX events