Package org.ametys.cms.search.model

Class SearchModelHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.model.SearchModelHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class SearchModelHelper
extends AbstractLogEnabled
implements Component, Contextualizable, Serviceable

Helper for SearchModel.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_LANGUAGE	The query default language.
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
SearchModelHelper()

Method Summary

Modifier and Type	Method	Description
void	addContentTypeRestrictions(DefaultSearchModel model, String restrictedContentTypeId, Map<String,Object> contextualParameters)	Add content type restrictions on the given search model Add content types to the model and restrict enumerator values of its content types criteria
void	addSolrFilterCriterion(SearchModel model, String solrRequest, Map<String,Object> contextualParameters)	Add a solr filter criterion to the given model
void	contextualize(Context context)
DefaultSearchModel	copySearchModel(SearchModel model, Map<String,Object> contextualParameters)	Copy the given search model
Query	createContentTypeOrMixinQuery(Collection<String> contentTypes)	Create a content type or mixin query.
Query	createContentTypeOrMixinQuery(Collection<String> contentTypes, Query.Operator operator)	Create a content type or mixin query.
List<Object>	getColumnConfigurations(String modelId, Map<String,Object> contextualParameters)	Get the column configurations of search model as JSON object
String	getCriteriaLanguage(SearchModel model, String searchMode, Map<String,Object> values, Map<String,Object> contextualParameters)	Get the language.
static ModelViewItem	getCriterion(ViewItemContainer criteria, String criterionName)	Retrieves the criterion with the given name
SearchModel	getRestrictedSearchModel(String modelId, Map<String,Object> contextualParameters)	Get the search model with the given identifier Add some restrictions on the search model, due to the given contextual parameters (content types / solr request)
Map<String,Object>	getRestrictedSearchModelConfiguration(String modelId, Map<String,Object> contextualParameters)	Get the search model configuration as JSON object.
Map<String,Object>	getSearchModelConfiguration(String modelId, Map<String,Object> contextualParameters)	Get the search model configuration as JSON object
SearchUIModel	getSearchUIModel(String modelId, Map<String,Object> contextualParameters)	Retrieves the SearchUIModel with the given model identifier, with restrictions on content types
void	service(ServiceManager manager)
void	setFacetedCriteria(DefaultSearchModel model, Collection<String> referencePaths, Map<String,Object> contextualParameters)	Set faceted criteria to the given search model from the given reference paths If there is no reference path, the faceted criteria of the model are not changed

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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.

DEFAULT_LANGUAGE

public static final String DEFAULT_LANGUAGE

The query default language.

See Also:

• Constant Field Values

Constructor Details

SearchModelHelper

public SearchModelHelper()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getSearchModelConfiguration

public Map<String,Object> getSearchModelConfiguration(String modelId,
 Map<String,Object> contextualParameters)
                                               throws ProcessingException

Get the search model configuration as JSON object

Parameters:

modelId - The id of search model

contextualParameters - the contextual parameters

Returns:

The search model configuration in a Map

Throws:

ProcessingException - if an error occurred

getRestrictedSearchModelConfiguration

public Map<String,Object> getRestrictedSearchModelConfiguration(String modelId,
 Map<String,Object> contextualParameters)
                                                         throws ProcessingException

Get the search model configuration as JSON object. Add some restrictions on the search model, due to the given contextual parameters (content types / solr request)

Parameters:

modelId - The id of search model

contextualParameters - the contextual parameters

Returns:

The search model configuration in a Map

Throws:

ProcessingException - if an error occurred while converting the model to JSON

getRestrictedSearchModel

public SearchModel getRestrictedSearchModel(String modelId,
 Map<String,Object> contextualParameters)

Get the search model with the given identifier Add some restrictions on the search model, due to the given contextual parameters (content types / solr request)

Parameters:

modelId - The id of search model

contextualParameters - the contextual parameters

Returns:

The search model

getColumnConfigurations

public List<Object> getColumnConfigurations(String modelId,
 Map<String,Object> contextualParameters)
                                     throws ProcessingException

Get the column configurations of search model as JSON object

Parameters:

modelId - The id of search model

contextualParameters - the contextual parameters

Returns:

The column configurations in a List

Throws:

ProcessingException - if an error occurred

getSearchUIModel

public SearchUIModel getSearchUIModel(String modelId,
 Map<String,Object> contextualParameters)

Retrieves the SearchUIModel with the given model identifier, with restrictions on content types

Parameters:

modelId - the model identifier

contextualParameters - the contextual parameters

Returns:

the SearchUIModel

copySearchModel

public DefaultSearchModel copySearchModel(SearchModel model,
 Map<String,Object> contextualParameters)

Copy the given search model

Parameters:

model - the model to copy

contextualParameters - the contextual parameters

Returns:

the copy of the model

addContentTypeRestrictions

public void addContentTypeRestrictions(DefaultSearchModel model,
 String restrictedContentTypeId,
 Map<String,Object> contextualParameters)

Add content type restrictions on the given search model Add content types to the model and restrict enumerator values of its content types criteria

Parameters:

model - the model

restrictedContentTypeId - the selected content type identifier

contextualParameters - the contextual parameters

addSolrFilterCriterion

public void addSolrFilterCriterion(SearchModel model,
 String solrRequest,
 Map<String,Object> contextualParameters)

Add a solr filter criterion to the given model

Parameters:

model - the model

solrRequest - the solr request

contextualParameters - the contextual parameters

setFacetedCriteria

public void setFacetedCriteria(DefaultSearchModel model,
 Collection<String> referencePaths,
 Map<String,Object> contextualParameters)

Set faceted criteria to the given search model from the given reference paths If there is no reference path, the faceted criteria of the model are not changed

Parameters:

model - the search model

referencePaths - the reference paths

contextualParameters - the contextual parameters

getCriteriaLanguage

public String getCriteriaLanguage(SearchModel 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.

createContentTypeOrMixinQuery

public Query createContentTypeOrMixinQuery(Collection<String> contentTypes)

Create a content type or mixin query.

Parameters:

contentTypes - the content types or mixins to search on.

Returns:

the content type Query.

createContentTypeOrMixinQuery

public Query createContentTypeOrMixinQuery(Collection<String> contentTypes,
 Query.Operator operator)

Create a content type or mixin query.

Parameters:

contentTypes - the content types or mixins to search on.

operator - The operator to use in created query

Returns:

the content type Query.

getCriterion

public static ModelViewItem getCriterion(ViewItemContainer criteria,
 String criterionName)

Retrieves the criterion with the given name

Parameters:

criteria - the criteria

criterionName - the name of the searched criterion

Returns:

the criterion with the given name, or null if no corresponding criterion has been found