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.model.properties.AbstractStaticProperty<String,Content>
org.ametys.cms.model.properties.AbstractIndexableStaticProperty<String,String,Content>
org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<String,String,Content>
org.ametys.web.search.systemprop.SiteSystemProperty
- All Implemented Interfaces:
Comparable<ModelItem>
,Property<String,
,Content> CriterionDefinitionAwareElementDefinition<String,
,String, Content> IndexationAwareElementDefinition<String,
,Content> SystemProperty<String,
,Content> IndexationAwareSystemProperty<String,
,Content> ElementDefinition<String>
,ModelItem
,PluginAware
,Labelable
,ModifiableLabelable
,Configurable
,Contextualizable
,Serviceable
SystemProperty
which represents the site of a Content.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected SiteQueryHelper
The site query helperstatic final String
Solr field name.Fields inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty
_criterionDefinitionHelper, _indexationAwareElementDefinitionHelper
Fields inherited from class org.ametys.cms.model.properties.AbstractStaticProperty
_context
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 -
Method Summary
Modifier and TypeMethodDescriptionGet the property column converter.getDefaultCriterionEnumerator
(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager) Get the enumerator to use when rendering this item as a criterion, if no other enumerator is specified on criterionGet the widget to use when rendering this item as a criterion, if no other widget is specified on criteriongetQuery
(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Get theQuery
associated to the given value.Get the renderer.Retrieves the name of the element's solr facet fieldRetrieves the name of the element's solr fieldRetrieves the name of the element's solr sort fieldgetSortValue
(Content content) Get the sort value represented by this field in the given result ametys object.protected String
Retrieves the id of the property's typeGet the element's valuevoid
service
(ServiceManager manager) valueToJSON
(Content content, DataContext context) Convert the property into a JSON objectMethods inherited from class org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty
_getNameConfigurationAttribute, getSchemaDefinitions, indexValue, parseStringArray
Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty
getCriterionType, getCriterionTypeId
Methods inherited from class org.ametys.cms.model.properties.AbstractStaticProperty
_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, configure, contextualize
Methods inherited from class org.ametys.cms.model.properties.AbstractProperty
getType, init, isEditable, setPluginInfo
Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition
_defaultValueToJSON, _getDefaultValues, _getSimpleDefaultValue, _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
convertQueryValue, getDefaultCriterionOperator, getDefaultCriterionWidgetParameters
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.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, init, valueToSAX
Methods inherited from interface org.ametys.cms.search.model.SystemProperty
getColumnWidth, isDisplayable
-
Field Details
-
SOLR_FIELD_NAME
Solr field name.- See Also:
-
_siteQueryHelper
The site query helper
-
-
Constructor Details
-
SiteSystemProperty
public SiteSystemProperty()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractIndexableStaticProperty<String,
String, Content> - Throws:
ServiceException
-
getQuery
public Query getQuery(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Description copied from interface:CriterionDefinitionAwareElementDefinition
Get theQuery
associated to the given value.- Parameters:
value
- the user-submitted value for this item.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
Description copied from interface:CriterionDefinitionAwareElementDefinition
Get the widget to use when rendering this item as a criterion, if no other widget is specified on criterion- Returns:
- The widget to use, or
null
if no specific widget is necessary by default.
-
getRenderer
Description copied from interface:SystemProperty
Get the renderer.- Returns:
- The column renderer.
-
getConverter
Description copied from interface:SystemProperty
Get the property column converter.- Returns:
- The property column converter.
-
getSolrFieldName
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr field- Returns:
- the name of the element's solr field
-
getSolrSortFieldName
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr sort field- Specified by:
getSolrSortFieldName
in interfaceIndexationAwareElementDefinition<String,
Content> - Overrides:
getSolrSortFieldName
in classAbstractIndexableStaticProperty<String,
String, Content> - Returns:
- the name of the element's solr sort field
-
getSolrFacetFieldName
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr facet field- Returns:
- the name of the element's solr facet field
-
getValue
Description copied from interface:IndexationAwareElementDefinition
Get the element's value- Parameters:
content
- the ametysObject containing the element- Returns:
- the values to index.
-
valueToJSON
Description copied from interface:Property
Convert the property into a JSON object- 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
Description copied from class:AbstractIndexableSystemProperty
Get the sort value represented by this field in the given result ametys object.- Overrides:
getSortValue
in classAbstractIndexableSystemProperty<String,
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 item as a criterion, if no other enumerator is specified on criterion- Parameters:
configuration
- The enumerator configuration.enumeratorManager
- ComponentManager for the criterion'sEnumerator
- Returns:
- The enumerator or
null
if there is no default enumerator for the criterion - Throws:
ConfigurationException
- If an error occurs while initializing the enumerator
-
getTypeId
Description copied from class:AbstractProperty
Retrieves the id of the property's type- Specified by:
getTypeId
in classAbstractProperty<String,
Content> - Returns:
- the id of the property's type
-