Package org.ametys.cms.search.systemprop

Class CommentsSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

org.ametys.cms.model.properties.AbstractStaticProperty<Boolean,Content>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<Boolean,String,Content>

org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<Boolean,String,Content>

org.ametys.cms.search.systemprop.CommentsSystemProperty

All Implemented Interfaces:

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

public class CommentsSystemProperty
extends AbstractIndexableSystemProperty<Boolean,String,Content>

SystemProperty which represents the comments of a content.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOLR_FIELD_NAME	Solr field name.
static final String	SYSTEM_PROPERTY_ID	System property identifier

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

Constructor	Description
CommentsSystemProperty()

Method Summary

Modifier and Type	Method	Description
Integer	getColumnWidth()	Get the column width.
protected String	getCriterionTypeId()	Get the identifier of type to use when rendering the property as a criterion
Enumerator<String>	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 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.
Collection<SchemaDefinition>	getSchemaDefinitions()	Get the schema definitions brought by this element.
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
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
void	indexValue(org.apache.solr.common.SolrInputDocument document, Content content, CMSDataContext context)	Index the element in a solr document.
Object	valueToJSON(Content content, DataContext context)	Convert the property into a JSON object

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

_getNameConfigurationAttribute, getSortValue, parseStringArray

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

getCriterionType, service

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, getDefaultCriterionWidget, 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

getConverter, isDisplayable

Field Details

SYSTEM_PROPERTY_ID

public static final String SYSTEM_PROPERTY_ID

System property identifier

See Also:

• Constant Field Values

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

Constructor Details

CommentsSystemProperty

public CommentsSystemProperty()

Method Details

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.

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.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

getColumnWidth

public Integer getColumnWidth()

Description copied from interface: SystemProperty

Get the column width.

Returns:

the default column width, can be null.

getSolrFieldName

public String 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

public String getSolrSortFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr sort field

Specified by:

getSolrSortFieldName in interface IndexationAwareElementDefinition<Boolean,Content>

Overrides:

getSolrSortFieldName in class AbstractIndexableStaticProperty<Boolean,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

Returns:

the name of the element's solr facet field

getSchemaDefinitions

public Collection<SchemaDefinition> getSchemaDefinitions()

Description copied from interface: IndexationAwareSystemProperty

Get the schema definitions brought by this element.

Specified by:

getSchemaDefinitions in interface IndexationAwareSystemProperty<Boolean,Content>

Overrides:

getSchemaDefinitions in class AbstractIndexableSystemProperty<Boolean,String,Content>

Returns:

The schema definitions used by this element.

indexValue

public void indexValue(org.apache.solr.common.SolrInputDocument document,
 Content content,
 CMSDataContext context)

Description copied from interface: IndexationAwareElementDefinition

Index the element in a solr document.

Specified by:

indexValue in interface IndexationAwareElementDefinition<Boolean,Content>

Overrides:

indexValue in class AbstractIndexableSystemProperty<Boolean,String,Content>

Parameters:

document - the solr document to index into.

content - the ametysObject containing the element to index.

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

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

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

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

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's Enumerator

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

protected String getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

getTypeId in class AbstractProperty<Boolean,Content>

Returns:

the id of the property's type

getCriterionTypeId

protected String getCriterionTypeId()

Description copied from class: AbstractIndexableStaticProperty

Get the identifier of type to use when rendering the property as a criterion

Overrides:

getCriterionTypeId in class AbstractIndexableStaticProperty<Boolean,String,Content>

Returns:

the identifier of type to use for a criterion