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

Constructor Summary

Constructors

Constructor and Description
QueryBuilder()

Method Summary

Modifier and Type	Method and Description
Query	build(SearchUIModel model, String searchMode, Map<String,Object> values, Map<String,Object> contextualParameters) Build the Query object.
protected Query	createContentTypeOrMixinQuery(Set<String> contentTypes, Map<String,Object> values, Map<String,Object> contextualParameters) Create a content type or mixin query.
protected Query	createContentTypeQuery(Set<String> contentTypes, Map<String,Object> values, Map<String,Object> contextualParameters) Create a content type query.
protected Query	createContentTypeQuery(Set<String> contentTypes, Map<String,Object> values, Map<String,Object> contextualParameters, boolean exclude) Create a content type query.
protected Query	createMixinTypeQuery(Set<String> mixinTypes, Map<String,Object> values, Map<String,Object> contextualParameters) Create a mixin type query.
protected String	filterWildcardChars(String string) Filter wildcard characters '*' and '?' from the input string by replacing them with a space.
protected Query	getAdvancedCriteriaQuery(SearchUIModel model, 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.
protected String	getCriteriaLanguage(SearchUIModel model, String searchMode, Map<String,Object> values, Map<String,Object> contextualParameters) Get the language.
protected List<Query>	getCriteriaQueries(SearchUIModel model, 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

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,
                   Map<String,Object> values,
                   Map<String,Object> contextualParameters)

Build the Query object.

Parameters:

model - the search model.

searchMode - the search mode.

values - the user search values.

contextualParameters - the search contextual parameters.

Returns:

a Query object representing the search.

getCriteriaLanguage

protected String getCriteriaLanguage(SearchUIModel model,
                                     String searchMode,
                                     Map<String,Object> values,
                                     Map<String,Object> contextualParameters)

Get the language.

Parameters:

model - The search model.

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> contentTypes,
                                       Map<String,Object> values,
                                       Map<String,Object> contextualParameters)

Create a content type query.

Parameters:

contentTypes - the content types to search on.

values - the user search values.

contextualParameters - the search contextual parameters.

Returns:

the content type Query.

createContentTypeQuery

protected Query createContentTypeQuery(Set<String> contentTypes,
                                       Map<String,Object> values,
                                       Map<String,Object> contextualParameters,
                                       boolean exclude)

Create a content type query.

Parameters:

contentTypes - the content types to search on.

values - the user search values.

contextualParameters - the search contextual parameters.

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,Object> contextualParameters)

Create a mixin type query.

Parameters:

mixinTypes - the mixin types to search on.

values - the user search values.

contextualParameters - the search contextual parameters.

Returns:

the mixin type Query.

createContentTypeOrMixinQuery

protected Query createContentTypeOrMixinQuery(Set<String> contentTypes,
                                              Map<String,Object> values,
                                              Map<String,Object> contextualParameters)

Create a content type or mixin query.

Parameters:

contentTypes - the content types or mixins to search on.

values - the user search values.

contextualParameters - the search contextual parameters.

Returns:

the content type Query.

getCriteriaQueries

protected List<Query> getCriteriaQueries(SearchUIModel model,
                                         Map<String,Object> values,
                                         String language,
                                         Map<String,Object> contextualParameters)

Get the list of query on criteria.

Parameters:

model - the search model.

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.

getAdvancedCriteriaQuery

protected Query getAdvancedCriteriaQuery(SearchUIModel model,
                                         Map<String,Object> values,
                                         String language,
                                         Map<String,Object> contextualParameters)

Get a complex Query from the advanced search values.

Parameters:

model - the search model.

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.

filterWildcardChars

protected String filterWildcardChars(String string)

Filter wildcard characters '*' and '?' from the input string by replacing them with a space.

Parameters:

string - The string to filter.

Returns:

The filtered string.