Package org.ametys.cms.search.systemprop

Class ViewBasedFullTextSystemProperty

java.lang.Object

org.ametys.runtime.model.AbstractModelItem

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

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

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

org.ametys.cms.search.systemprop.ViewBasedFullTextSystemProperty

All Implemented Interfaces:

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

public class ViewBasedFullTextSystemProperty
extends AbstractSystemProperty<String,Content>

SystemProperty which represents the full textual content of a Content based on attributes of a view. If the view does not exist for content, nothing will be indexed.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypesHelper	_contentTypesHelper	The contents types helper
protected String	_viewName	The view name to fill the property

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

_i18nUtils, _manager, _resolver, _userHelper, _userManager

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

_availableTypesExtensionPoint

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

_logger

Fields inherited from class org.ametys.runtime.model.AbstractModelItem

__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
ViewBasedFullTextSystemProperty()

Method Summary

Modifier and Type	Method	Description
protected String	_getTypeId()	Retrieves the id of the property's type
void	configure(Configuration configuration)
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.
Object	getValue(Content content)	Get the property's value
void	indexValue(org.apache.solr.common.SolrInputDocument document, Content content, IndexableDataContext context)	Index the property in a solr document.
boolean	isDisplayable()	Get if the property can be displayed (i.e.
boolean	isMultiple()	Test if the element is multiple.
boolean	isSortable()	Get if the property can be sorted on.
void	service(ServiceManager manager)

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

_getNameConfigurationAttribute, getSchemaDefinitions, getSortValue, parseBoolean, parseDate, parseDouble, parseLong, parseString, parseStringArray, parseUserArray

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

_parseI18nizableText, getType, isEditable, setAvailableTypeExtensionPoint, setPluginInfo

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

_getDefaultValues, _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, 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.runtime.model.ElementDefinition

getCriterionEnumerator, getCustomEnumerator, getCustomValidator, getDefaultValue, getEnumerator, getEnumeratorConfiguration, getParsedDefaultValues, getValidator, getValidatorConfiguration, isEditable, 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

getCriterionWidget, getCriterionWidgetParameters, getType, initializeAfterModelItemsInitialization, setAvailableTypeExtensionPoint, valueToJSON, valueToSAX

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

getColumnWidth, getConverter, getRenderer, isFacetable, isSearchable

Field Details

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The contents types helper

_viewName

protected String _viewName

The view name to fill the property

Constructor Details

ViewBasedFullTextSystemProperty

public ViewBasedFullTextSystemProperty()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractSystemProperty<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

indexValue

public void indexValue(org.apache.solr.common.SolrInputDocument document,
 Content content,
 IndexableDataContext context)

Description copied from interface: Property

Index the property in a solr document.

Specified by:

indexValue in interface Property<String,Content>

Overrides:

indexValue in class AbstractSystemProperty<String,Content>

Parameters:

document - the solr document to index into.

content - the ametysObject containing the property to index.

context - the context of the data to index. Can not be null.

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.

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.

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.

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

Get the property's value

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