Package org.apache.solr.update.processor

Class RegexReplaceProcessorFactory

java.lang.Object

org.apache.solr.update.processor.UpdateRequestProcessorFactory

org.apache.solr.update.processor.FieldMutatingUpdateProcessorFactory

org.apache.solr.update.processor.RegexReplaceProcessorFactory

All Implemented Interfaces:

NamedListInitializedPlugin, SolrCoreAware

public final class RegexReplaceProcessorFactory
extends FieldMutatingUpdateProcessorFactory

An updated processor that applies a configured regex to any CharSequence values found in the selected fields, and replaces any matches with the configured replacement string.

By default this processor applies itself to no fields.

By default, literalReplacement is set to true, in which case, the replacement string will be treated literally by quoting via Matcher.quoteReplacement(String). And hence, '\' and '$' signs will not be processed. When literalReplacement is set to false, one can perform backreference operations and capture group substitutions.

For example, with the configuration listed below, any sequence of multiple whitespace characters found in values for field named title or content will be replaced by a single space character.

 <processor class="solr.RegexReplaceProcessorFactory">
   <str name="fieldName">content</str>
   <str name="fieldName">title</str>
   <str name="pattern">\s+</str>
   <str name="replacement"> </str>
   <bool name="literalReplacement">true</bool>
 </processor>

Since:

4.0.0

See Also:

Pattern

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.update.processor.FieldMutatingUpdateProcessorFactory

FieldMutatingUpdateProcessorFactory.SelectorParams

Nested classes/interfaces inherited from class org.apache.solr.update.processor.UpdateRequestProcessorFactory

UpdateRequestProcessorFactory.RunAlways

Constructor Summary

Constructors

Constructor	Description
RegexReplaceProcessorFactory()

Method Summary

Modifier and Type	Method	Description
protected FieldMutatingUpdateProcessor.FieldNameSelector	getDefaultSelector(SolrCore core)	Defines the default selection behavior when the user has not configured any specific criteria for selecting fields.
UpdateRequestProcessor	getInstance(SolrQueryRequest request, SolrQueryResponse response, UpdateRequestProcessor next)
void	init(org.apache.solr.common.util.NamedList<?> args)	Handles common initialization related to source fields for constructing the FieldNameSelector to be used.

Methods inherited from class org.apache.solr.update.processor.FieldMutatingUpdateProcessorFactory

getSelector, inform, parseSelectorExclusionParams, parseSelectorParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegexReplaceProcessorFactory

public RegexReplaceProcessorFactory()

Method Detail

init

public void init(org.apache.solr.common.util.NamedList<?> args)

Description copied from class: FieldMutatingUpdateProcessorFactory

Handles common initialization related to source fields for constructing the FieldNameSelector to be used.

Will error if any unexpected init args are found, so subclasses should remove any subclass-specific init args before calling this method.

Specified by:

init in interface NamedListInitializedPlugin

Overrides:

init in class FieldMutatingUpdateProcessorFactory

Parameters:

args - non-null list of initialization parameters (may be empty)

getDefaultSelector

protected FieldMutatingUpdateProcessor.FieldNameSelector getDefaultSelector(SolrCore core)

Description copied from class: FieldMutatingUpdateProcessorFactory

Defines the default selection behavior when the user has not configured any specific criteria for selecting fields. The Default implementation matches all fields, and should be overridden by subclasses as needed.

Overrides:

getDefaultSelector in class FieldMutatingUpdateProcessorFactory

See Also:

FieldMutatingUpdateProcessor.SELECT_NO_FIELDS

getInstance

public UpdateRequestProcessor getInstance(SolrQueryRequest request,
                                          SolrQueryResponse response,
                                          UpdateRequestProcessor next)

Specified by:

getInstance in class UpdateRequestProcessorFactory