Package 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	Description
protected AdvancedQueryBuilder	_advancedQueryBuilder	The advanced query builder
protected TreeMaker	_advancedTreeMaker	The Advanced tree maker
protected ContentTypeExtensionPoint	_cTypeEP	The content type extension point.
protected SearchModelHelper	_searchModelHelper	The search model helper
static final String	MULTILINGUAL_SEARCH	Key of flag present in contextual parameters to indicate the current search is multilingual
static final String	ROLE	The component role.
static final String	SEARCH_MODEL	Key of flag present in contextual parameters to indicate the current search model
static final String	VALUE_IS_ESCAPED	Key of flag present in contextual parameters to indicate the provided value was already escaped

Constructor Summary

Constructors

Constructor	Description
QueryBuilder()

Method Summary

Modifier and Type	Method	Description
Query	build(SearchModel model, String searchMode, Map<String,Object> values, Map<String,Object> contextualParameters)	Build the Query object.
protected org.ametys.cms.search.QueryBuilder.CriteriaQueries	getAdvancedCriteriaQuery(SearchUIModel model, Map<String,Object> values, String language, Map<String,Object> contextualParameters)	Get a complex Query from the advanced search values.
protected org.ametys.cms.search.QueryBuilder.CriteriaQueries	getCriteriaQueries(SearchModel model, Map<String,Object> values, String language, Map<String,Object> contextualParameters)	Get the list of query on given model's criteria.
protected org.ametys.cms.search.QueryBuilder.CriteriaQueries	getCriteriaQueries(ViewItemAccessor criteria, Map<String,Object> values, String language, Map<String,Object> contextualParameters)	Get the list of query on criteria.
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 Details

ROLE

public static final String ROLE

The component role.

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

SEARCH_MODEL

public static final String SEARCH_MODEL

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

See Also:

• Constant Field Values

_cTypeEP

protected ContentTypeExtensionPoint _cTypeEP

The content type extension point.

_advancedTreeMaker

protected TreeMaker _advancedTreeMaker

The Advanced tree maker

_advancedQueryBuilder

protected AdvancedQueryBuilder _advancedQueryBuilder

The advanced query builder

_searchModelHelper

protected SearchModelHelper _searchModelHelper

The search model helper

Constructor Details

QueryBuilder

public QueryBuilder()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

build

public Query build(SearchModel 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.

getCriteriaQueries

protected org.ametys.cms.search.QueryBuilder.CriteriaQueries getCriteriaQueries(SearchModel model,
 Map<String,Object> values,
 String language,
 Map<String,Object> contextualParameters)

Get the list of query on given model's criteria.

Parameters:

model - the model

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.

getCriteriaQueries

protected org.ametys.cms.search.QueryBuilder.CriteriaQueries getCriteriaQueries(ViewItemAccessor criteria,
 Map<String,Object> values,
 String language,
 Map<String,Object> contextualParameters)

Get the list of query on criteria.

Parameters:

criteria - the list of criteria

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.

getAdvancedCriteriaQuery

protected org.ametys.cms.search.QueryBuilder.CriteriaQueries 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 model containing criterion definitions

values - The submitted values

language - The query language.

contextualParameters - The contextual parameters

Returns:

The criteria Query.