Package org.ametys.cms.search.systemprop

Class FulltextSystemProperty

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.search.systemprop.AbstractSystemProperty<String,Content>

org.ametys.cms.search.systemprop.FulltextSystemProperty

All Implemented Interfaces:

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

public class FulltextSystemProperty
extends AbstractSystemProperty<String,Content>
implements CriterionDefinitionAwareElementDefinition<String>

SystemProperty which represents the full textual content of a Content.

Field Summary

Fields

Modifier and Type	Field	Description
protected CriterionDefinitionHelper	_criterionDefinitionHelper	The criterion definition helper
protected boolean	_stemmed	True for a stemmed full-text search, false otherwise.

Fields inherited from class org.ametys.cms.model.properties.AbstractProperty

_availableTypesExtensionPoint, _context, _manager

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

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
IndexableElementType	getDefaultCriterionType()	Get the type to use when rendering the element as a criterion
Query	getQuery(Object value, Query.Operator operator, String language, Map<String,Object> contextualParameters)	Get the Query associated to the given value.
protected String	getTypeId()	Retrieves the id of the property's type
Object	getValue(Content content)	Get the property's value
boolean	isDisplayable()	Get if the property can be displayed (i.e.
void	service(ServiceManager manager)

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

_getNameConfigurationAttribute, parseStringArray

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

_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, contextualize, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

Methods inherited from class org.ametys.runtime.model.DefaultElementDefinition

_defaultValueToJSON, _getDefaultValues, _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, getType

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.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, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

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

getColumnWidth, getConverter, getRenderer

Field Details

_criterionDefinitionHelper

protected CriterionDefinitionHelper _criterionDefinitionHelper

The criterion definition helper

_stemmed

protected boolean _stemmed

True for a stemmed full-text search, false otherwise.

Constructor Details

FulltextSystemProperty

public FulltextSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProperty<String,Content>

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractProperty<String,Content>

Throws:

ConfigurationException

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

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.

Specified by:

getQuery in interface CriterionDefinitionAwareElementDefinition<String>

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.

getValue

public Object getValue(Content content)

Description copied from interface: Property

Get the property's value

Specified by:

getValue in interface Property<String,Content>

Parameters:

content - the ametysObject containing the property

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

getDefaultCriterionType

public IndexableElementType getDefaultCriterionType()

Description copied from interface: CriterionDefinitionAwareElementDefinition

Get the type to use when rendering the element as a criterion

Specified by:

getDefaultCriterionType in interface CriterionDefinitionAwareElementDefinition<String>

Returns:

the type to use for a criterion