org.ametys.web.search.systemprop

Class PagesSystemProperty

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.search.systemprop.AbstractSystemProperty

org.ametys.web.search.systemprop.PagesSystemProperty

All Implemented Interfaces:

SystemProperty, LogEnabled, PluginAware, Configurable, Serviceable

public class PagesSystemProperty
extends AbstractSystemProperty

SystemProperty which represents the pages of a Content.

Nested Class Summary

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

SystemProperty.EnumeratorDefinition

Field Summary

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

_description, _i18nUtils, _id, _label, _pluginName

Constructor Summary

Constructors

Constructor and Description
PagesSystemProperty()

Method Summary

Modifier and Type	Method and Description
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters) Get the Query associated to the given value.
SearchField	getSearchField() Get the SearchField representing this system property.
MetadataType	getType() Get the property type.
Object	getValue(Content content) Get the 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.
boolean	isDisplayable() Get if the property can be displayed (i.e.
boolean	isMultiple() Get the multiple status of the property.
boolean	isSortable() Get if the property can be sorted on.

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

_parseI18nizableText, configure, getColumnWidth, getContentTypeId, getConverter, getDescription, getEnumeratorDefinition, getFullValue, getId, getLabel, getRenderer, getSchemaDefinitions, getSortValue, index, isSearchable, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray, service, 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

Constructor Detail

PagesSystemProperty

public PagesSystemProperty()

Method Detail

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.

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

Overrides:

isDisplayable in class AbstractSystemProperty

Returns:

true if the property can be displayed, 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.

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

Overrides:

getWidget in class AbstractSystemProperty

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

Overrides:

getWidgetParameters in class AbstractSystemProperty

Returns:

The widget parameters as a Map.

getSearchField

public SearchField getSearchField()

Description copied from interface: SystemProperty

Get the SearchField representing this system property.

Returns:

The search field representing this system property.

getValue

public Object getValue(Content content)

Description copied from interface: SystemProperty

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

Parameters:

content - the result content.

Returns:

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