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

Class SearchComponentHelper

java.lang.Object

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

All Implemented Interfaces:

Component, Serviceable

public class SearchComponentHelper
extends Object
implements Serviceable, Component

A helper for all search component

Field Summary

Fields

Modifier and Type	Field	Description
protected AdvancedQueryBuilder	_advancedQueryBuilder	The builder of advanced queries
protected I18nUtils	_i18nUtils	The utils for i18nizable texts
protected TreeMaker	_treeMaker	The Advanced tree maker
static final Query	EMPTY_QUERY	The Query building to the empty string
static final String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
SearchComponentHelper()

Method Summary

Modifier and Type	Method	Description
protected ContextQueriesWrapper	_createContextQueriesWrapper(SearchContext searchContext, Site currentSite, SitemapElement currentPage, String currentLang)	Creates a ContextQueriesWrapper given one SearchContext and the current site, page and lang.
Query	buildQuery(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Predicate<SearchServiceCriterion> filterCriterionPredicate, Map<String,Object> contextualParameters)	Builds the query of the criterion tree
protected Map<String,Object>	checkValidInputs(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree, Map<String,Object> userCriteria, boolean isFromUserPref, Map<String,Object> contextualParameters, org.slf4j.Logger logger)	Checks the user inputs are valid.
protected void	checkValidInputSingleValue(Object userCriterionSingleValue, String criterionId, SearchServiceCriterionMode mode, Optional<RestrictedEnumerator.RestrictedValues> optionalRestrictedValues, Validator validator)	Checks a single value of one user input for one criterion is valid
protected void	checkValidInputValues(Object userCriterionValues, String criterionId, SearchServiceCriterionDefinition criterionDefinition, SearchServiceCriterionMode mode, Optional<RestrictedEnumerator.RestrictedValues> optionalRestrictedValues, Validator validator, Map<String,Object> contextualParameters)	Checks the user inputs for one criterion (can be multiple) are valid
protected Object	convertUserCriterionValue(Object userCriterionValue, SearchServiceCriterionDefinition criterionDefinition, Map<String,Object> contextualParameters)	Converts the given user criterion value
Query	getCriterionTreeQuery(SearchServiceInstance serviceInstance, Map<String,Object> userCriteria, Site site, String lang)	Get the criterion tree query
Query	getCriterionTreeQuery(SearchComponentArguments args, boolean checkValidInputs, boolean logTree)	Get the criterion tree query from arguments
Query	getFilterQuery(SearchServiceInstance serviceInstance, Site site, SitemapElement page, String lang)	Get the filter query
Query	getFilterQuery(SearchComponentArguments args)	Get the filter query from arguments
static Map<String,Object>	getSearchComponentContextualParameters(SearchComponentArguments args)	Retrieves a Map of contextual parameters
void	service(ServiceManager manager)
<T> Query	singleCriterionToQuery(SearchServiceCriterion<T> criterion, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Predicate<SearchServiceCriterion> filterCriterionPredicate, Map<String,Object> contextualParameters)	Builds the query of the single criterion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

The avalon role.

EMPTY_QUERY

public static final Query EMPTY_QUERY

The Query building to the empty string

_advancedQueryBuilder

protected AdvancedQueryBuilder _advancedQueryBuilder

The builder of advanced queries

_treeMaker

protected TreeMaker _treeMaker

The Advanced tree maker

_i18nUtils

protected I18nUtils _i18nUtils

The utils for i18nizable texts

Constructor Details

SearchComponentHelper

public SearchComponentHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCriterionTreeQuery

public Query getCriterionTreeQuery(SearchComponentArguments args,
 boolean checkValidInputs,
 boolean logTree)
                            throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Get the criterion tree query from arguments

Parameters:

args - the search arguments

checkValidInputs - true if inputs needs to be checked

logTree - true if the criterion tree need to be logged

Returns:

the criterion tree query

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if an invalid user input occurred

getCriterionTreeQuery

public Query getCriterionTreeQuery(SearchServiceInstance serviceInstance,
 Map<String,Object> userCriteria,
 Site site,
 String lang)

Get the criterion tree query

Parameters:

serviceInstance - the service instance

userCriteria - the user criteria

site - the site

lang - the lang

Returns:

the criterion tree query

checkValidInputs

protected Map<String,Object> checkValidInputs(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree,
 Map<String,Object> userCriteria,
 boolean isFromUserPref,
 Map<String,Object> contextualParameters,
 org.slf4j.Logger logger)
                                       throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Checks the user inputs are valid.

Parameters:

criterionTree - The criterion tree of the service instance

userCriteria - The user input criteria

isFromUserPref - true if the criteria are from user pref. Then return only the valid input, otherwise throw an exception

contextualParameters - the contextual parameters

logger - The logger

Returns:

the filtered user criteria

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if at least one user input is invalid

