Package org.ametys.web.search.systemprop

Class SiteSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

org.ametys.runtime.model.DefaultElementDefinition<String>

org.ametys.cms.model.properties.AbstractProperty<String,Content>

org.ametys.cms.search.systemprop.AbstractSystemProperty<String,Content>

org.ametys.web.search.systemprop.SiteSystemProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<String,Content>, CriterionDefinitionAwareElementDefinition<String>, IndexationAwareElementDefinition<String,Content>, SystemProperty<String,Content>, IndexationAwareSystemProperty<String,Content>, ElementDefinition<String>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

public class SiteSystemProperty
extends AbstractSystemProperty<String,Content>
implements CriterionDefinitionAwareElementDefinition<String>, IndexationAwareSystemProperty<String,Content>

SystemProperty which represents the site of a Content.

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected SiteQueryHelper	_siteQueryHelper	The site query helper
static final String	SOLR_FIELD_NAME	Solr field name.

Fields inherited from class org.ametys.cms.model.properties.AbstractProperty

_availableTypesExtensionPoint, _context, _manager

Fields inherited from class org.ametys.runtime.model.DefaultElementDefinition

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__context, __serviceManager

Fields inherited from interface org.ametys.runtime.model.ElementDefinition

CONFIG_DEFAULT_VALUE_TYPE

Fields inherited from interface org.ametys.runtime.model.ModelItem

ITEM_PATH_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
SiteSystemProperty()

Method Summary

Modifier and Type	Method	Description
Object	convertQueryValue(Object value, String language, Map<String,Object> contextualParameters)	Converts the given value to have the right typed for value to give to the CriterionDefinitionAwareElementDefinition.getQuery(Object, Operator, String, Map) method
String	getConverter()	Get the property column converter.
Enumerator<String>	getDefaultCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this property as a criterion
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
String	getDefaultCriterionWidget()	Get the widget to use when rendering the property as a criterion
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
String	getRenderer()	Get the renderer.
String	getSolrFacetFieldName()	Retrieves the name of the element's solr facet field
String	getSolrFieldName()	Retrieves the name of the element's solr field
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
Object	getSortValue(Content content)	Get the sort value represented by this field in the given result ametys object.
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
void	service(ServiceManager manager)
Object	valueToJSON(Content content, DataContext context)	Convert the property into a JSON object

Methods inherited from class org.ametys.cms.search.systemprop.AbstractSystemProperty

_getNameConfigurationAttribute, parseStringArray

Methods inherited from class org.ametys.cms.model.properties.AbstractProperty

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _toJSON, _widgetToJSON, _widgetToSAX, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, getWidget, getWidgetParameters, isMultiple, of, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setType, setValidator, setValidatorConfiguration, setWidget, setWidgetParameters, toSAX

Methods inherited from class org.ametys.runtime.model.AbstractModelItem

_getModelItemHelper, _shouldJSONBeEmpty, _widgetParameterToSAX, addItemChecker, compareTo, disableConditionsToJSON, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, setContext, setDescription, setDisableConditions, setLabel, setModel, setName, setParent, setPluginName, setServiceManager, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

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

getDefaultCriterionOperator, getDefaultCriterionWidgetParameters, getType

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, isMultiple, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

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

getType, isFacetable, isSortable

Methods inherited from interface org.ametys.cms.search.systemprop.IndexationAwareSystemProperty

getSchemaDefinitions, indexValue

Methods inherited from interface org.ametys.runtime.util.Labelable

getDescription, getLabel, getName

Methods inherited from interface org.ametys.runtime.model.ModelItem

addItemChecker, getDisableConditions, getItemCheckers, getModel, getParent, getPath, getPluginName, getWidget, getWidgetParameters, setDisableConditions, setModel, setParent, setPluginName, setType, setWidget, setWidgetParameters, toJSON, toSAX

Methods inherited from interface org.ametys.runtime.util.ModifiableLabelable

setDescription, setLabel, setName

Methods inherited from interface org.ametys.cms.model.properties.Property

getType, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToSAX

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

getColumnWidth, isDisplayable

Field Details

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

_siteQueryHelper

protected SiteQueryHelper _siteQueryHelper

The site query helper

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

Constructor Details

SiteSystemProperty

public SiteSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<String,Content>

Throws:

ServiceException

convertQueryValue

public Object convertQueryValue(Object value,
 String language,
 Map<String,Object> contextualParameters)
                         throws BadItemTypeException

Description copied from interface: CriterionDefinitionAwareElementDefinition

Converts the given value to have the right typed for value to give to the CriterionDefinitionAwareElementDefinition.getQuery(Object, Operator, String, Map) method

Specified by:

convertQueryValue in interface CriterionDefinitionAwareElementDefinition<String>

Parameters:

value - the value to convert

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

the value, converted to a well typed value

Throws:

BadItemTypeException - if the given value can not be converted

getQuery

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

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the Query associated to the given value.

Specified by:

getQuery in interface CriterionDefinitionAwareElementDefinition<String>

Parameters:

value - the user-submitted value for this property.

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

language - The current search language.

contextualParameters - the search contextual parameters.

Returns:

The Query associated to the given value.

getDefaultCriterionWidget

public String getDefaultCriterionWidget()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget to use when rendering the property as a criterion

Specified by:

getDefaultCriterionWidget in interface CriterionDefinitionAwareElementDefinition<String>

Returns:

The widget to use, or null if no specific widget is necessary.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Specified by:

getRenderer in interface SystemProperty<String,Content>

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Specified by:

getConverter in interface SystemProperty<String,Content>

Returns:

The property column converter.

getSolrFieldName

public String getSolrFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr field

Specified by:

getSolrFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr field

getSolrSortFieldName

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr sort field

getSolrFacetFieldName

public String getSolrFacetFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr facet field

Specified by:

getSolrFacetFieldName in interface IndexationAwareElementDefinition<String,Content>

Returns:

the name of the element's solr facet field

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Specified by:

getValue in interface IndexationAwareElementDefinition<String,Content>

Specified by:

getValue in interface Property<String,Content>

Parameters:

content - the ametysObject containing the element

Returns:

the values to index.

valueToJSON

public Object valueToJSON(Content content,
 DataContext context)

Description copied from interface: Property

Convert the property into a JSON object

Specified by:

valueToJSON in interface Property<String,Content>

Parameters:

content - the ametysObject containing the property to convert.

context - the context of the data to convert. Can not be null.

Returns:

The property as JSON

getSortValue

public Object getSortValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the sort value represented by this field in the given result ametys object.

Specified by:

getSortValue in interface IndexationAwareElementDefinition<String,Content>

Parameters:

content - the result ametys object.

Returns:

the content sort value, must be scalar (String, long, double, Date).

getDefaultCriterionEnumerator

public Enumerator<String> getDefaultCriterionEnumerator(Configuration configuration,
 ThreadSafeComponentManager<Enumerator> enumeratorManager)
                                                 throws ConfigurationException

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the enumerator to use when rendering this property as a criterion

Specified by:

getDefaultCriterionEnumerator in interface CriterionDefinitionAwareElementDefinition<String>

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if the property's criterion is not enumerated.

Throws:

ConfigurationException - If an error occurs while initializing the enumerator

getTypeId

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<String,Content>

Returns:

the id of the property's type

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<String>

Returns:

the type to use for a criterion