org.ametys.cms.search.systemprop

Class AbstractSystemProperty

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.systemprop.AbstractSystemProperty

All Implemented Interfaces:

SystemProperty, LogEnabled, PluginAware, Configurable, Serviceable

Direct Known Subclasses:

AbstractUserSystemProperty, CollectionsSystemProperty, CommentsSystemProperty, ContentPrivacySystemProperty, ContentTypeSystemProperty, CreationDateSystemProperty, FulltextSystemProperty, LanguageSystemProperty, LastMajorValidationSystemProperty, LastModifiedSystemProperty, LastValidationSystemProperty, OrphanSystemProperty, PagesSystemProperty, SharedSystemProperty, SiteSystemProperty, TagsSystemProperty, WorkflowStepSystemProperty

public abstract class AbstractSystemProperty
extends AbstractLogEnabled
implements SystemProperty, Serviceable, Configurable, PluginAware

Abstract class providing standard behavior and helper methods for a 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 I18nizableText	_description The property description.
protected I18nUtils	_i18nUtils The i18n utils.
protected String	_id The property ID.
protected I18nizableText	_label The property label.
protected String	_pluginName The property plugin name.

Constructor Summary

Constructors

Constructor and Description
AbstractSystemProperty()

Method Summary

Modifier and Type	Method and Description
private void	_indexSingleValue(SolrInputDocument document, String fieldName, Object value)
protected I18nizableText	_parseI18nizableText(Configuration config, String pluginName, String name) Parse an i18n text.
void	configure(Configuration configuration)
Integer	getColumnWidth() Get the column width.
String	getContentTypeId() In case of a Content reference field, the content type ID.
String	getConverter() Get the property column converter.
I18nizableText	getDescription() Get the system property description.
SystemProperty.EnumeratorDefinition	getEnumeratorDefinition(Collection<String> contentTypes, Configuration configuration) Get the definition of an enumerator.
Object	getFullValue(Content content) Get the value represented by this field in the given result content.
String	getId() Get the system property ID.
I18nizableText	getLabel() Get the system property label.
String	getRenderer() Get the renderer.
Collection<SchemaDefinition>	getSchemaDefinitions() Get the schema definitions brought by this property.
Object	getSortValue(Content content) Get the sort value represented by 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() Get the widget parameters.
void	index(Content content, SolrInputDocument document) Index the system property in a solr document.
boolean	isDisplayable() Get if the property can be displayed (i.e.
boolean	isSearchable() Get if the property can be searched on (i.e.
protected boolean	parseBoolean(Object value) Get the value as a boolean.
protected Date	parseDate(Object value) Get the value as a date.
protected double	parseDouble(Object value) Get the value as a double.
protected long	parseLong(Object value) Get the value as a long.
protected String	parseString(Object value) Get the value as a long.
protected String[]	parseStringArray(Object value) Get the value as a array of String
protected UserIdentity[]	parseUserArray(Object value) Get the value as array of UserIdentity
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

getQuery, getSearchField, getType, getValue, isMultiple, isSortable

Field Detail

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_id

protected String _id

The property ID.

_label

protected I18nizableText _label

The property label.

_description

protected I18nizableText _description

The property description.

_pluginName

protected String _pluginName

The property plugin name.

Constructor Detail

AbstractSystemProperty

public AbstractSystemProperty()

Method Detail

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: SystemProperty

Get the system property ID.

Specified by:

getId in interface SystemProperty

Returns:

The property ID.

getLabel

public I18nizableText getLabel()

Description copied from interface: SystemProperty

Get the system property label.

Specified by:

getLabel in interface SystemProperty

Returns:

The property label.

getDescription

public I18nizableText getDescription()

Description copied from interface: SystemProperty

Get the system property description.

Specified by:

getDescription in interface SystemProperty

Returns:

The property description.

getEnumeratorDefinition

public SystemProperty.EnumeratorDefinition getEnumeratorDefinition(Collection<String> contentTypes,
                                                                   Configuration configuration)

Description copied from interface: SystemProperty

Get the definition of an enumerator.

Specified by:

getEnumeratorDefinition in interface SystemProperty

Parameters:

contentTypes - The model's content types.

configuration - The enumerator configuration.

Returns:

The enumerator definition or null if the property is not enumerated.

getContentTypeId

public String getContentTypeId()

Description copied from interface: SystemProperty

In case of a Content reference field, the content type ID.

Specified by:

getContentTypeId in interface SystemProperty

Returns:

the content type ID.

isSearchable

public boolean isSearchable()

Description copied from interface: SystemProperty

Get if the property can be searched on (i.e. used in a SearchCriterion).

Specified by:

isSearchable in interface SystemProperty

Returns:

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

isDisplayable

public boolean isDisplayable()

Description copied from interface: SystemProperty

Get if the property can be displayed (i.e. used in a ResultField).

Specified by:

isDisplayable in interface SystemProperty

Returns:

true if the property can be displayed, false otherwise.

getWidget

public String getWidget()

Description copied from interface: SystemProperty

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

Specified by:

getWidget in interface SystemProperty

Returns:

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

getWidgetParameters

public Map<String,I18nizableText> getWidgetParameters()

Description copied from interface: SystemProperty

Get the widget parameters.

Specified by:

getWidgetParameters in interface SystemProperty

Returns:

The widget parameters as a Map.

getRenderer

public String getRenderer()

Description copied from interface: SystemProperty

Get the renderer.

Specified by:

getRenderer in interface SystemProperty

Returns:

The column renderer.

getConverter

public String getConverter()

Description copied from interface: SystemProperty

Get the property column converter.

Specified by:

getConverter in interface SystemProperty

Returns:

The property column converter.

getColumnWidth

public Integer getColumnWidth()

Description copied from interface: SystemProperty

Get the column width.

Specified by:

getColumnWidth in interface SystemProperty

Returns:

the default column width, can be null.

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

Parameters:

content - The content to index.

document - The solr document to index into.

_indexSingleValue

private void _indexSingleValue(SolrInputDocument document,
                               String fieldName,
                               Object value)

getFullValue

public Object getFullValue(Content content)

Description copied from interface: SystemProperty

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

Specified by:

getFullValue in interface SystemProperty

Parameters:

content - the result content.

Returns:

the content field value (cast to the appropriate object).

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

Parameters:

content - the result content.

Returns:

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

getSchemaDefinitions

public Collection<SchemaDefinition> getSchemaDefinitions()

Description copied from interface: SystemProperty

Get the schema definitions brought by this property.

Specified by:

getSchemaDefinitions in interface SystemProperty

Returns:

The schema definitions used by this property.

_parseI18nizableText

protected I18nizableText _parseI18nizableText(Configuration config,
                                              String pluginName,
                                              String name)
                                       throws ConfigurationException

Parse an i18n text.

Parameters:

config - the configuration to use.

pluginName - the current plugin name.

name - the child name.

Returns:

the i18n text.

Throws:

ConfigurationException - if the configuration is not valid.

parseString

protected String parseString(Object value)

Get the value as a long.

Parameters:

value - The value as an object.

Returns:

The value as a long.

parseLong

protected long parseLong(Object value)

Get the value as a long.

Parameters:

value - The value as an object.

Returns:

The value as a long.

parseDouble

protected double parseDouble(Object value)

Get the value as a double.

Parameters:

value - The value as an object.

Returns:

The value as a double.

parseBoolean

protected boolean parseBoolean(Object value)

Get the value as a boolean.

Parameters:

value - The value as an object, can be a Boolean or a String.

Returns:

The value as a boolean.

parseDate

protected Date parseDate(Object value)

Get the value as a date.

Parameters:

value - The value as an object, can be a Date or a String.

Returns:

The value as a Date object.

parseUserArray

protected UserIdentity[] parseUserArray(Object value)

Get the value as array of UserIdentity

Parameters:

value - The value to parse

Returns:

A array of UserIdentity

parseStringArray

protected String[] parseStringArray(Object value)

Get the value as a array of String

Parameters:

value - The value as an object to parse

Returns:

The values as a String array