Package org.ametys.cms.search.model

Class SearchCriterionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.model.SearchCriterionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class SearchCriterionHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for SearchCriterion

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected AmetysObjectResolver	_resolver	The ametys object resolver.
protected SearchModelHelper	_searchModelHelper	The searchModelHelper
protected UserManager	_userManager	The user manager.
protected UserPopulationDAO	_userPopulationDAO	The user population DAO
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
SearchCriterionHelper()

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllContentTypes(SearchModel model, Map<String,Object> contextualParameters)	Get all the real content types that a model works on (the included content types, minus the excluded types).
Configuration	getCustomCriteriaConfiguration(SearchModel searchModel, Optional<Configuration> originalConf, Set<String> baseContentTypeIds, String customCriterionId, Optional<I18nizableText> group)	Get the configuration of a custom criteria component.
I18nizableText	getFacetLabel(SearchCriterion criterion, String value, Locale currentLocale)	Get the label of a facet value for the given criterion.
Configuration	getIndexingFieldCriteriaConfiguration(Optional<Configuration> originalConf, Set<String> baseContentTypeIds, String path, Optional<Query.Operator> operator, Optional<I18nizableText> group)	Get the configuration of a criteria component.
Configuration	getIndexingFieldCriteriaConfiguration(SearchModel searchModel, Optional<Configuration> originalConf, Set<String> baseContentTypeIds, String path, Optional<Query.Operator> operator, Optional<I18nizableText> group)	Get the configuration of a criteria component.
Configuration	getSystemCriteriaConfiguration(Optional<Configuration> originalConf, Set<String> baseContentTypeIds, String propertyId, Optional<I18nizableText> group)	Get the configuration of a system criteria component.
Configuration	getSystemCriteriaConfiguration(SearchModel searchModel, Optional<Configuration> originalConf, Set<String> baseContentTypeIds, String propertyId, Optional<I18nizableText> group)	Get the configuration of a system criteria component.
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.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_searchModelHelper

protected SearchModelHelper _searchModelHelper

The searchModelHelper

_userManager

protected UserManager _userManager

The user manager.

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

Constructor Details

SearchCriterionHelper

public SearchCriterionHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getIndexingFieldCriteriaConfiguration

public Configuration getIndexingFieldCriteriaConfiguration(Optional<Configuration> originalConf,
 Set<String> baseContentTypeIds,
 String path,
 Optional<Query.Operator> operator,
 Optional<I18nizableText> group)
                                                    throws ConfigurationException

Get the configuration of a criteria component.

Parameters:

originalConf - the optional original criteria configuration.

baseContentTypeIds - the "base" content type identifiers.

path - the field path.

operator - the optional criteria operator

group - the optional group

Returns:

the configuration to provide to the criteria component.

Throws:

ConfigurationException - if an error occurs.

getIndexingFieldCriteriaConfiguration

public Configuration getIndexingFieldCriteriaConfiguration(SearchModel searchModel,
 Optional<Configuration> originalConf,
 Set<String> baseContentTypeIds,
 String path,
 Optional<Query.Operator> operator,
 Optional<I18nizableText> group)
                                                    throws ConfigurationException

Get the configuration of a criteria component.

Parameters:

searchModel - the search model.

originalConf - the optional original criteria configuration.

baseContentTypeIds - the "base" content type identifiers.

path - the field path.

operator - the optional criteria operator

group - the optional group

Returns:

the configuration to provide to the criteria component.

Throws:

ConfigurationException - if an error occurs.

getSystemCriteriaConfiguration

public Configuration getSystemCriteriaConfiguration(Optional<Configuration> originalConf,
 Set<String> baseContentTypeIds,
 String propertyId,
 Optional<I18nizableText> group)
                                             throws ConfigurationException

Get the configuration of a system criteria component.

Parameters:

originalConf - the optional original criteria configuration.

baseContentTypeIds - the "base" content type identifiers.

propertyId - the system property identifier.

group - The optional group.

Returns:

the configuration to provide to the system criterion component.

Throws:

ConfigurationException - if an error occurs.

getSystemCriteriaConfiguration

public Configuration getSystemCriteriaConfiguration(SearchModel searchModel,
 Optional<Configuration> originalConf,
 Set<String> baseContentTypeIds,
 String propertyId,
 Optional<I18nizableText> group)
                                             throws ConfigurationException

Get the configuration of a system criteria component.

Parameters:

searchModel - the search model.

originalConf - the optional original criteria configuration.

baseContentTypeIds - the "base" content type identifiers.

propertyId - the system property identifier.

group - The optional group.

Returns:

the configuration to provide to the system criterion component.

Throws:

ConfigurationException - if an error occurs.

getCustomCriteriaConfiguration

public Configuration getCustomCriteriaConfiguration(SearchModel searchModel,
 Optional<Configuration> originalConf,
 Set<String> baseContentTypeIds,
 String customCriterionId,
 Optional<I18nizableText> group)
                                             throws ConfigurationException

Get the configuration of a custom criteria component.

Parameters:

searchModel - the search model.

originalConf - the original criteria configuration.

baseContentTypeIds - the "base" content type identifiers.

customCriterionId - the custom criterion id

group - The group. Can be null.

Returns:

the configuration to provide to the custom criterion component.

Throws:

ConfigurationException - if an error occurs.

getAllContentTypes

public Set<String> getAllContentTypes(SearchModel model,
 Map<String,Object> contextualParameters)

Get all the real content types that a model works on (the included content types, minus the excluded types).

Parameters:

model - the search model.

contextualParameters - the contextual parameters.

Returns:

a Set of the content type IDs.

getFacetLabel

public I18nizableText getFacetLabel(SearchCriterion criterion,
 String value,
 Locale currentLocale)

Get the label of a facet value for the given criterion.

Parameters:

criterion - the criterion

value - the facet value.

currentLocale - the current locale

Returns:

the label, or null if the value does not exist.