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

Class IndexingFieldSearchUICriterion

java.lang.Object

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TermSearchUICriterion

public class IndexingFieldSearchUICriterion
extends AbstractSearchUICriterion
implements IndexingFieldSearchCriterion, Contextualizable, LogEnabled, Disposable

This class is a search criteria on a metadata of a content

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_contentTypeId The ID of the content type which contains the metadata.
private Context	_context
protected ThreadSafeComponentManager<Enumerator>	_enumeratorManager ComponentManager for Enumerators.
protected String	_fieldPath The field path
protected String	_fullPath The field full path
protected boolean	_isMultipleOperandAnd Is it AND or OR for multiple metadata
protected List<String>	_joinPaths The join paths
private Logger	_logger
private ServiceManager	_manager
protected Query.Operator	_operator The criteria operator
protected ContentSearchHelper	_searchHelper The content search helper.
protected UserHelper	_userHelper The user helper
protected ThreadSafeComponentManager<Validator>	_validatorManager ComponentManager for Validators.
static String	SEARCH_CRITERIA_METADATA_PREFIX Prefix for id of metadata search criteria

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

_cTypeEP, _resolver, _userManager, _userPopulationDAO

Constructor Summary

Constructors

Constructor and Description
IndexingFieldSearchUICriterion()

Method Summary

Modifier and Type	Method and Description
private void	_configureDescription(Configuration configuration, IndexingField indexingField, String fieldName, MetadataDefinition definition)
private void	_configureLabel(Configuration configuration, IndexingField indexingField, String fieldName, MetadataDefinition definition)
private void	_configureOperator(Configuration configuration, MetadataDefinition definition) Configure the criterion operator.
private Map<String,I18nizableText>	_configureWidgetParameters(Configuration config, Map<String,I18nizableText> defaultParams)
void	configure(Configuration configuration)
void	contextualize(Context context)
void	dispose()
protected Query	getBooleanQuery(Object value, String fieldPath, Query.Operator operator) Get a boolean query.
protected Query	getContentQuery(Object value, String language, String fieldPath, Query.Operator operator) Get a content query.
protected Query	getDateQuery(Object value, String fieldPath, Query.Operator operator) Get a date query.
protected Query	getDoubleQuery(Object value, String fieldPath, Query.Operator operator) Get a double query.
String	getFieldId() Get the field identifier.
String	getFieldPath() Get the path of field (separated by '/')
protected String	getFieldPath(IndexingField indexingField, String[] remainingPathSegments) Get the field's path without join paths
List<String>	getJoinPaths() Get the join paths, separated with slashes.
protected Query	getLongQuery(Object value, String fieldPath, Query.Operator operator) Get a long query.
protected MetadataDefinition	getMetadataDefinition(IndexingField indexingField, String[] remainingPathSegments, List<String> joinPaths) Get the metadata definition from the indexing field.
Query.Operator	getOperator() Get the 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.
SearchField	getSearchField() Get the SearchField representing this search criterion.
protected Query	getStringQuery(Object value, String language, String fieldPath, Query.Operator operator, boolean isValueEscaped) Get a string query.
protected Query	getUserQuery(Object value, String fieldPath, Query.Operator operator) Get a user query
private static boolean	isEmpty(Object value)
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, configureId, configureLabelsAndGroup, configureUIProperties, configureValues, getChangeClassName, getContentTypeId, getFacetLabel, getGroup, getInitClassName, getMetadataDefinition, 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, getType, 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.model.SearchCriterion

getId, getQuery, isFacetable, isFacetable, isSortable, isSortable

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

getContentTypeId, getEnumerator, getType, isMultiple

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

getDefaultValue, getDescription, getLabel, getValidator, getWidget, getWidgetParameters

Field Detail

SEARCH_CRITERIA_METADATA_PREFIX

public static final String SEARCH_CRITERIA_METADATA_PREFIX

Prefix for id of metadata search criteria

See Also:

Constant Field Values

_searchHelper

protected ContentSearchHelper _searchHelper

The content search helper.

_userHelper

protected UserHelper _userHelper

The user helper

_operator

protected Query.Operator _operator

The criteria operator

_fullPath

protected String _fullPath

The field full path

_fieldPath

protected String _fieldPath

The field path

_joinPaths

protected List<String> _joinPaths

The join paths

_isMultipleOperandAnd

protected boolean _isMultipleOperandAnd

Is it AND or OR for multiple metadata

_contentTypeId

protected String _contentTypeId

The ID of the content type which contains the metadata.

_validatorManager

protected ThreadSafeComponentManager<Validator> _validatorManager

ComponentManager for Validators.

_enumeratorManager

protected ThreadSafeComponentManager<Enumerator> _enumeratorManager

