Package org.ametys.cms.search.systemprop
Class ViewBasedFullTextSystemProperty
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.cms.search.systemprop.ViewBasedFullTextSystemProperty
- 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 ViewBasedFullTextSystemProperty
extends AbstractIndexableSystemProperty<String,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
FieldsModifier and TypeFieldDescriptionprotected ContentTypesHelper
The contents types helperprotected String
The view name to fill the propertyFields 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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
configure
(Configuration configuration) getQuery
(Object value, Query.Operator operator, String language, Map<String, Object> contextualParameters) Get theQuery
associated to the given value.Get the schema definitions brought by this element.Retrieves the name of the element's solr facet fieldRetrieves the name of the element's solr fieldRetrieves the name of the element's solr sort fieldprotected String
Retrieves the id of the property's typeGet the element's valuevoid
indexValue
(org.apache.solr.common.SolrInputDocument document, Content content, CMSDataContext context) Index the element in a solr document.boolean
Get if the property can be displayed (i.e.void
service
(ServiceManager manager) Methods inherited from class org.ametys.cms.search.systemprop.AbstractIndexableSystemProperty
_getNameConfigurationAttribute, getSortValue, parseStringArray
Methods inherited from class org.ametys.cms.model.properties.AbstractIndexableStaticProperty
getCriterionType, getCriterionTypeId
Methods inherited from class org.ametys.cms.model.properties.AbstractStaticProperty
_parseAndSetEnumerator, _parseDescription, _parseLabel, _parseName, 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, 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
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.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
-
_contentTypesHelper
The contents types helper -
_viewName
The view name to fill the property
-
-
Constructor Details
-
ViewBasedFullTextSystemProperty
public ViewBasedFullTextSystemProperty()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractIndexableStaticProperty<String,
String, Content> - Throws:
ServiceException
-
configure
- Specified by:
configure
in interfaceConfigurable
- Overrides:
configure
in classAbstractStaticProperty<String,
Content> - Throws:
ConfigurationException
-
indexValue
public void indexValue(org.apache.solr.common.SolrInputDocument document, Content content, CMSDataContext context) Description copied from interface:IndexationAwareElementDefinition
Index the element in a solr document.- Specified by:
indexValue
in interfaceIndexationAwareElementDefinition<String,
Content> - Overrides:
indexValue
in classAbstractIndexableSystemProperty<String,
String, Content> - Parameters:
document
- the solr document to index into.content
- the ametysObject containing the element to index.context
- the context of the data to index. Can not be null.
-
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 theQuery
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.
-
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
Description copied from interface:IndexationAwareElementDefinition
Retrieves the name of the element's solr sort field- Specified by:
getSolrSortFieldName
in interfaceIndexationAwareElementDefinition<String,
Content> - Overrides:
getSolrSortFieldName
in classAbstractIndexableStaticProperty<String,
String, Content> - Returns:
- the name of the element's solr sort field
-
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
-
getSchemaDefinitions
Description copied from interface:IndexationAwareSystemProperty
Get the schema definitions brought by this element.- Specified by:
getSchemaDefinitions
in interfaceIndexationAwareSystemProperty<String,
Content> - Overrides:
getSchemaDefinitions
in classAbstractIndexableSystemProperty<String,
String, Content> - Returns:
- The schema definitions used by this element.
-
getValue
Description copied from interface:IndexationAwareElementDefinition
Get the element's value- Parameters:
content
- the ametysObject containing the element- Returns:
- the values to index.
-
getTypeId
Description copied from class:AbstractProperty
Retrieves the id of the property's type- Specified by:
getTypeId
in classAbstractProperty<String,
Content> - Returns:
- the id of the property's type
-