org.apache.nifi.processors.standard

Class ReplaceText

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ReplaceText

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching(defaultDuration=TWENTY_FIVE_MILLIS)
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"Text","Regular Expression","Update","Change","Replace","Modify","Regex"})
 @CapabilityDescription(value="Updates the content of a FlowFile by searching for some textual value in the FlowFile content (via Regular Expression/regex, or literal value) and replacing the section of the content that matches with some alternate value. It can also be used to append or prepend text to the contents of a FlowFile.")
 @SystemResourceConsideration(resource=MEMORY)
public class ReplaceText
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ReplaceText.AlwaysReplace
private static class	ReplaceText.LiteralReplace
private static class	ReplaceText.PrependReplace
private static class	ReplaceText.RegexReplace
private static interface	ReplaceText.ReplaceLine
private static interface	ReplaceText.ReplacementStrategyExecutor
private static class	ReplaceText.StreamReplaceCallback
private static class	ReplaceText.SubstituteVariablesReplace
private static class	ReplaceText.SurroundReplace

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL
(package private) static AllowableValue	ALWAYS_REPLACE
static String	alwaysReplace
(package private) static AllowableValue	APPEND
(package private) static PropertyDescriptor	APPEND_TEXT
static String	appendValue
static PropertyDescriptor	CHARACTER_SET
private static String	DEFAULT_REGEX
private static String	DEFAULT_REPLACEMENT_VALUE
static String	ENTIRE_TEXT
static PropertyDescriptor	EVALUATION_MODE
static String	EXCEPT_FIRST_LINE
static String	EXCEPT_LAST_LINE
static String	FIRST_LINE
static String	LAST_LINE
static String	LINE_BY_LINE
static PropertyDescriptor	LINE_BY_LINE_EVALUATION_MODE
(package private) static AllowableValue	LITERAL_REPLACE
static String	literalReplaceValue
static PropertyDescriptor	MAX_BUFFER_SIZE
(package private) static AllowableValue	PREPEND
(package private) static PropertyDescriptor	PREPEND_TEXT
static String	prependValue
private List<PropertyDescriptor>	properties
(package private) static AllowableValue	REGEX_REPLACE
static String	regexReplaceValue
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private static Pattern	REPLACEMENT_NORMALIZATION_PATTERN
static PropertyDescriptor	REPLACEMENT_STRATEGY
static PropertyDescriptor	REPLACEMENT_VALUE
private ReplaceText.ReplacementStrategyExecutor	replacementStrategyExecutor
static PropertyDescriptor	SEARCH_VALUE
(package private) static AllowableValue	SUBSTITUTE_VARIABLES
static String	SUBSTITUTE_VARIABLES_VALUE
(package private) static AllowableValue	SURROUND
static String	surroundValue
private static Pattern	unescapedBackReferencePattern

Constructor Summary

Constructors

Constructor and Description
ReplaceText()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private static String	escapeLiteralBackReferences(String unescaped, int numCapturingGroups)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
private static String	normalizeReplacementString(String replacement) If we have a '$' followed by anything other than a number, then escape it.
void	onTrigger(ProcessContext context, ProcessSession session)
void	setup(ProcessContext context)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

REPLACEMENT_NORMALIZATION_PATTERN

private static Pattern REPLACEMENT_NORMALIZATION_PATTERN

LINE_BY_LINE

public static final String LINE_BY_LINE

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

FIRST_LINE

public static final String FIRST_LINE

See Also:

Constant Field Values

EXCEPT_FIRST_LINE

public static final String EXCEPT_FIRST_LINE

See Also:

Constant Field Values

LAST_LINE

public static final String LAST_LINE

See Also:

Constant Field Values

EXCEPT_LAST_LINE

public static final String EXCEPT_LAST_LINE

See Also:

Constant Field Values

ENTIRE_TEXT

public static final String ENTIRE_TEXT

See Also:

Constant Field Values

prependValue

public static final String prependValue

See Also:

Constant Field Values

appendValue

public static final String appendValue

See Also:

Constant Field Values

surroundValue

public static final String surroundValue

See Also:

Constant Field Values

regexReplaceValue

public static final String regexReplaceValue

See Also:

Constant Field Values

literalReplaceValue

public static final String literalReplaceValue

See Also:

Constant Field Values

alwaysReplace

public static final String alwaysReplace

See Also:

Constant Field Values

SUBSTITUTE_VARIABLES_VALUE

public static final String SUBSTITUTE_VARIABLES_VALUE

See Also:

Constant Field Values

unescapedBackReferencePattern

private static final Pattern unescapedBackReferencePattern

DEFAULT_REGEX

private static final String DEFAULT_REGEX

See Also:

Constant Field Values

DEFAULT_REPLACEMENT_VALUE

private static final String DEFAULT_REPLACEMENT_VALUE

See Also:

Constant Field Values

PREPEND

static final AllowableValue PREPEND

APPEND

static final AllowableValue APPEND

SURROUND

static final AllowableValue SURROUND

LITERAL_REPLACE

static final AllowableValue LITERAL_REPLACE

REGEX_REPLACE

static final AllowableValue REGEX_REPLACE

ALWAYS_REPLACE

static final AllowableValue ALWAYS_REPLACE

SUBSTITUTE_VARIABLES

static final AllowableValue SUBSTITUTE_VARIABLES

REPLACEMENT_STRATEGY

public static final PropertyDescriptor REPLACEMENT_STRATEGY

SEARCH_VALUE

public static final PropertyDescriptor SEARCH_VALUE

REPLACEMENT_VALUE

public static final PropertyDescriptor REPLACEMENT_VALUE

PREPEND_TEXT

static final PropertyDescriptor PREPEND_TEXT

APPEND_TEXT

static final PropertyDescriptor APPEND_TEXT

CHARACTER_SET

public static final PropertyDescriptor CHARACTER_SET

MAX_BUFFER_SIZE

public static final PropertyDescriptor MAX_BUFFER_SIZE

EVALUATION_MODE

public static final PropertyDescriptor EVALUATION_MODE

LINE_BY_LINE_EVALUATION_MODE

public static final PropertyDescriptor LINE_BY_LINE_EVALUATION_MODE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

replacementStrategyExecutor

private ReplaceText.ReplacementStrategyExecutor replacementStrategyExecutor

Constructor Detail

ReplaceText

public ReplaceText()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

setup

@OnScheduled
public void setup(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

escapeLiteralBackReferences

private static String escapeLiteralBackReferences(String unescaped,
                                                  int numCapturingGroups)

normalizeReplacementString

private static String normalizeReplacementString(String replacement)

If we have a '$' followed by anything other than a number, then escape it. E.g., '$d' becomes '\$d' so that it can be used as a literal in a regex.