Package org.ametys.web.search.systemprop

Class PagesSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

org.ametys.cms.model.properties.AbstractProperty<String,Content>

org.ametys.cms.model.properties.AbstractStaticProperty<String,Content>

org.ametys.cms.model.properties.AbstractIndexableStaticProperty<String,String,Content>

org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty<String,String,Content>

org.ametys.web.search.systemprop.PagesSystemProperty

All Implemented Interfaces:

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

public class PagesSystemProperty
extends AbstractIndexableSystemProperty<String,String,Content>

SystemProperty which represents the pages of a Content.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOLR_FIELD_NAME	Solr field name.
static final String	SYSTEM_PROPERTY_ID	System property identifier

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

Method Summary

Modifier and Type	Method	Description
String	getDefaultCriterionWidget()	Get the widget to use when rendering this item as a criterion, if no other widget is specified on criterion
Map<String,I18nizableText>	getDefaultCriterionWidgetParameters(Configuration configuration)	Get the widget parameters to use when rendering this item as a criterion If some other parameters are specified on criterion, all parameters are used If a parameter with the same name is specified on criterion, this parameter is used, not the default one
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
String	getSolrFacetFieldName()	Retrieves the name of the element's solr facet field
String	getSolrFieldName()	Retrieves the name of the element's solr field
String	getSolrSortFieldName()	Retrieves the name of the element's solr sort field
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the element's value
boolean	isDisplayable()	Get if the property can be displayed (i.e.
boolean	isMultiple()	Test if the element is multiple.

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

_getNameConfigurationAttribute, getSchemaDefinitions, getSortValue, indexValue, parseStringArray

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

getCriterionType, getCriterionTypeId, service

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

Methods inherited from interface org.ametys.runtime.model.ElementDefinition

getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, setCustomEnumerator, setCustomValidator, setDefaultValue, setEnumerator, setEnumeratorConfiguration, setMultiple, setParsedDefaultValues, setValidator, setValidatorConfiguration

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

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

Field Details

SYSTEM_PROPERTY_ID

public static final String SYSTEM_PROPERTY_ID

System property identifier

See Also:

• Constant Field Values

SOLR_FIELD_NAME

public static final String SOLR_FIELD_NAME

Solr field name.

See Also:

• Constant Field Values

Constructor Details

PagesSystemProperty

public PagesSystemProperty()

Method Details

isMultiple

public boolean isMultiple()

Description copied from interface: ElementDefinition

Test if the element is multiple.

Specified by:

isMultiple in interface ElementDefinition<String>

Overrides:

isMultiple in class DefaultElementDefinition<String>

Returns:

true if the metadata is multiple.

isDisplayable

public boolean isDisplayable()

Description copied from interface: SystemProperty

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

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: 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.

getDefaultCriterionWidget

public String getDefaultCriterionWidget()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget to use when rendering this item as a criterion, if no other widget is specified on criterion

Returns:

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

getDefaultCriterionWidgetParameters

public Map<String,I18nizableText> getDefaultCriterionWidgetParameters(Configuration configuration)

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the widget parameters to use when rendering this item as a criterion If some other parameters are specified on criterion, all parameters are used If a parameter with the same name is specified on criterion, this parameter is used, not the default one

Parameters:

configuration - The widget parameters configuration

Returns:

The default widget parameters to use, or an empty Map if no specific widget parameters are necessary by default.

getSolrFieldName

public String getSolrFieldName()

Description copied from interface: IndexationAwareElementDefinition

Retrieves the name of the element's solr field

Returns:

the name of the element's solr field

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<String,Content>

Overrides:

getSolrSortFieldName in class AbstractIndexableStaticProperty<String,String,Content>

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

getValue

public Object getValue(Content content)

Description copied from interface: IndexationAwareElementDefinition

Get the element's value

Parameters:

content - 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<String,Content>

Returns:

the id of the property's type