Package org.ametys.cms.search.systemprop

Class CommentsSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<T,X>

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

org.ametys.cms.search.systemprop.CommentsSystemProperty

All Implemented Interfaces:

Comparable<ModelItem>, Property<Boolean,Content>, SystemProperty<Boolean,Content>, ElementDefinition<Boolean>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Serviceable

public class CommentsSystemProperty
extends AbstractSystemProperty<Boolean,Content>

SystemProperty which represents the comments of a content.

Field Summary

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

_i18nUtils, _manager, _resolver, _userHelper, _userManager

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

_availableTypesExtensionPoint

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

_logger

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

__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
protected String	_getTypeId()	Retrieves the id of the property's type
Integer	getColumnWidth()	Get the column width.
Enumerator<String>	getCriterionEnumerator(Configuration configuration, ThreadSafeComponentManager<Enumerator> enumeratorManager)	Get the enumerator to use when rendering this element as a criterion
String	getCriterionWidget()	Get the default widget to use when rendering this item 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.
Collection<SchemaDefinition>	getSchemaDefinitions()	Get the schema definitions brought by this property.
SearchField	getSearchField()	Get the SearchField representing this system property.
Object	getValue(Content content)	Get the property's value
void	indexValue(org.apache.solr.common.SolrInputDocument document, Content content, IndexableDataContext context)	Index the property in a solr document.
boolean	isMultiple()	Test if the element is multiple.
boolean	isSortable()	Get if the property can be sorted on.
Object	valueToJSON(Content content, Optional<ViewItem> viewItem, DataContext context)	Convert the property into a JSON object

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

_getNameConfigurationAttribute, getSortValue, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray, service

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

_parseI18nizableText, configure, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

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

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

_shouldJSONBeEmpty, _widgetParameterToSAX, _widgetToSAX, addItemChecker, compareTo, equals, getDescription, getDisableConditions, getItemCheckers, getLabel, getModel, getName, getParent, getPath, getPluginName, hashCode, 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.runtime.model.ElementDefinition

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

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

getCriterionWidgetParameters, getType, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX, valueToSAX

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

getConverter, isDisplayable, isFacetable, isSearchable

Constructor Details

CommentsSystemProperty

public CommentsSystemProperty()

Method Details

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<Boolean>

Overrides:

isMultiple in class DefaultElementDefinition<Boolean>

Returns:

true if the metadata is multiple.

isSortable

public boolean isSortable()

Description copied from interface: SystemProperty

Get if the property can be sorted on.

Returns:

true if the property can be sorted on, false otherwise.

getQuery

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

Description copied from interface: SystemProperty

Get the Query associated to the given value.

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.

getCriterionWidget

public String getCriterionWidget()

Description copied from interface: ModelItem

Get the default widget to use when rendering this item as a criterion.

Returns:

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

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.

getSearchField

public SearchField getSearchField()

Description copied from interface: SystemProperty

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

getSchemaDefinitions

public Collection<SchemaDefinition> getSchemaDefinitions()

Description copied from interface: SystemProperty

Get the schema definitions brought by this property.

Specified by:

getSchemaDefinitions in interface SystemProperty<Boolean,Content>

Overrides:

getSchemaDefinitions in class AbstractSystemProperty<Boolean,Content>

Returns:

The schema definitions used by this property.

indexValue

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

Description copied from interface: Property

Index the property in a solr document.

Specified by:

indexValue in interface Property<Boolean,Content>

Overrides:

indexValue in class AbstractSystemProperty<Boolean,Content>

Parameters:

document - the solr document to index into.

content - the ametysObject containing the property to index.

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

getValue

public Object getValue(Content content)

Description copied from interface: Property

Get the property's value

Parameters:

content - the ametysObject containing the property

Returns:

the values to index.

valueToJSON

public Object valueToJSON(Content content,
 Optional<ViewItem> viewItem,
 DataContext context)

Description copied from interface: Property

Convert the property into a JSON object

Parameters:

content - the ametysObject containing the property to convert.

viewItem - The optional view item corresponding property that is currently saxed. This view item gives context for the SAX event that will be generated here.

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

Returns:

The property as JSON

getCriterionEnumerator

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

Description copied from interface: ElementDefinition

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

Parameters:

configuration - The enumerator configuration.

enumeratorManager - ComponentManager for the criterion's Enumerator

Returns:

The enumerator or null if the element'critérion 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<Boolean,Content>

Returns:

the id of the property's type