Package org.ametys.cms.search.systemprop

Class AbstractUserSystemProperty<X extends ModelAwareDataAwareAmetysObject>

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<UserIdentity,X>

org.ametys.cms.search.systemprop.AbstractUserSystemProperty<X>

Type Parameters:

X - type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, Property<UserIdentity,X>, SystemProperty<UserIdentity,X>, ElementDefinition<UserIdentity>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Serviceable

Direct Known Subclasses:

ContributorSystemProperty, CreatorSystemProperty, FirstValidatorSystemProperty, LastMajorValidatorSystemProperty, LastValidatorSystemProperty

public abstract class AbstractUserSystemProperty<X extends ModelAwareDataAwareAmetysObject>
extends AbstractSystemProperty<UserIdentity,X>

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

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
AbstractUserSystemProperty()

Method Summary

Modifier and Type	Method	Description
protected abstract String	_getSolrFieldName()	Get the Solr field name
protected String	_getTypeId()	Retrieves the id of the property's type
protected abstract UserIdentity	_getUserIdentityValue(X ametysObject)	Get the value as UserIdentity
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(X content)	Get the sort value represented by this field in the given result ametys object.
Object	getValue(X ametysObject)	Get the property's value

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

_getNameConfigurationAttribute, getSchemaDefinitions, indexValue, 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

_getDefaultValue, _getParsedDefaultValues, _toJSON, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, 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

_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, getCriterionEnumerator, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getValidator, getValidatorConfiguration, isEditable, isMultiple, 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

getCriterionWidget, getCriterionWidgetParameters, getType, setAvailableTypeExtensionPoint, valueToJSON, valueToJSON, valueToSAX, valueToSAX

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

getColumnWidth, getConverter, getSearchField, isDisplayable, isFacetable, isSearchable, isSortable

Constructor Details

AbstractUserSystemProperty

public AbstractUserSystemProperty()

Method Details

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

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

_getUserIdentityValue

protected abstract UserIdentity _getUserIdentityValue(X ametysObject)

Get the value as UserIdentity

Parameters:

ametysObject - the ametys object

Returns:

the user identity

getValue

public Object getValue(X ametysObject)

Description copied from interface: Property

Get the property's value

Parameters:

ametysObject - the ametysObject containing the property

Returns:

the values to index.

getSortValue

public Object getSortValue(X content)

Description copied from interface: SystemProperty

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

Specified by:

getSortValue in interface SystemProperty<UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Overrides:

getSortValue in class AbstractSystemProperty<UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Parameters:

content - the result ametys object.

Returns:

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

_getTypeId

protected String _getTypeId()

Description copied from class: AbstractProperty

Retrieves the id of the property's type

Specified by:

_getTypeId in class AbstractProperty<UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Returns:

the id of the property's type