Package org.ametys.cms.search.model

Class SearchModelCriterionDefinitionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.model.SearchModelCriterionDefinitionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class SearchModelCriterionDefinitionHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for referencing CriterionDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentSearchHelper	_contentSearchHelper	The content search helper
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected ContentTypesHelper	_contentTypesHelper	The content types helper
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected SearchModelHelper	_searchModelHelper	The search model helper
protected SystemPropertyExtensionPoint	_systemPropertyExtensionPoint	The system property extension point
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
SearchModelCriterionDefinitionHelper()

Method Summary

Modifier and Type	Method	Description
SearchModelCriterionDefinition	createReferencingCriterionDefinition(ElementDefinition reference, String referencePath)	Retrieves a SearchModelCriterionDefinition referencing the given definition
SearchModelCriterionDefinition	createReferencingCriterionDefinition(Model searchModel, String referencePath, Set<String> contentTypeIds)	Retrieves a SearchModelCriterionDefinition referencing the element at the given path
Query	getContentTypesQuery(SearchModelCriterionDefinition criterion, ContentTypeSystemProperty reference, Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value for the criterion referencing content types
String	getLanguageValue(SearchModelCriterionDefinition criterion, Object value, Map<String,Object> allValues, Map<String,Object> contextualParameters)	Retrieves the language associated to the given value.
Class<? extends SearchModelCriterionDefinition>	getStaticCriterionDefinitionClass(Set<ContentType> contentTypes, String reference)	Retrieves the Class to use instantiate a criterion for the given reference
void	service(ServiceManager manager)

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.

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_systemPropertyExtensionPoint

protected SystemPropertyExtensionPoint _systemPropertyExtensionPoint

The system property extension point

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The content types helper

_contentSearchHelper

protected ContentSearchHelper _contentSearchHelper

The content search helper

_searchModelHelper

protected SearchModelHelper _searchModelHelper

The search model helper

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

Constructor Details

SearchModelCriterionDefinitionHelper

public SearchModelCriterionDefinitionHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

createReferencingCriterionDefinition

public SearchModelCriterionDefinition createReferencingCriterionDefinition(Model searchModel,
 String referencePath,
 Set<String> contentTypeIds)

Retrieves a SearchModelCriterionDefinition referencing the element at the given path

Parameters:

searchModel - The SearchModel defining this criterion

referencePath - the path of the element to reference

contentTypeIds - the identifiers of the content types containing the reference

Returns:

the SearchModelCriterionDefinition. Can be null if the reference can not be used as a criterion

createReferencingCriterionDefinition

public SearchModelCriterionDefinition createReferencingCriterionDefinition(ElementDefinition reference,
 String referencePath)

Retrieves a SearchModelCriterionDefinition referencing the given definition

Parameters:

reference - the definition of the element to reference

referencePath - the path of the reference from the model containing the reference

Returns:

the SearchModelCriterionDefinition. Can be null if the reference can not be used as a criterion

getStaticCriterionDefinitionClass

public Class<? extends SearchModelCriterionDefinition> getStaticCriterionDefinitionClass(Set<ContentType> contentTypes,
 String reference)

Retrieves the Class to use instantiate a criterion for the given reference

Parameters:

contentTypes - the content types declaring the referenced item

reference - the reference

Returns:

the Class to use instantiate the criterion. Can be null if the reference can not be used as a criterion

getLanguageValue

public String getLanguageValue(SearchModelCriterionDefinition criterion,
 Object value,
 Map<String,Object> allValues,
 Map<String,Object> contextualParameters)

Retrieves the language associated to the given value.

Parameters:

criterion - the criterion

value - The user-submitted value (or the default value if not set) for the language criterion.

allValues - All the user-submitted values.

contextualParameters - the search contextual parameters.

Returns:

the language associated to the given value.

getContentTypesQuery

public Query getContentTypesQuery(SearchModelCriterionDefinition criterion,
 ContentTypeSystemProperty reference,
 Object value,
 Query.Operator customOperator,
 Map<String,Object> allValues,
 String language,
 Map<String,Object> contextualParameters)

Get the Query associated to the given value for the criterion referencing content types

Parameters:

criterion - the criterion

reference - the content types SystemProperty referenced by the given criterion

value - The user-submitted value (or the default value if not set) for the criterion.

customOperator - In advanced search mode, the operator chosen by the user. null to use the criterion-defined operator (simple search mode).

allValues - All the user-submitted values.

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

The content types Query associated to the given value.