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 Query	EMPTY_QUERY	The Query building to the empty string
static String	ROLE	The avalon role.

Constructor Summary

Constructors

Constructor	Description
SearchComponentHelper()

Method Summary

Modifier and Type	Method	Description
private Map<String,Object>	_contextualParameters(Site currentSite)
protected ContextQueriesWrapper	_createContextQueriesWrapper(SearchContext searchContext, Site currentSite, Page currentPage, String currentLang)	Creates a ContextQueriesWrapper given one SearchContext and the current site, page and lang.
private void	_logTree(org.slf4j.Logger logger, AbstractTreeNode<FOSearchCriterion> tree, Map<String,Object> userCriteria)
private Query	_queryFromTransformedValAndRealOperator(SearchCriterionDefinition criterionDefinition, FOSearchCriterionMode.FoWrappedValue transformedVal, Query.Operator realOperator, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)
private Query	_queryOnCriterion(SearchCriterionDefinition criterionDefinition, FOSearchCriterionMode.FoWrappedValue transformedVal, Query.Operator realOperator, String currentLang, Map<String,Object> contextualParameters)
Query	buildQuery(AbstractTreeNode<FOSearchCriterion> criterionTree, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)	Builds the query of the criterion tree
protected void	checkValidInputs(AbstractTreeNode<FOSearchCriterion> criterionTree, Map<String,Object> userCriteria)	Checks the user inputs are valid
protected void	checkValidInputSingleValue(Object userCriterionSingleValue, String criterionId, FOSearchCriterionMode mode, Optional<EnumeratedValues.RestrictedValues> optionalRestrictedValues, Validator validator, boolean isMandatory)	Checks a single value of one user input for one criterion is valid
protected void	checkValidInputValues(Object userCriterionValues, String criterionId, FOSearchCriterionMode mode, Optional<EnumeratedValues.RestrictedValues> optionalRestrictedValues, Validator validator, boolean isMandatory)	Checks the user inputs for one criterion (can be multiple) are valid
Query	getCriterionTreeQuery(SearchComponentArguments args, boolean checkValidInputs, boolean logTree)	Get the criterion tree query from arguments
Query	getFilterQuery(SearchComponentArguments args)	Get the filter query from arguments
void	service(ServiceManager manager)
Query	singleCriterionToQuery(FOSearchCriterion searchCriterion, Map<String,Object> userCriteria, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, 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 Detail

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 Detail

SearchComponentHelper

public SearchComponentHelper()

Method Detail

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 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:

InvalidUserInputException - if an invalid user input occurred

checkValidInputs

protected void checkValidInputs(AbstractTreeNode<FOSearchCriterion> criterionTree,
                                Map<String,Object> userCriteria)
                         throws InvalidUserInputException

Checks the user inputs are valid

Parameters:

criterionTree - The criterion tree of the service instance

userCriteria - The user input criteria

Throws:

InvalidUserInputException - if at least one user input is invalid

checkValidInputValues

protected void checkValidInputValues(Object userCriterionValues,
                                     String criterionId,
                                     FOSearchCriterionMode mode,
                                     Optional<EnumeratedValues.RestrictedValues> optionalRestrictedValues,
                                     Validator validator,
                                     boolean isMandatory)
                              throws 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

mode - The criterion mode

optionalRestrictedValues - The EnumeratedValues.RestrictedValues if mode is FOSearchCriterionMode.RESTRICTED_USER_INPUT

validator - The criterion validator

isMandatory - true if the criterion is linked to a mandatory data

Throws:

InvalidUserInputException - if at least one user input is invalid

checkValidInputSingleValue

protected void checkValidInputSingleValue(Object userCriterionSingleValue,
                                          String criterionId,
                                          FOSearchCriterionMode mode,
                                          Optional<EnumeratedValues.RestrictedValues> optionalRestrictedValues,
                                          Validator validator,
                                          boolean isMandatory)
                                   throws 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 EnumeratedValues.RestrictedValues if mode is FOSearchCriterionMode.RESTRICTED_USER_INPUT

validator - The criterion validator

isMandatory - true if the criterion is linked to a mandatory data

Throws:

InvalidUserInputException - if the user input is invalid

_contextualParameters

private Map<String,Object> _contextualParameters(Site currentSite)

buildQuery

public Query buildQuery(AbstractTreeNode<FOSearchCriterion> criterionTree,
                        Map<String,Object> userCriteria,
                        Collection<Returnable> returnables,
                        Collection<Searchable> searchables,
                        AdditionalParameterValueMap additionalParameters,
                        String currentLang,
                        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

contextualParameters - the search contextual parameters.

Returns:

The query of the criterion tree

singleCriterionToQuery

public Query singleCriterionToQuery(FOSearchCriterion searchCriterion,
                                    Map<String,Object> userCriteria,
                                    Collection<Returnable> returnables,
                                    Collection<Searchable> searchables,
                                    AdditionalParameterValueMap additionalParameters,
                                    String currentLang,
                                    Map<String,Object> contextualParameters)

Builds the query of the single criterion

Parameters:

searchCriterion - 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

contextualParameters - the search contextual parameters.

Returns:

The query of the single criterion

_queryFromTransformedValAndRealOperator

private Query _queryFromTransformedValAndRealOperator(SearchCriterionDefinition criterionDefinition,
                                                      FOSearchCriterionMode.FoWrappedValue transformedVal,
                                                      Query.Operator realOperator,
                                                      Collection<Returnable> returnables,
                                                      Collection<Searchable> searchables,
                                                      AdditionalParameterValueMap additionalParameters,
                                                      String currentLang,
                                                      Map<String,Object> contextualParameters)

_queryOnCriterion

private Query _queryOnCriterion(SearchCriterionDefinition criterionDefinition,
                                FOSearchCriterionMode.FoWrappedValue transformedVal,
                                Query.Operator realOperator,
                                String currentLang,
                                Map<String,Object> contextualParameters)

_logTree

private void _logTree(org.slf4j.Logger logger,
                      AbstractTreeNode<FOSearchCriterion> tree,
                      Map<String,Object> userCriteria)

getFilterQuery

public Query getFilterQuery(SearchComponentArguments args)

Get the filter query from arguments

Parameters:

args - the search arguments

Returns:

the filter query

_createContextQueriesWrapper

protected ContextQueriesWrapper _createContextQueriesWrapper(SearchContext searchContext,
                                                             Site currentSite,
                                                             Page 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