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
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"Text","Regular Expression","Update","Change","Replace","Modify","Regex"})
 @CapabilityDescription(value="Updates the content of a FlowFile by evaluating a Regular Expression (regex) against it and replacing the section of the content that matches the Regular Expression with some alternate value.")
 @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.AppendReplace
private static class	ReplaceText.LiteralReplace
private static class	ReplaceText.PrependReplace
private static class	ReplaceText.RegexReplace
private static interface	ReplaceText.ReplacementStrategyExecutor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AllowableValue	ALWAYS_REPLACE
static String	alwaysReplace
(package private) static AllowableValue	APPEND
static String	appendValue
static PropertyDescriptor	CHARACTER_SET
private static String	DEFAULT_REGEX
private static String	DEFAULT_REPLACEMENT_VALUE
private static Pattern	DOUBLE_QUOTED_GROUP_REF_PATTERN
static String	ENTIRE_TEXT
static PropertyDescriptor	EVALUATION_MODE
static String	LINE_BY_LINE
private static Pattern	LITERAL_QUOTED_PATTERN
(package private) static AllowableValue	LITERAL_REPLACE
static String	literalReplaceValue
static PropertyDescriptor	MAX_BUFFER_SIZE
(package private) static AllowableValue	PREPEND
static String	prependValue
private List<PropertyDescriptor>	properties
private static Pattern	QUOTED_GROUP_REF_PATTERN
(package private) static AllowableValue	REGEX_REPLACE
static String	regexReplaceValue
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	REPLACEMENT_STRATEGY
static PropertyDescriptor	REPLACEMENT_VALUE
static PropertyDescriptor	SEARCH_VALUE
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	escapeExpressionDollarSigns(String replacement) If we have a '$' followed by anything other than a number, then escape it if it is not already escaped.
private static String	escapeForEvaluation(String contentString) Escapes a String containing literal('') EL values.
private static String	escapeLiteralBackReferences(String unescaped, int numCapturingGroups)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private static String	wrapLiterals(String possibleLiteral) Wraps '$1' with the literal function for EL evaluation.

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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

QUOTED_GROUP_REF_PATTERN

private static Pattern QUOTED_GROUP_REF_PATTERN

DOUBLE_QUOTED_GROUP_REF_PATTERN

private static Pattern DOUBLE_QUOTED_GROUP_REF_PATTERN

LITERAL_QUOTED_PATTERN

private static Pattern LITERAL_QUOTED_PATTERN

LINE_BY_LINE

public static final String LINE_BY_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

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

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

LITERAL_REPLACE

static final AllowableValue LITERAL_REPLACE

REGEX_REPLACE

static final AllowableValue REGEX_REPLACE

ALWAYS_REPLACE

static final AllowableValue ALWAYS_REPLACE

SEARCH_VALUE

public static final PropertyDescriptor SEARCH_VALUE

REPLACEMENT_VALUE

public static final PropertyDescriptor REPLACEMENT_VALUE

CHARACTER_SET

public static final PropertyDescriptor CHARACTER_SET

MAX_BUFFER_SIZE

public static final PropertyDescriptor MAX_BUFFER_SIZE

REPLACEMENT_STRATEGY

public static final PropertyDescriptor REPLACEMENT_STRATEGY

EVALUATION_MODE

public static final PropertyDescriptor 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

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

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)

wrapLiterals

private static String wrapLiterals(String possibleLiteral)

Wraps '$1' with the literal function for EL evaluation.

Parameters:

possibleLiteral - the String to evaluate.

Returns:

String with literals wrapped. If no literals or Expression Lanaguage present the passed string is returned.

escapeExpressionDollarSigns

private static String escapeExpressionDollarSigns(String replacement)

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

escapeForEvaluation

private static String escapeForEvaluation(String contentString)

Escapes a String containing literal('') EL values.

Parameters:

contentString - the String

Returns:

the escaped String. If no literal() is present, then the input String will be returned