Package org.ametys.cms.search.model

Class CriterionDefinitionHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.model.CriterionDefinitionHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class CriterionDefinitionHelper
extends AbstractLogEnabled
implements Component, Serviceable

Helper for CriterionDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected ModelItemTypeExtensionPoint	_criterionTypeExtensionPoint	The extension point containing all available criterion types
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
CriterionDefinitionHelper()

Method Summary

Modifier and Type	Method	Description
String	getCriterionDefinitionDefaultWidget(CriterionDefinition criterionDefinition)	Retrieves the default widget for the given criterion definition
Map<String,I18nizableText>	getCriterionDefinitionDefaultWidgetParameters(CriterionDefinition criterionDefinition)	Retrieves the default widget parameters for the given criterion definition
<T> IndexableElementType<T>	getCriterionDefinitionType(String criterionTypeId)	Retrieves the type implementation of the given criterion type identifier
<T> I18nizableText	getFacetLabel(CriterionDefinition<T> criterion, String value, Locale currentLocale)	Get the label of a facet value for the given criterion.
boolean	isQueryValueEmpty(Object value)	Check if the given query value is empty
Object	parseCriterionDefinitionDefaultValue(Configuration defaultValueConfig, ElementDefinition definition, String defaultValueType)	Parses the criterion definition default value.
void	service(ServiceManager manager)
Configuration	wrapCriterionConfiguration(Configuration originalConf, Set<ContentType> contentTypes)	Wrap the given configuration to add content types

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.

_criterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _criterionTypeExtensionPoint

The extension point containing all available criterion types

Constructor Details

CriterionDefinitionHelper

public CriterionDefinitionHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCriterionDefinitionType

public <T> IndexableElementType<T> getCriterionDefinitionType(String criterionTypeId)

Retrieves the type implementation of the given criterion type identifier

Type Parameters:

T - the type of the criterion type

Parameters:

criterionTypeId - the criterion type identifier

Returns:

the criterion type implementation

getCriterionDefinitionDefaultWidget

public String getCriterionDefinitionDefaultWidget(CriterionDefinition criterionDefinition)

Retrieves the default widget for the given criterion definition

Parameters:

criterionDefinition - the criterion definition

Returns:

the default widget for the given criterion definition

getCriterionDefinitionDefaultWidgetParameters

public Map<String,I18nizableText> getCriterionDefinitionDefaultWidgetParameters(CriterionDefinition criterionDefinition)

Retrieves the default widget parameters for the given criterion definition

Parameters:

criterionDefinition - the criterion definition

Returns:

the default widget parameters for the given criterion definition

wrapCriterionConfiguration

public Configuration wrapCriterionConfiguration(Configuration originalConf,
 Set<ContentType> contentTypes)
                                         throws ConfigurationException

Wrap the given configuration to add content types

Parameters:

originalConf - the configuration to wrap

contentTypes - the content types to add in wrapped configuration

Returns:

the wrapped configuration

Throws:

ConfigurationException - if an error occurs

getFacetLabel

public <T> I18nizableText getFacetLabel(CriterionDefinition<T> criterion,
 String value,
 Locale currentLocale)

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

Type Parameters:

T - the type of the facet criterion

Parameters:

criterion - the criterion

value - the facet value.

currentLocale - the current locale

Returns:

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

isQueryValueEmpty

public boolean isQueryValueEmpty(Object value)

Check if the given query value is empty

Parameters:

value - the query value to check

Returns:

true if the given query value is empty, false otherwise

parseCriterionDefinitionDefaultValue

public Object parseCriterionDefinitionDefaultValue(Configuration defaultValueConfig,
 ElementDefinition definition,
 String defaultValueType)
                                            throws ConfigurationException

Parses the criterion definition default value.

Parameters:

defaultValueConfig - the default value configuration.

definition - the element definition.

defaultValueType - the type of the default value

Returns:

the default value or null if none default value is defined.

Throws:

ConfigurationException - if the configuration is not valid.