Package org.ametys.cms.data.type.indexing.impl

Class RichTextIndexableElementType

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.model.type.AbstractModelItemType

org.ametys.core.model.type.AbstractElementType<RichText>

org.ametys.cms.data.type.AbstractRichTextElementType

org.ametys.cms.data.type.indexing.impl.RichTextIndexableElementType

All Implemented Interfaces:

IndexableElementType<RichText>, IndexableModelItemType, ElementType<RichText>, ModelItemType, LogEnabled, PluginAware, Component, Serviceable

Direct Known Subclasses:

RichTextRepositoryElementType

public class RichTextIndexableElementType
extends AbstractRichTextElementType
implements IndexableElementType<RichText>

Class for rich-text type of elements that can be indexed

Field Summary

Fields inherited from class org.ametys.cms.data.type.AbstractRichTextElementType

_manager, _resolver, _richTextHandlerFactory, _richTextTransformer

Fields inherited from class org.ametys.core.model.type.AbstractElementType

_jsonUtils

Constructor Summary

Constructors

Constructor	Description
RichTextIndexableElementType()

Method Summary

Modifier and Type	Method	Description
String	getIndexingFieldSuffix(DataContext context)	Retrieves the indexing solr field suffix for this type
String	getSchemaType()	Get the solr schema type from the type.
<X> X	getSingleValueToIndex(RichText value)	Retrieves the formatted value to index
Optional<String>	getTextFieldSuffix(DataContext context)	Retrieves the text solr field suffix for this type
void	indexSingleValue(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootObjectDocument, String fieldName, RichText value, IndexableDataContext context)	Index the given single value in a solr document.
void	indexSingleValueForFullTextField(org.apache.solr.common.SolrInputDocument document, org.apache.solr.common.SolrInputDocument rootObjectDocument, RichText value, IndexableDataContext context)	Index the given single value in a full-text field of solr document.

Methods inherited from class org.ametys.cms.data.type.AbstractRichTextElementType

_compareMultipleValues, _compareSingleValues, _getLocalMediaObjectContentHandler, _singleValueFromXML, _singleValueToJSON, _singleValueToJSONForEdition, _singleValueToSAX, _valueToSAXForEdition, convertValue, fromJSONForClient, isSimple, service, toString

Methods inherited from class org.ametys.core.model.type.AbstractElementType

_getValueAttributes, _isMultiple, _isSingle, _isValueFromXMLMultiple, _useJSONForEdition, _valueToJSON, _valueToSAX, _valueToSAX, castValue, compareValues, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, valueFromXML, valueToJSONForClient, valueToJSONForEdition, valueToSAX, valueToSAXForEdition

Methods inherited from class org.ametys.core.model.type.AbstractModelItemType

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

Methods inherited from interface org.ametys.runtime.model.type.ElementType

castValue, compareValues, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueFromXML

Methods inherited from interface org.ametys.cms.data.type.indexing.IndexableElementType

getWildcardFieldSuffix, indexValue, isFacetable

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToJSONForClient, valueToJSONForClient, valueToJSONForEdition, valueToSAX, valueToSAX, valueToSAXForEdition

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Constructor Details

RichTextIndexableElementType

public RichTextIndexableElementType()

Method Details

indexSingleValue

public void indexSingleValue(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootObjectDocument,
 String fieldName,
 RichText value,
 IndexableDataContext context)

Description copied from interface: IndexableElementType

Index the given single value in a solr document.

Specified by:

indexSingleValue in interface IndexableElementType<RichText>

Parameters:

document - the solr document to index into.

rootObjectDocument - the solr document of the root object.

fieldName - the name of the indexing field

value - the single value to index

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

indexSingleValueForFullTextField

public void indexSingleValueForFullTextField(org.apache.solr.common.SolrInputDocument document,
 org.apache.solr.common.SolrInputDocument rootObjectDocument,
 RichText value,
 IndexableDataContext context)

Description copied from interface: IndexableElementType

Index the given single value in a full-text field of solr document. The solr full-text field name is given by the data context.

Specified by:

indexSingleValueForFullTextField in interface IndexableElementType<RichText>

Parameters:

document - the solr document to index into.

rootObjectDocument - the solr document of the root object.

value - the single value to index in fulltext field.

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

getSingleValueToIndex

public <X> X getSingleValueToIndex(RichText value)

Description copied from interface: IndexableElementType

Retrieves the formatted value to index

Specified by:

getSingleValueToIndex in interface IndexableElementType<RichText>

Type Parameters:

X - Type of the value to retrieve

Parameters:

value - the value to index

Returns:

the formatted value

getSchemaType

public String getSchemaType()

Description copied from interface: IndexableElementType

Get the solr schema type from the type.

Specified by:

getSchemaType in interface IndexableElementType<RichText>

Returns:

The solr schema type.

getIndexingFieldSuffix

public String getIndexingFieldSuffix(DataContext context)

Description copied from interface: IndexableElementType

Retrieves the indexing solr field suffix for this type

Specified by:

getIndexingFieldSuffix in interface IndexableElementType<RichText>

Parameters:

context - the indexable data context

Returns:

the indexing solr field suffix

getTextFieldSuffix

public Optional<String> getTextFieldSuffix(DataContext context)

Description copied from interface: IndexableElementType

Retrieves the text solr field suffix for this type

Specified by:

getTextFieldSuffix in interface IndexableElementType<RichText>

Parameters:

context - the indexable data context

Returns:

the text solr field suffix