org.apache.nifi.processors.standard

Class FlattenJson

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.FlattenJson

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @SideEffectFree
 @Tags(value={"json","flatten","unflatten"})
 @CapabilityDescription(value="Provides the user with the ability to take a nested JSON document and flatten it into a simple key/value pair document. The keys are combined at each level with a user-defined separator that defaults to \'.\'. This Processor also allows to unflatten back the flattened json. It supports four kinds of flatten mode such as normal, keep-arrays, dot notation for MongoDB query and keep-primitive-arrays. Default flatten mode is \'keep-arrays\'.")
public class FlattenJson
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CHARACTER_SET
static PropertyDescriptor	FLATTEN_MODE
static AllowableValue	FLATTEN_MODE_DOT_NOTATION
static AllowableValue	FLATTEN_MODE_KEEP_ARRAYS
static AllowableValue	FLATTEN_MODE_KEEP_PRIMITIVE_ARRAYS
static AllowableValue	FLATTEN_MODE_NORMAL
static PropertyDescriptor	IGNORE_RESERVED_CHARACTERS
static PropertyDescriptor	PRETTY_PRINT
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	RETURN_TYPE
static String	RETURN_TYPE_FLATTEN
static String	RETURN_TYPE_UNFLATTEN
static PropertyDescriptor	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FlattenJson()

Method Summary

Modifier and Type	Method and Description
private com.github.wnameless.json.flattener.FlattenMode	getFlattenMode(String mode)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	setIgnoreReservedCharacters(boolean ignoreReservedCharacters, com.github.wnameless.json.flattener.JsonFlattener jsonFlattener)

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

customValidate, 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.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

RETURN_TYPE_FLATTEN

public static final String RETURN_TYPE_FLATTEN

See Also:

Constant Field Values

RETURN_TYPE_UNFLATTEN

public static final String RETURN_TYPE_UNFLATTEN

See Also:

Constant Field Values

FLATTEN_MODE_NORMAL

public static final AllowableValue FLATTEN_MODE_NORMAL

FLATTEN_MODE_KEEP_ARRAYS

public static final AllowableValue FLATTEN_MODE_KEEP_ARRAYS

FLATTEN_MODE_DOT_NOTATION

public static final AllowableValue FLATTEN_MODE_DOT_NOTATION

FLATTEN_MODE_KEEP_PRIMITIVE_ARRAYS

public static final AllowableValue FLATTEN_MODE_KEEP_PRIMITIVE_ARRAYS

SEPARATOR

public static final PropertyDescriptor SEPARATOR

FLATTEN_MODE

public static final PropertyDescriptor FLATTEN_MODE

IGNORE_RESERVED_CHARACTERS

public static final PropertyDescriptor IGNORE_RESERVED_CHARACTERS

RETURN_TYPE

public static final PropertyDescriptor RETURN_TYPE

CHARACTER_SET

public static final PropertyDescriptor CHARACTER_SET

PRETTY_PRINT

public static final PropertyDescriptor PRETTY_PRINT

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

FlattenJson

public FlattenJson()

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

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getFlattenMode

private com.github.wnameless.json.flattener.FlattenMode getFlattenMode(String mode)

setIgnoreReservedCharacters

private void setIgnoreReservedCharacters(boolean ignoreReservedCharacters,
                                         com.github.wnameless.json.flattener.JsonFlattener jsonFlattener)