org.ametys.cms.search.ui.model.impl

Class IndexingFieldAggregatorSearchUICriterion

java.lang.Object

org.ametys.runtime.parameter.Parameter<MetadataType>

org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

org.ametys.cms.search.ui.model.impl.IndexingFieldAggregatorSearchUICriterion

All Implemented Interfaces:

Field, SearchCriterion, SearchUICriterion, LogEnabled, Disposable, Configurable, Contextualizable, Serviceable

public class IndexingFieldAggregatorSearchUICriterion
extends AbstractSearchUICriterion
implements Contextualizable, Disposable, LogEnabled

Aggregate multiple indexing field as a unique search criteria. The resulting query is an OR query on all the terms.

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypesHelper	_contentTypesHelper The helper for convenient methods on content types
protected Context	_context The context.
protected ThreadSafeComponentManager<SearchUICriterion>	_fieldCriteriaManager ComponentManager for aggregated SearchUICriterions.
protected Map<String,SearchUICriterion>	_fieldCriteriaMap The map of aggregated criteria
protected Logger	_logger The logger
protected ServiceManager	_manager The service manager
protected MetadataType	_type The type of the aggregated fields
static String	SEARCH_CRITERIA_METADATA_AGGREGATOR_PREFIX Prefix for id of indexing field aggregator search criteria

Fields inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_contentHelper, _cTypeEP, _resolver, _userManager, _userPopulationDAO

Constructor Summary

Constructors

Constructor and Description
IndexingFieldAggregatorSearchUICriterion()

Method Summary

Modifier and Type	Method and Description
private void	_configureWidgetAndWidgetParameters(Configuration configuration)
private List<Pair<String,Configuration>>	_fieldSearchUICriterionToLookup(Configuration[] fieldConfs, MutableConfiguration baseConf)
private void	_initializeFieldCriteria(List<Pair<String,Configuration>> fieldSearchUICriterionToLookup, Configuration fieldsConf)
void	configure(Configuration configuration)
protected void	configureId(Configuration configuration) Configure the criterion ID.
void	contextualize(Context context)
void	dispose()
String	getFieldId() Get the field identifier.
Query.Operator	getOperator() Get the criterion Operator.
Query	getQuery(Object value, Query.Operator customOperator, Map<String,Object> allValues, String language, Map<String,Object> contextualParameters) Get the Query associated to the given value.
MetadataType	getType() Retrieves the type.
boolean	isSortable() Test if the SearchCriterion is sortable.
void	service(ServiceManager manager)
void	setLogger(Logger logger) Called at creation time to provide a Logger.

Methods inherited from class org.ametys.cms.search.ui.model.impl.AbstractSearchUICriterion

_configureI18nizableText, _initializeValidator, configureLabelsAndGroup, configureUIProperties, configureValues, configureWidget, configureWidgetParameters, getChangeClassName, getContentTypeId, getFacetLabel, getGroup, getInitClassName, getMetadataDefinition, getSearchField, getSubmitClassName, isHidden, isMultiple, setChangeClassName, setContentTypeId, setGroup, setHidden, setInitClassName, setMultiple, setSubmitClassName

Methods inherited from class org.ametys.runtime.parameter.Parameter

getDefaultValue, getDescription, getEnumerator, getId, getLabel, getPluginName, getValidator, getWidget, getWidgetParameters, setDefaultValue, setDescription, setEnumerator, setId, setLabel, setPluginName, setType, setValidator, setWidget, setWidgetParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.cms.search.ui.model.SearchUICriterion

getDefaultValue, getDescription, getLabel, getValidator, getWidget, getWidgetParameters

Methods inherited from interface org.ametys.cms.search.model.SearchCriterion

getId, getQuery, isFacetable, isFacetable, isSortable

Methods inherited from interface org.ametys.cms.search.model.Field

getEnumerator

Field Detail

SEARCH_CRITERIA_METADATA_AGGREGATOR_PREFIX

public static final String SEARCH_CRITERIA_METADATA_AGGREGATOR_PREFIX

Prefix for id of indexing field aggregator search criteria

See Also:

Constant Field Values

_fieldCriteriaManager

protected ThreadSafeComponentManager<SearchUICriterion> _fieldCriteriaManager

ComponentManager for aggregated SearchUICriterions.

_fieldCriteriaMap

protected Map<String,SearchUICriterion> _fieldCriteriaMap

The map of aggregated criteria

_logger

protected Logger _logger

The logger

_manager

protected ServiceManager _manager

The service manager

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The helper for convenient methods on content types

_context

protected Context _context

The context.

_type

protected MetadataType _type

The type of the aggregated fields

Constructor Detail

IndexingFieldAggregatorSearchUICriterion

public IndexingFieldAggregatorSearchUICriterion()

Method Detail

setLogger

public void setLogger(Logger logger)

Description copied from interface: LogEnabled

Called at creation time to provide a Logger.

Specified by:

setLogger in interface LogEnabled

Parameters:

logger - a Logger for messages.

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

Overrides:

service in class AbstractSearchUICriterion

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSearchUICriterion

Throws:

ConfigurationException

_fieldSearchUICriterionToLookup

private List<Pair<String,Configuration>> _fieldSearchUICriterionToLookup(Configuration[] fieldConfs,
                                                                         MutableConfiguration baseConf)
                                                                  throws ConfigurationException

Throws:

ConfigurationException

_initializeFieldCriteria

private void _initializeFieldCriteria(List<Pair<String,Configuration>> fieldSearchUICriterionToLookup,
                                      Configuration fieldsConf)
                               throws Exception

Throws:

Exception

_configureWidgetAndWidgetParameters

private void _configureWidgetAndWidgetParameters(Configuration configuration)
                                          throws ConfigurationException

Throws:

ConfigurationException

configureId

protected void configureId(Configuration configuration)
                    throws ConfigurationException

Description copied from class: AbstractSearchUICriterion

Configure the criterion ID.

Overrides:

configureId in class AbstractSearchUICriterion

Parameters:

configuration - The search criterion configuration.

Throws:

ConfigurationException - If an error occurs.

getType

public MetadataType getType()

Description copied from class: Parameter

Retrieves the type.

Specified by:

getType in interface Field

Overrides:

getType in class Parameter<MetadataType>

Returns:

the type.

getQuery

public Query getQuery(Object value,
                      Query.Operator customOperator,
                      Map<String,Object> allValues,
                      String language,
                      Map<String,Object> contextualParameters)

Description copied from interface: SearchCriterion

Get the Query associated to the given value.

Specified by:

getQuery in interface SearchCriterion

Parameters:

value - The user-submitted value (or the default value if not set) for this 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:

Query associated to the given value.

dispose

public void dispose()

Specified by:

dispose in interface Disposable

getFieldId

public String getFieldId()

Description copied from interface: SearchUICriterion

Get the field identifier. Used to match standard, advanced and faceted criterion (even if the operator is different), whatever their ID is.

Specified by:

getFieldId in interface SearchUICriterion

Returns:

the field identifier.

isSortable

public boolean isSortable()

Description copied from interface: SearchCriterion

Test if the SearchCriterion is sortable.

Specified by:

isSortable in interface SearchCriterion

Returns:

true if the criterion is sortable, false otherwise.

getOperator

public Query.Operator getOperator()

Description copied from interface: SearchCriterion

Get the criterion Operator.

Specified by:

getOperator in interface SearchCriterion

Returns:

the criterion Operator.