org.ametys.cms.search

Class QueryBuilder

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.cms.search.QueryBuilder

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class QueryBuilder
extends AbstractLogEnabled
implements Component, Serviceable

Builds a Query object from a user search.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypeExtensionPoint	_cTypeEP The content type extension point.
protected LanguagesManager	_languagesManager The languages manager
static String	DEFAULT_LANGUAGE The query default language.
static String	MULTILINGUAL_SEARCH Key of flag present in contextual parameters to indicate the current search is multilingual
static String	ROLE The component role.
static String	SEARCH_CRITERIA_METADATA_PREFIX Prefix for id of metadata search criteria
static String	SEARCH_CRITERIA_SYSTEM_PREFIX Prefix for id of system property search criteria
static String	VALUE_IS_ESCAPED Key of flag present in contextual parameters to indicate the provided value was already escaped

Constructor Summary

Constructors

Constructor and Description
QueryBuilder()

Method Summary

Modifier and Type	Method and Description
private boolean	_containsAny(Set<String> cTypes, String[] supertypeIds)
private Query	_contentTypeQueryOrMixinQuery(Collection<String> contentTypes)
private String	_findSystemCriterionId(String systemPropertyId, Map<String,SearchUICriterion> criteria)
private Object	_getAndRemoveValueForSytemCriterion(String systemCriterionId, Map<String,Object> values, String searchMode)
private Set<String>	_getOnlySuperTypes(Set<String> cTypes)
private boolean	_isFlatAndExpression(String rootType, Map<String,Object> values)
private boolean	_isMultilingualSearch(Query cTypeQuery)
Query	build(SearchUIModel model, String searchMode, boolean createContentTypeQuery, Map<String,Object> values, Map<String,Object> contextualParameters) Build the Query object.
protected Query	createContentTypeOrMixinQuery(Set<String> modelContentTypes, Map<String,Object> values, Map<String,SearchUICriterion> criteria, String searchMode) Create a content type or mixin query.
Query	createContentTypeOrMixinQuery(Set<String> modelContentTypes, Object cTypeOrMixinParam, boolean criterionIsMultiple) Create a content type or mixin query.
protected Query	createContentTypeQuery(Set<String> modelContentTypes, Map<String,Object> values, Map<String,SearchUICriterion> criteria, String searchMode) Create a content type query.
protected Query	createContentTypeQuery(Set<String> modelContentTypes, Map<String,Object> values, Map<String,SearchUICriterion> criteria, String searchMode, boolean exclude) Create a content type query.
protected Query	createMixinTypeQuery(Set<String> mixinTypes, Map<String,Object> values, Map<String,SearchUICriterion> criteria, String searchMode) Create a mixin type query.
protected String	escapeQueryCharsForLikeQuery(String string, Map<String,Object> contextualParameters) Escape special Solr query characters of the user input, before building the query in order to append '*' character(s)
protected Query	getAdvancedCriteriaQuery(Map<String,SearchUICriterion> criteria, Map<String,Object> values, String language, Map<String,Object> contextualParameters) Get a complex Query from the advanced search values.
protected Query	getAdvancedCriterionQuery(SearchUICriterion criterion, String op, Object value, String language, Map<String,Object> contextualParameters) Build the Query object corresponding to an advanced criterion value.
String	getCriteriaLanguage(Map<String,SearchUICriterion> criteria, String searchMode, Map<String,Object> values, Map<String,Object> contextualParameters) Get the language.
protected List<Query>	getCriteriaQueries(Map<String,SearchUICriterion> criteria, Map<String,Object> values, String language, Map<String,Object> contextualParameters) Get the list of query on criteria.
protected String	getDefaultLanguage() Get the default language for search
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

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 component role.

SEARCH_CRITERIA_METADATA_PREFIX

public static final String SEARCH_CRITERIA_METADATA_PREFIX

Prefix for id of metadata search criteria

See Also:

Constant Field Values

SEARCH_CRITERIA_SYSTEM_PREFIX

public static final String SEARCH_CRITERIA_SYSTEM_PREFIX

Prefix for id of system property search criteria

See Also:

Constant Field Values

MULTILINGUAL_SEARCH

public static final String MULTILINGUAL_SEARCH

Key of flag present in contextual parameters to indicate the current search is multilingual

See Also:

Constant Field Values

VALUE_IS_ESCAPED

public static final String VALUE_IS_ESCAPED

Key of flag present in contextual parameters to indicate the provided value was already escaped

See Also:

Constant Field Values

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

The query default language.

See Also:

Constant Field Values

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_languagesManager

protected LanguagesManager _languagesManager

The languages manager

Constructor Detail

QueryBuilder

public QueryBuilder()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

build

public Query build(SearchUIModel model,
                   String searchMode,
                   boolean createContentTypeQuery,
                   Map<String,Object> values,
                   Map<String,Object> contextualParameters)

Build the Query object.

Parameters:

model - the search model.

searchMode - the search mode.

createContentTypeQuery - True to generate a query based on the content types of the model, and the 'property-contentTypes-eq' if present in values

values - the user search values.

contextualParameters - the search contextual parameters.

Returns:

a Query object representing the search.