checkValidInputValues

protected void checkValidInputValues(Object userCriterionValues,
 String criterionId,
 SearchServiceCriterionDefinition criterionDefinition,
 SearchServiceCriterionMode mode,
 Optional<RestrictedEnumerator.RestrictedValues> optionalRestrictedValues,
 Validator validator,
 Map<String,Object> contextualParameters)
                              throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Checks the user inputs for one criterion (can be multiple) are valid

Parameters:

userCriterionValues - The multiple user values (then it is a List) or the single user value

criterionId - The criterion id

criterionDefinition - the criterion definition

mode - The criterion mode

optionalRestrictedValues - The RestrictedEnumerator.RestrictedValues if mode is SearchServiceCriterionMode.RESTRICTED_USER_INPUT

validator - The criterion validator

contextualParameters - The contextual parameters

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if at least one user input is invalid

convertUserCriterionValue

protected Object convertUserCriterionValue(Object userCriterionValue,
 SearchServiceCriterionDefinition criterionDefinition,
 Map<String,Object> contextualParameters)

Converts the given user criterion value

Parameters:

userCriterionValue - The single user value

criterionDefinition - the criterion definition

contextualParameters - The contextual parameters

Returns:

the converted user value

checkValidInputSingleValue

protected void checkValidInputSingleValue(Object userCriterionSingleValue,
 String criterionId,
 SearchServiceCriterionMode mode,
 Optional<RestrictedEnumerator.RestrictedValues> optionalRestrictedValues,
 Validator validator)
                                   throws org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException

Checks a single value of one user input for one criterion is valid

Parameters:

userCriterionSingleValue - The single user value

criterionId - The criterion id

mode - The criterion mode

optionalRestrictedValues - The RestrictedEnumerator.RestrictedValues if mode is SearchServiceCriterionMode.RESTRICTED_USER_INPUT

validator - The criterion validator

Throws:

org.ametys.web.frontoffice.search.requesttime.impl.InvalidUserInputException - if the user input is invalid

buildQuery

public Query buildQuery(AbstractTreeNode<SearchServiceCriterion<?>> criterionTree,
 Map<String,Object> userCriteria,
 Collection<Returnable> returnables,
 Collection<Searchable> searchables,
 AdditionalParameterValueMap additionalParameters,
 String currentLang,
 Predicate<SearchServiceCriterion> filterCriterionPredicate,
 Map<String,Object> contextualParameters)

Builds the query of the criterion tree

Parameters:

criterionTree - The criterion tree of the service instance

userCriteria - The user input criteria

returnables - The returnables of the service instance

searchables - The searchables of the service instance

additionalParameters - The values of additional parameters of the service instance

currentLang - The current lang

filterCriterionPredicate - A function to filter criterion. Can be null for TruePredicate

contextualParameters - the search contextual parameters.

Returns:

The query of the criterion tree

singleCriterionToQuery

public <T> Query singleCriterionToQuery(SearchServiceCriterion<T> criterion,
 Map<String,Object> userCriteria,
 Collection<Returnable> returnables,
 Collection<Searchable> searchables,
 AdditionalParameterValueMap additionalParameters,
 String currentLang,
 Predicate<SearchServiceCriterion> filterCriterionPredicate,
 Map<String,Object> contextualParameters)

Builds the query of the single criterion

Type Parameters:

T - Type of the criterion value

Parameters:

criterion - The criterion

userCriteria - The user input criteria

returnables - The returnables of the service instance

searchables - The searchables of the service instance

additionalParameters - The values of additional parameters of the service instance

currentLang - The current lang

filterCriterionPredicate - A function to filter criterion

contextualParameters - the search contextual parameters.

Returns:

The query of the single criterion

getFilterQuery

public Query getFilterQuery(SearchComponentArguments args)

Get the filter query from arguments

Parameters:

args - the search arguments

Returns:

the filter query

getFilterQuery

public Query getFilterQuery(SearchServiceInstance serviceInstance,
 Site site,
 SitemapElement page,
 String lang)

Get the filter query

Parameters:

serviceInstance - the service instance

site - the site

page - the page

lang - the lang

Returns:

the filter query

_createContextQueriesWrapper

protected ContextQueriesWrapper _createContextQueriesWrapper(SearchContext searchContext,
 Site currentSite,
 SitemapElement currentPage,
 String currentLang)

Creates a ContextQueriesWrapper given one SearchContext and the current site, page and lang.

Parameters:

searchContext - The search context

currentSite - The current site

currentPage - The current page

currentLang - The current lang

Returns:

The created wrapper of queries of a SearchContext

getSearchComponentContextualParameters

public static Map<String,Object> getSearchComponentContextualParameters(SearchComponentArguments args)

Retrieves a Map of contextual parameters

Parameters:

args - the search component arguments

Returns:

the Map of contextual parameters