org.apache.nifi.components

Interface PropertyValue

public interface PropertyValue

A PropertyValue provides a mechanism whereby the currently configured value of a processor property can be obtained in different forms.

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	asBoolean()
ControllerService	asControllerService()
<T extends ControllerService> T	asControllerService(Class<T> serviceType)
Double	asDataSize(DataUnit dataUnit)
Double	asDouble()
Float	asFloat()
Integer	asInteger()
Long	asLong()
Long	asTimePeriod(TimeUnit timeUnit)
PropertyValue	evaluateAttributeExpressions() Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	evaluateAttributeExpressions(AttributeValueDecorator decorator) Replaces values in the Property Value using the NiFi Expression Language.
PropertyValue	evaluateAttributeExpressions(FlowFile flowFile) Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	evaluateAttributeExpressions(FlowFile flowFile, AttributeValueDecorator decorator) Replaces values in the Property Value using the NiFi Expression Language.
PropertyValue	evaluateAttributeExpressions(FlowFile flowFile, Map<String,String> additionalAttributes) Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	evaluateAttributeExpressions(FlowFile flowFile, Map<String,String> additionalAttributes, AttributeValueDecorator decorator) Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	evaluateAttributeExpressions(Map<String,String> attributes) Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.
PropertyValue	evaluateAttributeExpressions(Map<String,String> attributes, AttributeValueDecorator decorator) Replaces values in the Property Value using the NiFi Expression Language.
String	getValue()
boolean	isSet()

Method Detail

getValue

String getValue()

Returns:

the raw property value as a string

asInteger

Integer asInteger()

Returns:

an integer representation of the property value, or null if not set

Throws:

NumberFormatException - if not able to parse

asLong

Long asLong()

Returns:

a Long representation of the property value, or null if not set

Throws:

NumberFormatException - if not able to parse

asBoolean

Boolean asBoolean()

Returns:

a Boolean representation of the property value, or null if not set

asFloat

Float asFloat()

Returns:

a Float representation of the property value, or null if not set

Throws:

NumberFormatException - if not able to parse

asDouble

Double asDouble()

Returns:

a Double representation of the property value, of null if not set

Throws:

NumberFormatException - if not able to parse

asTimePeriod

Long asTimePeriod(TimeUnit timeUnit)

Parameters:

timeUnit - specifies the TimeUnit to convert the time duration into

Returns:

a Long value representing the value of the configured time period in terms of the specified TimeUnit; if the property is not set, returns null

asDataSize

Double asDataSize(DataUnit dataUnit)

Parameters:

dataUnit - specifies the DataUnit to convert the data size into

Returns:

a Long value representing the value of the configured data size in terms of the specified DataUnit; if hte property is not set, returns null

asControllerService

ControllerService asControllerService()

Returns:

the ControllerService whose identifier is the raw value of this, or null if either the value is not set or the value does not identify a ControllerService

asControllerService

<T extends ControllerService> T asControllerService(Class<T> serviceType)
                                                throws IllegalArgumentException

Type Parameters:

T - the generic type of the controller service

Parameters:

serviceType - the class of the Controller Service

Returns:

the ControllerService whose identifier is the raw value of the this, or null if either the value is not set or the value does not identify a ControllerService. The object returned by this method is explicitly cast to type specified, if the type specified is valid. Otherwise, throws an IllegalArgumentException

Throws:

IllegalArgumentException - if the value of this points to a ControllerService but that service is not of type serviceType or if serviceType references a class that is not an interface

isSet

boolean isSet()

Returns:

true if the user has configured a value, or if the PropertyDescriptor for the associated property has a default value, false otherwise

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions()
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.

Returns:

a PropertyValue with the new value is returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(Map<String,String> attributes)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

attributes - a Map of attributes that the Expression can reference, in addition to JVM System Properties and Environmental Properties.

Returns:

a PropertyValue with the new value

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(Map<String,String> attributes,
                                         AttributeValueDecorator decorator)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language. The supplied decorator is then given a chance to decorate the value, and a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

attributes - a Map of attributes that the Expression can reference, in addition to JVM System Properties and Environmental Properties.

decorator - the decorator to use in order to update the values returned by the Expression Language

Returns:

a PropertyValue with the new value

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(FlowFile flowFile)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

flowFile - to evaluate attributes of

Returns:

a PropertyValue with the new value is returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(FlowFile flowFile,
                                         Map<String,String> additionalAttributes)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

flowFile - to evaluate attributes of

additionalAttributes - a Map of additional attributes that the Expression can reference. If entries in this Map conflict with entries in the FlowFile's attributes, the entries in this Map are given a higher priority.

Returns:

a PropertyValue with the new value is returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(FlowFile flowFile,
                                         Map<String,String> additionalAttributes,
                                         AttributeValueDecorator decorator)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language; a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

flowFile - to evaluate attributes of

additionalAttributes - a Map of additional attributes that the Expression can reference. If entries in this Map conflict with entries in the FlowFile's attributes, the entries in this Map are given a higher priority.

decorator - the decorator to use in order to update the values returned by the Expression Language

Returns:

a PropertyValue with the new value is returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(AttributeValueDecorator decorator)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language. The supplied decorator is then given a chance to decorate the value, and a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

decorator - The supplied decorator is then given a chance to decorate the value

Returns:

a PropertyValue with the new value is then returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown

evaluateAttributeExpressions

PropertyValue evaluateAttributeExpressions(FlowFile flowFile,
                                         AttributeValueDecorator decorator)
                                           throws ProcessException

Replaces values in the Property Value using the NiFi Expression Language. The supplied decorator is then given a chance to decorate the value, and a PropertyValue with the new value is then returned, supporting call chaining.

Parameters:

flowFile - to evaluate expressions against

decorator - The supplied decorator is then given a chance to decorate the value

Returns:

a PropertyValue with the new value is then returned, supporting call chaining

Throws:

ProcessException - if the Expression cannot be compiled or evaluating the Expression against the given attributes causes an Exception to be thrown