_isMultilingualSearch

private boolean _isMultilingualSearch(Query cTypeQuery)

_getOnlySuperTypes

private Set<String> _getOnlySuperTypes(Set<String> cTypes)

_containsAny

private boolean _containsAny(Set<String> cTypes,
                             String[] supertypeIds)

getCriteriaLanguage

public String getCriteriaLanguage(Map<String,SearchUICriterion> criteria,
                                  String searchMode,
                                  Map<String,Object> values,
                                  Map<String,Object> contextualParameters)

Get the language.

Parameters:

criteria - the list of search criteria

searchMode - The search mode (advanced or simple)

values - The user values.

contextualParameters - The search contextual parameters.

Returns:

the query language.

getDefaultLanguage

protected String getDefaultLanguage()

Get the default language for search

Returns:

The default language

createContentTypeQuery

protected Query createContentTypeQuery(Set<String> modelContentTypes,
                                       Map<String,Object> values,
                                       Map<String,SearchUICriterion> criteria,
                                       String searchMode)

Create a content type query.

Parameters:

modelContentTypes - the content types to search on.

values - the user search values.

criteria - the list of search criteria

searchMode - The search mode (advanced or simple)

Returns:

the content type Query.

createContentTypeQuery

protected Query createContentTypeQuery(Set<String> modelContentTypes,
                                       Map<String,Object> values,
                                       Map<String,SearchUICriterion> criteria,
                                       String searchMode,
                                       boolean exclude)

Create a content type query.

Parameters:

modelContentTypes - the content types to search on.

values - the user search values.

criteria - the list of search criteria

searchMode - The search mode (advanced or simple)

exclude - true to create a negative query ("all but the given content types"), false to create a standard "include" query.

Returns:

the content type Query.

createMixinTypeQuery

protected Query createMixinTypeQuery(Set<String> mixinTypes,
                                     Map<String,Object> values,
                                     Map<String,SearchUICriterion> criteria,
                                     String searchMode)

Create a mixin type query.

Parameters:

mixinTypes - the mixin types to search on.

values - the user search values.

criteria - the list of search criteria

searchMode - The search mode (advanced or simple)

Returns:

the mixin type Query.

createContentTypeOrMixinQuery

protected Query createContentTypeOrMixinQuery(Set<String> modelContentTypes,
                                              Map<String,Object> values,
                                              Map<String,SearchUICriterion> criteria,
                                              String searchMode)

Create a content type or mixin query.

Parameters:

modelContentTypes - the content types or mixins to search on.

values - the user search values.

criteria - the list of search criteria

searchMode - The search mode (advanced or simple)

Returns:

the content type Query.

createContentTypeOrMixinQuery

public Query createContentTypeOrMixinQuery(Set<String> modelContentTypes,
                                           Object cTypeOrMixinParam,
                                           boolean criterionIsMultiple)

Create a content type or mixin query.

Parameters:

modelContentTypes - the content types or mixins to search on.

cTypeOrMixinParam - The contentTypes or mixin parameter on which you want to build the Query

criterionIsMultiple - true if the given parameter is a value for a multiple criterion

Returns:

the content type Query.

_contentTypeQueryOrMixinQuery

private Query _contentTypeQueryOrMixinQuery(Collection<String> contentTypes)

_getAndRemoveValueForSytemCriterion

private Object _getAndRemoveValueForSytemCriterion(String systemCriterionId,
                                                   Map<String,Object> values,
                                                   String searchMode)

_findSystemCriterionId

private String _findSystemCriterionId(String systemPropertyId,
                                      Map<String,SearchUICriterion> criteria)

_isFlatAndExpression

private boolean _isFlatAndExpression(String rootType,
                                     Map<String,Object> values)

getCriteriaQueries

protected List<Query> getCriteriaQueries(Map<String,SearchUICriterion> criteria,
                                         Map<String,Object> values,
                                         String language,
                                         Map<String,Object> contextualParameters)

Get the list of query on criteria.

Parameters:

criteria - the list of search criteria

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.

getAdvancedCriteriaQuery

protected Query getAdvancedCriteriaQuery(Map<String,SearchUICriterion> criteria,
                                         Map<String,Object> values,
                                         String language,
                                         Map<String,Object> contextualParameters)

Get a complex Query from the advanced search values.

Parameters:

criteria - the list of search criteria

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.

getAdvancedCriterionQuery

protected Query getAdvancedCriterionQuery(SearchUICriterion criterion,
                                          String op,
                                          Object value,
                                          String language,
                                          Map<String,Object> contextualParameters)

Build the Query object corresponding to an advanced criterion value.

Parameters:

criterion - The search criterion.

op - The advanced operator (can be a custom one, such as "contain").

value - The user value.

language - The query language.

contextualParameters - the search contextual parameters.

Returns:

The criterion Query.

escapeQueryCharsForLikeQuery

protected String escapeQueryCharsForLikeQuery(String string,
                                              Map<String,Object> contextualParameters)

Escape special Solr query characters of the user input, before building the query in order to append '*' character(s)

Parameters:

string - The string to escape.

contextualParameters - the search contextual parameters.

Returns:

The escaped string.