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

Class CriterionTreeSearchComponent

java.lang.Object

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

All Implemented Interfaces:

SearchComponent, Serviceable

Direct Known Subclasses:

MatchingSubprogramSearchComponent

public class CriterionTreeSearchComponent
extends Object
implements SearchComponent, Serviceable

SearchComponent for transforming a AbstractTreeNode of FOSearchCriterion into queries

Field Summary

Fields

Modifier and Type	Field and Description
protected static Query	__EMPTY_QUERY The Query building to the empty string
protected AdvancedQueryBuilder	_advancedQueryBuilder The builder of advanced queries
protected I18nUtils	_i18nUtils The utils for i18nizable texts
protected TreeMaker	_treeMaker The Advanced tree maker

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 and Description
CriterionTreeSearchComponent()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_contextualParameters(Site currentSite)
private void	_logTree(Logger logger, AbstractTreeNode<FOSearchCriterion> tree, Map<String,Object> userCriteria)
private Query	_queryFromTransformedValAndRealOperator(SearchCriterionDefinition criterionDefinition, Object transformedVal, Query.Operator realOperator, Collection<Returnable> returnables, Collection<Searchable> searchables, AdditionalParameterValueMap additionalParameters, String currentLang, Map<String,Object> contextualParameters)
protected 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) 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) Checks the user inputs for one criterion (can be multiple) are valid
void	execute(SearchComponentArguments args) Executes the component.
int	priority() Get the priority of the component.
void	service(ServiceManager manager)
protected 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
boolean	supports(SearchComponentArguments args) Returns true if the component must be executed.

Methods inherited from class java.lang.Object

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

Field Detail

__EMPTY_QUERY

protected static final Query __EMPTY_QUERY

The Query building to the empty string

_i18nUtils

protected I18nUtils _i18nUtils

The utils for i18nizable texts

_advancedQueryBuilder

protected AdvancedQueryBuilder _advancedQueryBuilder

The builder of advanced queries

_treeMaker

protected TreeMaker _treeMaker

The Advanced tree maker

Constructor Detail

CriterionTreeSearchComponent

public CriterionTreeSearchComponent()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

priority

public int priority()

Description copied from interface: SearchComponent

Get the priority of the component. The lowest one will be executed first, and so on.

Specified by:

priority in interface SearchComponent

Returns:

the priority of the component

supports

public boolean supports(SearchComponentArguments args)

Description copied from interface: SearchComponent

Returns true if the component must be executed.

Specified by:

supports in interface SearchComponent

Parameters:

args - the arguments

Returns:

true if the component must be executed.

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

_contextualParameters

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

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

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

Throws:

InvalidUserInputException - if the user input is invalid

_logTree

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

buildQuery

protected 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

protected 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,
                                                      Object transformedVal,
                                                      Query.Operator realOperator,
                                                      Collection<Returnable> returnables,
                                                      Collection<Searchable> searchables,
                                                      AdditionalParameterValueMap additionalParameters,
                                                      String currentLang,
                                                      Map<String,Object> contextualParameters)