org.ametys.cms.search.systemprop

Class TagsSystemProperty

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.systemprop.AbstractSystemProperty

org.ametys.cms.search.systemprop.TagsSystemProperty

All Implemented Interfaces:

SystemProperty, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

TagsSystemProperty

public class TagsSystemProperty
extends AbstractSystemProperty

SystemProperty which represents the tags of a Content.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.model.SystemProperty

SystemProperty.EnumeratorDefinition

Field Summary

Fields

Modifier and Type	Field and Description
protected JSONUtils	_jsonUtils The JSON utils
protected TagProviderExtensionPoint	_tagProviderEP The tag provider extension point.

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

_description, _i18nUtils, _id, _label, _pluginName, _resolver, _userHelper

Constructor Summary

Constructors

Constructor and Description
TagsSystemProperty()

Method Summary

Modifier and Type	Method and Description
String	getConverter() Get the property column converter.
Object	getJsonValue(Content content, boolean full) Get the jsonified value
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.
protected Map<String,Object>	getTagContextualParameters(Content content) Get the tags contextual parameters.
MetadataType	getType() Get the property type.
Object	getValue(Content content) Get the typed raw value for this field in the given result content.
String	getWidget() Get the default widget to use when rendering this property as a criterion.
Map<String,I18nizableText>	getWidgetParameters(Configuration configuration) Get the widget parameters.
void	index(Content content, SolrInputDocument document) Index the system property in a solr document.
protected boolean	isAutopostingEnabled(Content content) Test if autoposting is enabled.
boolean	isMultiple() Get the multiple status of the property.
boolean	isSortable() Get if the property can be sorted on.
void	saxValue(ContentHandler handler, Content content) SAX the value
void	service(ServiceManager manager)

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

_indexBooleanValue, _indexBooleanValues, _indexDateValue, _indexDateValues, _indexDoubleValue, _indexDoubleValues, _indexGeocodeValue, _indexLongValue, _indexLongValues, _indexStringValue, _indexStringValues, _indexUserValue, _indexUserValues, _parseI18nizableText, configure, getDescription, getId, getLabel, getSortValue, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray, setPluginInfo

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

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

getColumnWidth, getContentTypeId, getEnumeratorDefinition, isDisplayable, isFacetable, isSearchable

Field Detail

_tagProviderEP

protected TagProviderExtensionPoint _tagProviderEP

The tag provider extension point.

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

Constructor Detail

TagsSystemProperty

public TagsSystemProperty()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSystemProperty

Throws:

ServiceException

getType

public MetadataType getType()

Description copied from interface: SystemProperty

Get the property type.

Returns:

the property type.

isMultiple

public boolean isMultiple()

Description copied from interface: SystemProperty

Get the multiple status of the property.

Returns:

true if the property can have multiple values, false otherwise.

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.

getSearchField

public SearchField getSearchField()

Description copied from interface: SystemProperty

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

getWidget

public String getWidget()

Description copied from interface: SystemProperty

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

Returns:

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

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters(Configuration configuration)

Description copied from interface: SystemProperty

Get the widget parameters.

Parameters:

configuration - The system property configuration

Returns:

The widget parameters as a Map.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Returns:

The property column converter.

index

public void index(Content content,
                  SolrInputDocument document)

Description copied from interface: SystemProperty

Index the system property in a solr document.

Specified by:

index in interface SystemProperty

Overrides:

index in class AbstractSystemProperty

Parameters:

content - The content to index.

document - The solr document to index into.

getValue

public Object getValue(Content content)

Description copied from interface: SystemProperty

Get the typed raw value for this field in the given result content. The returned object depends on this field's type:
- MetadataType.STRING must return String or String[] if multiple
- MetadataType.DATE or MetadataType.DATETIME must return Date or Date[] if multiple
- MetadataType.LONG must return Long or Long[] if multiple
- MetadataType.DOUBLE must return Double or Double[] if multiple
- MetadataType.CONTENT must return String or String[] if multiple
- MetadataType.GEOCODE must return Map<String, Double>
- MetadataType.USER must return UserIdentity or UserIdentity[] if multiple
- MetadataType.MULTILINGUAL_STRING must return MultilingualString
Others types are not supported.

Parameters:

content - The result content

Returns:

The typed value, cast to the appropriate object according its type.

getJsonValue

public Object getJsonValue(Content content,
                           boolean full)

Description copied from interface: SystemProperty

Get the jsonified value

Parameters:

content - the result content

full - true to get full value.

Returns:

the content field value

saxValue

public void saxValue(ContentHandler handler,
                     Content content)
              throws SAXException

Description copied from interface: SystemProperty

SAX the value

Specified by:

saxValue in interface SystemProperty

Overrides:

saxValue in class AbstractSystemProperty

Parameters:

handler - The content handler to sax into

content - The content

Throws:

SAXException - If an error occurred while saxing

getTagContextualParameters

protected Map<String,Object> getTagContextualParameters(Content content)

Get the tags contextual parameters.

Parameters:

content - The content.

Returns:

the tags contextual parameters.

isAutopostingEnabled

protected boolean isAutopostingEnabled(Content content)

Test if autoposting is enabled.

Parameters:

content - The content.

Returns:

true if enabled.

getSchemaDefinitions

public Collection<SchemaDefinition> getSchemaDefinitions()

Description copied from interface: SystemProperty

Get the schema definitions brought by this property.

Specified by:

getSchemaDefinitions in interface SystemProperty

Overrides:

getSchemaDefinitions in class AbstractSystemProperty

Returns:

The schema definitions used by this property.