Package org.ametys.cms.search.systemprop

Class AbstractUserIndexableSystemProperty<X extends ModelAwareDataAwareAmetysObject>

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

org.ametys.cms.model.properties.AbstractStaticProperty<UserIdentity,X>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<UserIdentity,UserIdentity,X>

org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<UserIdentity,UserIdentity,X>

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

Type Parameters:

X - type of ametys object supported by this property

All Implemented Interfaces:

Comparable<ModelItem>, Property<UserIdentity,X>, CriterionDefinitionAwareElementDefinition<UserIdentity,UserIdentity,X>, IndexationAwareElementDefinition<UserIdentity,X>, SystemProperty<UserIdentity,X>, IndexationAwareSystemProperty<UserIdentity,X>, ElementDefinition<UserIdentity>, ModelItem, PluginAware, Labelable, ModifiableLabelable, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

ContributorSystemProperty, CreatorSystemProperty, FirstValidatorSystemProperty, LastMajorValidatorSystemProperty, LastValidatorSystemProperty

public abstract class AbstractUserIndexableSystemProperty<X extends ModelAwareDataAwareAmetysObject>
extends AbstractIndexableSystemProperty<UserIdentity,UserIdentity,X>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected UserHelper	_userHelper	The user helper

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

Method Summary

Modifier and Type	Method	Description
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.
String	getSolrFacetFieldName()	Retrieves the name of the element's solr facet field
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected Object	getSortValue(X content)	Get the sort value represented by this field in the given result ametys object.
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(X ametysObject)	Get the element's value
void	service(ServiceManager manager)

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

_getNameConfigurationAttribute, getSchemaDefinitions, indexValue, parseStringArray

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

getCriterionType, getCriterionTypeId

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

getSolrFieldName, 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, valueToJSON, valueToSAX

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

getColumnWidth, getConverter, isDisplayable

Field Details

_userHelper

protected UserHelper _userHelper

The user helper

Constructor Details

AbstractUserIndexableSystemProperty

public AbstractUserIndexableSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractIndexableStaticProperty<UserIdentity,UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Throws:

ServiceException

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Returns:

The column renderer.

_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: IndexationAwareElementDefinition

Get the element's value

Parameters:

ametysObject - the ametysObject containing the element

Returns:

the values to index.

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

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.

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

Overrides:

getSolrSortFieldName in class AbstractIndexableStaticProperty<UserIdentity,UserIdentity,X extends ModelAwareDataAwareAmetysObject>

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

getSortValue

protected Object getSortValue(X content)

Description copied from class: AbstractIndexableSystemProperty

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

Overrides:

getSortValue in class AbstractIndexableSystemProperty<UserIdentity,UserIdentity,X extends ModelAwareDataAwareAmetysObject>

Parameters:

content - the result ametys object.

Returns:

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