org.apache.nifi.record.path

Interface FieldValue

All Known Implementing Classes:

ArrayIndexFieldValue, MapEntryFieldValue, StandardFieldValue

public interface FieldValue

Method Summary

Modifier and Type	Method and Description
RecordField	getField()
Optional<FieldValue>	getParent()
Optional<Record>	getParentRecord()
Object	getValue()
void	updateValue(Object newValue) Updates the record to which the field belongs, so that it now has the given value.
void	updateValue(Object newValue, DataType dataType) Updates the record to which the field belongs, so that it now has the given value.

Method Detail

getValue

Object getValue()

Returns:

the value of the field

getField

RecordField getField()

Returns:

the field that the associated value belongs to

getParent

Optional<FieldValue> getParent()

Returns:

the FieldValue that applies to the parent of this field, or an empty Optional if the field represents the 'root' record.

getParentRecord

Optional<Record> getParentRecord()

Returns:

the Record that the field belongs to, or an empty Optional if the field represents the 'root' record.

updateValue

void updateValue(Object newValue)

Updates the record to which the field belongs, so that it now has the given value.

Parameters:

newValue - the new value to set on the record field

updateValue

void updateValue(Object newValue,
                 DataType dataType)

Updates the record to which the field belongs, so that it now has the given value. If the FieldValue points to a Field that does not currently exist in the Record, the field will be created in the Record Schema as an 'inactive field', which can then be incoporated into the Record's schema by calling Record.incorporateInactiveFields().

Parameters:

newValue - the value to set for the field

dataType - the data type to use if the Record's schema does not already include this field