org.apache.nifi.processors.standard

Class SplitJson

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AbstractJsonPathProcessor

org.apache.nifi.processors.standard.SplitJson

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"json","split","jsonpath"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Splits a JSON File into multiple, separate FlowFiles for an array element specified by a JsonPath expression. Each generated FlowFile is comprised of an element of the specified array and transferred to relationship \'split,\' with the original file transferred to the \'original\' relationship. If the specified JsonPath is not found or does not evaluate to an array element, the original file is routed to \'failure\' and no files are generated.")
 @WritesAttribute(attribute="fragment.identifier",description="All split FlowFiles produced from the same parent FlowFile will have the same randomly generated UUID added for this attribute") @WritesAttribute(attribute="fragment.index",description="A one-up number that indicates the ordering of the split FlowFiles that were created from a single parent FlowFile") @WritesAttribute(attribute="fragment.count",description="The number of split FlowFiles generated from the parent FlowFile") @WritesAttribute(attribute="segment.original.filename ",description="The filename of the parent FlowFile")
public class SplitJson
extends AbstractJsonPathProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ARRAY_JSON_PATH_EXPRESSION
static Relationship	REL_FAILURE
static Relationship	REL_ORIGINAL
static Relationship	REL_SPLIT

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

NULL_VALUE_DEFAULT_REPRESENTATION

Constructor Summary

Constructors

Constructor and Description
SplitJson()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<ValidationResult>	customValidate(ValidationContext validationContext) Allows subclasses to perform their own validation on the already set properties.
java.util.Set<Relationship>	getRelationships()
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
protected void	init(ProcessorInitializationContext context) Provides subclasses the ability to perform initialization logic
void	onPropertyModified(PropertyDescriptor descriptor, java.lang.String oldValue, java.lang.String newValue) Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor.
void	onScheduled(ProcessContext processContext)
void	onTrigger(ProcessContext processContext, ProcessSession processSession)

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, 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, validate

Field Detail

ARRAY_JSON_PATH_EXPRESSION

public static final PropertyDescriptor ARRAY_JSON_PATH_EXPRESSION

REL_ORIGINAL

public static final Relationship REL_ORIGINAL

REL_SPLIT

public static final Relationship REL_SPLIT

REL_FAILURE

public static final Relationship REL_FAILURE

Constructor Detail

SplitJson

public SplitJson()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Description copied from class: AbstractSessionFactoryProcessor

Provides subclasses the ability to perform initialization logic

Overrides:

init in class AbstractSessionFactoryProcessor

Parameters:

context - in which to perform initialization

getRelationships

public java.util.Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

Returns:

Set of all relationships this processor expects to transfer a flow file to. An empty set indicates this processor does not have any destination relationships. Guaranteed non null.

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                               java.lang.String oldValue,
                               java.lang.String newValue)

Description copied from class: AbstractConfigurableComponent

Hook method allowing subclasses to eagerly react to a configuration change for the given property descriptor. As an alternative to using this method a processor may simply get the latest value whenever it needs it and if necessary lazily evaluate it.

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

Parameters:

descriptor - of the modified property

oldValue - non-null property value (previous)

newValue - the new property value or if null indicates the property was removed

customValidate

protected java.util.Collection<ValidationResult> customValidate(ValidationContext validationContext)

Description copied from class: AbstractConfigurableComponent

Allows subclasses to perform their own validation on the already set properties. Since each property is validated as it is set this allows validation of groups of properties together. Default return is an empty set. This method will be called only when it has been determined that all property values are valid according to their corresponding PropertyDescriptor's validators.

Overrides:

customValidate in class AbstractConfigurableComponent

Parameters:

validationContext - provides a mechanism for obtaining externally managed values, such as property values and supplies convenience methods for operating on those values

Returns:

Collection of ValidationResult objects that will be added to any other validation findings - may be null

onScheduled

@OnScheduled
public void onScheduled(ProcessContext processContext)

onTrigger

public void onTrigger(ProcessContext processContext,
                      ProcessSession processSession)

Specified by:

onTrigger in class AbstractProcessor