ComponentManager for Enumerators.

_manager

private ServiceManager _manager

_logger

private Logger _logger

_context

private Context _context

Constructor Detail

IndexingFieldSearchUICriterion

public IndexingFieldSearchUICriterion()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

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.

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSearchUICriterion

Throws:

ServiceException

dispose

public void dispose()

Specified by:

dispose in interface Disposable

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractSearchUICriterion

Throws:

ConfigurationException

getOperator

public Query.Operator getOperator()

Get the operator.

Specified by:

getOperator in interface SearchCriterion

Returns:

the operator.

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.

getFieldPath

public String getFieldPath()

Get the path of field (separated by '/')

Specified by:

getFieldPath in interface IndexingFieldSearchCriterion

Returns:

the path of the field.

getJoinPaths

public List<String> getJoinPaths()

Get the join paths, separated with slashes.

Specified by:

getJoinPaths in interface IndexingFieldSearchCriterion

Returns:

the join paths.

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.

isEmpty

private static boolean isEmpty(Object value)

getStringQuery

protected Query getStringQuery(Object value,
                               String language,
                               String fieldPath,
                               Query.Operator operator,
                               boolean isValueEscaped)

Get a string query.

Parameters:

value - The value to use for this criterion.

language - The search language.

fieldPath - The field path.

operator - The query operator to use.

isValueEscaped - true if the given value is already escaped

Returns:

The query.

getBooleanQuery

protected Query getBooleanQuery(Object value,
                                String fieldPath,
                                Query.Operator operator)

Get a boolean query.

Parameters:

value - The value to use for this criterion.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getDoubleQuery

protected Query getDoubleQuery(Object value,
                               String fieldPath,
                               Query.Operator operator)

Get a double query.

Parameters:

value - The value to use for this criterion.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getLongQuery

protected Query getLongQuery(Object value,
                             String fieldPath,
                             Query.Operator operator)

Get a long query.

Parameters:

value - The value to use for this criterion.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getDateQuery

protected Query getDateQuery(Object value,
                             String fieldPath,
                             Query.Operator operator)

Get a date query.

Parameters:

value - The value to use for this criterion.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getContentQuery

protected Query getContentQuery(Object value,
                                String language,
                                String fieldPath,
                                Query.Operator operator)

Get a content query.

Parameters:

value - The value to use for this criterion.

language - The search language.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getUserQuery

protected Query getUserQuery(Object value,
                             String fieldPath,
                             Query.Operator operator)

Get a user query

Parameters:

value - The value to use for this criterion.

fieldPath - The field path.

operator - The query operator to use.

Returns:

The query.

getSearchField

public SearchField getSearchField()

Description copied from interface: SearchCriterion

Get the SearchField representing this search criterion.

Specified by:

getSearchField in interface SearchCriterion

Overrides:

getSearchField in class AbstractSearchUICriterion

Returns:

the SearchField representing this search criterion.

_configureOperator

private void _configureOperator(Configuration configuration,
                                MetadataDefinition definition)
                         throws ConfigurationException

Configure the criterion operator.

Parameters:

configuration - the global criterion configuration.

definition - the metadata definition.

Throws:

ConfigurationException - if an error occurs.

_configureLabel

private void _configureLabel(Configuration configuration,
                             IndexingField indexingField,
                             String fieldName,
                             MetadataDefinition definition)

_configureDescription

private void _configureDescription(Configuration configuration,
                                   IndexingField indexingField,
                                   String fieldName,
                                   MetadataDefinition definition)

_configureWidgetParameters

private Map<String,I18nizableText> _configureWidgetParameters(Configuration config,
                                                              Map<String,I18nizableText> defaultParams)
                                                       throws ConfigurationException

Throws:

ConfigurationException

getMetadataDefinition

protected MetadataDefinition getMetadataDefinition(IndexingField indexingField,
                                                   String[] remainingPathSegments,
                                                   List<String> joinPaths)
                                            throws ConfigurationException

Get the metadata definition from the indexing field. Can be null if the last indexing field is a custom indexing field.

Parameters:

indexingField - The initial indexing field

remainingPathSegments - The path to access the metadata or an another indexing field from the initial indexing field

joinPaths - The consecutive's path in case of joint to access the field/metadata

Returns:

The metadata definition or null if not found

Throws:

ConfigurationException - If an error occurs.

getFieldPath

protected String getFieldPath(IndexingField indexingField,
                              String[] remainingPathSegments)
                       throws ConfigurationException

Get the field's path without join paths

Parameters:

indexingField - The initial indexing field

remainingPathSegments - The path to access the metadata or an another indexing field from the initial indexing field

Returns:

the field's path

Throws:

ConfigurationException - If an error occurs.