org.ametys.cms.search.systemprop

Class AbstractUserSystemProperty

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.systemprop.AbstractSystemProperty

org.ametys.cms.search.systemprop.AbstractUserSystemProperty

All Implemented Interfaces:

SystemProperty, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

ContributorSystemProperty, CreatorSystemProperty

public abstract class AbstractUserSystemProperty
extends AbstractSystemProperty

Abstract class providing base functionality for a user-typed SystemProperty.

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 UserHelper	_userHelper The user helper

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

_description, _i18nUtils, _id, _label, _pluginName

Constructor Summary

Constructors

Constructor and Description
AbstractUserSystemProperty()

Method Summary

Modifier and Type	Method and Description
protected abstract String	_getSolrFieldName() Get the Solr field name
String	getConverter() Get the property column converter.
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.
Object	getSortValue(Content content) Get the sort value represented by this field in the given result content.
MetadataType	getType() Get the property type.
void	service(ServiceManager manager)
protected void	setUserInfos(Map<String,Object> infos, UserIdentity user) Set the user info in the given map.

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

_parseI18nizableText, configure, getColumnWidth, getContentTypeId, getDescription, getEnumeratorDefinition, getFullValue, getId, getLabel, getSchemaDefinitions, getWidget, getWidgetParameters, index, isDisplayable, isSearchable, 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

getSearchField, getValue, isMultiple, isSortable

Field Detail

_userHelper

protected UserHelper _userHelper

The user helper

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils

Constructor Detail

AbstractUserSystemProperty

public AbstractUserSystemProperty()

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.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Specified by:

getRenderer in interface SystemProperty

Overrides:

getRenderer in class AbstractSystemProperty

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Specified by:

getConverter in interface SystemProperty

Overrides:

getConverter in class AbstractSystemProperty

Returns:

The property column converter.

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.

_getSolrFieldName

protected abstract String _getSolrFieldName()

Get the Solr field name

Returns:

the field name

getSortValue

public Object getSortValue(Content content)

Description copied from interface: SystemProperty

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

Specified by:

getSortValue in interface SystemProperty

Overrides:

getSortValue in class AbstractSystemProperty

Parameters:

content - the result content.

Returns:

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

setUserInfos

protected void setUserInfos(Map<String,Object> infos,
                            UserIdentity user)

Set the user info in the given map.

Parameters:

infos - The map to fill with the user infos.

user - The user.