Package org.apache.nifi.json

Class JsonTreeReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.json.JsonTreeReader

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordReaderFactory

Direct Known Subclasses:

YamlTreeReader

@Tags({"json","tree","record","reader","parser"})
@CapabilityDescription("Parses JSON into individual Record objects. While the reader expects each record to be well-formed JSON, the content of a FlowFile may consist of many records, each as a well-formed JSON array or JSON object with optional whitespace between them, such as the common \'JSON-per-line\' format. If an array is encountered, each element in that array will be treated as a separate record. If the schema that is configured contains a field that is not present in the JSON, a null value will be used. If the JSON contains a field that is not present in the schema, that field will be skipped. See the Usage of the Controller Service for more information and examples.")
@SeeAlso(JsonPathReader.class)
public class JsonTreeReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowComments
protected String	dateFormat
static final PropertyDescriptor	SCHEMA_APPLICATION_STRATEGY
protected SchemaApplicationStrategy	schemaApplicationStrategy
static final PropertyDescriptor	STARTING_FIELD_NAME
static final PropertyDescriptor	STARTING_FIELD_STRATEGY
protected String	startingFieldName
protected StartingFieldStrategy	startingFieldStrategy
private com.fasterxml.jackson.core.StreamReadConstraints	streamReadConstraints
protected String	timeFormat
protected String	timestampFormat

Fields inherited from class org.apache.nifi.serialization.SchemaRegistryService

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
JsonTreeReader()

Method Summary

Modifier and Type	Method	Description
protected com.fasterxml.jackson.core.StreamReadConstraints	buildStreamReadConstraints(ConfigurationContext context)	Build Stream Read Constraints based on available properties
protected RecordSourceFactory<com.fasterxml.jackson.databind.JsonNode>	createJsonRecordSourceFactory()
protected JsonTreeRowRecordReader	createJsonTreeRowRecordReader(InputStream in, ComponentLog logger, RecordSchema schema)
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, ComponentLog logger)
protected AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String schemaAccessStrategy, SchemaRegistry schemaRegistry, PropertyContext context)
protected List<AllowableValue>	getSchemaAccessStrategyValues()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected boolean	isAllowCommentsEnabled(ConfigurationContext context)	Determine whether to allow comments when parsing based on available properties
void	storePropertyValues(ConfigurationContext context)

Methods inherited from class org.apache.nifi.serialization.SchemaRegistryService

buildStrategyProperty, customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAccessStrategyDescriptor, getSuppliedSchemaFields, migrateProperties, storeSchemaAccessStrategy

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

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

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, 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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful, migrateProperties

Methods inherited from interface org.apache.nifi.serialization.RecordReaderFactory

createRecordReader

Field Details

dateFormat

protected volatile String dateFormat

timeFormat

protected volatile String timeFormat

timestampFormat

protected volatile String timestampFormat

startingFieldName

protected volatile String startingFieldName

startingFieldStrategy

protected volatile StartingFieldStrategy startingFieldStrategy

schemaApplicationStrategy

protected volatile SchemaApplicationStrategy schemaApplicationStrategy

allowComments

private volatile boolean allowComments

streamReadConstraints

private volatile com.fasterxml.jackson.core.StreamReadConstraints streamReadConstraints

STARTING_FIELD_STRATEGY

public static final PropertyDescriptor STARTING_FIELD_STRATEGY

STARTING_FIELD_NAME

public static final PropertyDescriptor STARTING_FIELD_NAME

SCHEMA_APPLICATION_STRATEGY

public static final PropertyDescriptor SCHEMA_APPLICATION_STRATEGY

Constructor Details

JsonTreeReader

public JsonTreeReader()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

storePropertyValues

@OnEnabled
public void storePropertyValues(ConfigurationContext context)

buildStreamReadConstraints

protected com.fasterxml.jackson.core.StreamReadConstraints buildStreamReadConstraints(ConfigurationContext context)

Build Stream Read Constraints based on available properties

Parameters:

context - Configuration Context with property values

Returns:

Stream Read Constraints

isAllowCommentsEnabled

protected boolean isAllowCommentsEnabled(ConfigurationContext context)

Determine whether to allow comments when parsing based on available properties

Parameters:

context - Configuration Context with property values

Returns:

Allow comments status

getSchemaAccessStrategyValues

protected List<AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String schemaAccessStrategy,
 SchemaRegistry schemaRegistry,
 PropertyContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

createJsonRecordSourceFactory

protected RecordSourceFactory<com.fasterxml.jackson.databind.JsonNode> createJsonRecordSourceFactory()

getDefaultSchemaAccessStrategy

protected AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService

createRecordReader

public RecordReader createRecordReader(Map<String,String> variables,
 InputStream in,
 long inputLength,
 ComponentLog logger)
                                throws IOException,
MalformedRecordException,
SchemaNotFoundException

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

MalformedRecordException

SchemaNotFoundException

createJsonTreeRowRecordReader

protected JsonTreeRowRecordReader createJsonTreeRowRecordReader(InputStream in,
 ComponentLog logger,
 RecordSchema schema)
                                                         throws IOException,
MalformedRecordException

Throws:

IOException

MalformedRecordException