org.apache.nifi.processors.standard

Class UpdateRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractRecordProcessor

org.apache.nifi.processors.standard.UpdateRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"update","record","generic","schema","json","csv","avro","log","logs","freeform","text"})
 @CapabilityDescription(value="Updates the contents of a FlowFile that contains Record-oriented data (i.e., data that can be read via a RecordReader and written by a RecordWriter). This Processor requires that at least one user-defined Property be added. The name of the Property should indicate a RecordPath that determines the field that should be updated. The value of the Property is either a replacement value (optionally making use of the Expression Language) or is itself a RecordPath that extracts a value from the Record. Whether the Property value is determined to be a RecordPath or a literal value depends on the configuration of the <Replacement Value Strategy> Property.")
 @WritesAttribute(attribute="record.index",description="This attribute provides the current row index and is only available inside the literal value expression.") @WritesAttribute(attribute="record.error.message",description="This attribute provides on failure the error message encountered by the Reader or Writer.")
 @DynamicProperty(name="A RecordPath.",
                 value="The value to use to replace fields in the record that match the RecordPath",
                 description="Allows users to specify values to use to replace fields in the record that match the RecordPath.",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES)
 @SeeAlso(value=ConvertRecord.class)
public class UpdateRecord
extends AbstractRecordProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private static String	FIELD_NAME
private static String	FIELD_TYPE
private static String	FIELD_VALUE
(package private) static AllowableValue	LITERAL_VALUES
private static String	RECORD_INDEX
(package private) static AllowableValue	RECORD_PATH_VALUES
private RecordPathCache	recordPathCache
private List<String>	recordPaths
(package private) static PropertyDescriptor	REPLACEMENT_VALUE_STRATEGY

Fields inherited from class org.apache.nifi.processors.standard.AbstractRecordProcessor

INCLUDE_ZERO_RECORD_FLOWFILES, RECORD_READER, RECORD_WRITER, REL_FAILURE, REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
UpdateRecord()

Method Summary

Modifier and Type	Method and Description
void	createRecordPaths(ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private Object	getReplacementObject(List<FieldValue> selectedFields)
private List<FieldValue>	getSelectedFields(RecordPath replacementRecordPath, FieldValue fieldValue, Record record)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private boolean	isReplacingRoot(List<FieldValue> destinationFields)
protected Record	process(Record record, FlowFile flowFile, ProcessContext context, long count)
private Record	processAbsolutePath(RecordPath replacementRecordPath, Stream<FieldValue> destinationFields, Record record)
private Record	processRelativePath(RecordPath replacementRecordPath, Stream<FieldValue> destinationFields, Record record)
private void	updateFieldValue(FieldValue fieldValue, Object replacement)
private Record	updateRecord(List<FieldValue> destinationFields, List<FieldValue> selectedFields, Record record)

Methods inherited from class org.apache.nifi.processors.standard.AbstractRecordProcessor

getRelationships, onTrigger

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

onTrigger

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

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

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

equals, getPropertyDescriptor, getPropertyDescriptors, 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

FIELD_NAME

private static final String FIELD_NAME

See Also:

Constant Field Values

FIELD_VALUE

private static final String FIELD_VALUE

See Also:

Constant Field Values

FIELD_TYPE

private static final String FIELD_TYPE

See Also:

Constant Field Values

RECORD_INDEX

private static final String RECORD_INDEX

See Also:

Constant Field Values

recordPathCache

private volatile RecordPathCache recordPathCache

recordPaths

private volatile List<String> recordPaths

LITERAL_VALUES

static final AllowableValue LITERAL_VALUES

RECORD_PATH_VALUES

static final AllowableValue RECORD_PATH_VALUES

REPLACEMENT_VALUE_STRATEGY

static final PropertyDescriptor REPLACEMENT_VALUE_STRATEGY

Constructor Detail

UpdateRecord

public UpdateRecord()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractRecordProcessor

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

createRecordPaths

@OnScheduled
public void createRecordPaths(ProcessContext context)

process

protected Record process(Record record,
                         FlowFile flowFile,
                         ProcessContext context,
                         long count)

Specified by:

process in class AbstractRecordProcessor

processAbsolutePath

private Record processAbsolutePath(RecordPath replacementRecordPath,
                                   Stream<FieldValue> destinationFields,
                                   Record record)

isReplacingRoot

private boolean isReplacingRoot(List<FieldValue> destinationFields)

processRelativePath

private Record processRelativePath(RecordPath replacementRecordPath,
                                   Stream<FieldValue> destinationFields,
                                   Record record)

updateRecord

private Record updateRecord(List<FieldValue> destinationFields,
                            List<FieldValue> selectedFields,
                            Record record)

updateFieldValue

private void updateFieldValue(FieldValue fieldValue,
                              Object replacement)

getSelectedFields

private List<FieldValue> getSelectedFields(RecordPath replacementRecordPath,
                                           FieldValue fieldValue,
                                           Record record)

getReplacementObject

private Object getReplacementObject(List<FieldValue> selectedFields)