Package org.apache.nifi.csv

Class CSVReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.csv.CSVReader

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordReaderFactory

@Tags({"csv","parse","record","row","reader","delimited","comma","separated","values"})
@CapabilityDescription("Parses CSV-formatted data, returning each row in the CSV file as a separate record. This reader allows for inferring a schema based on the first line of the CSV, if a \'header line\' is present, or providing an explicit schema for interpreting the values. See Controller Service\'s Usage for further documentation.")
public class CSVReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final AllowableValue	APACHE_COMMONS_CSV
private String	charSet
private ConfigurationContext	context
static final PropertyDescriptor	CSV_PARSER
private org.apache.commons.csv.CSVFormat	csvFormat
private String	csvParser
private String	dateFormat
static final AllowableValue	FAST_CSV
private boolean	firstLineIsHeader
private static final AllowableValue	HEADER_DERIVED
private boolean	ignoreHeader
static final AllowableValue	JACKSON_CSV
private String	timeFormat
private String	timestampFormat
static final PropertyDescriptor	TRIM_DOUBLE_QUOTE

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

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
CSVReader()

Method Summary

Modifier and Type	Method	Description
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, ComponentLog logger)
protected AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String allowableValue, SchemaRegistry schemaRegistry, PropertyContext context)
protected List<AllowableValue>	getSchemaAccessStrategyValues()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	storeStaticProperties(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

HEADER_DERIVED

private static final AllowableValue HEADER_DERIVED

APACHE_COMMONS_CSV

public static final AllowableValue APACHE_COMMONS_CSV

JACKSON_CSV

public static final AllowableValue JACKSON_CSV

FAST_CSV

public static final AllowableValue FAST_CSV

CSV_PARSER

public static final PropertyDescriptor CSV_PARSER

TRIM_DOUBLE_QUOTE

public static final PropertyDescriptor TRIM_DOUBLE_QUOTE

context

private volatile ConfigurationContext context

csvParser

private volatile String csvParser

dateFormat

private volatile String dateFormat

timeFormat

private volatile String timeFormat

timestampFormat

private volatile String timestampFormat

firstLineIsHeader

private volatile boolean firstLineIsHeader

ignoreHeader

private volatile boolean ignoreHeader

charSet

private volatile String charSet

csvFormat

private volatile org.apache.commons.csv.CSVFormat csvFormat

Constructor Details

CSVReader

public CSVReader()

Method Details

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

storeStaticProperties

@OnEnabled
public void storeStaticProperties(ConfigurationContext context)

createRecordReader

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

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

SchemaNotFoundException

getSchemaAccessStrategy

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

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

getSchemaAccessStrategyValues

protected List<AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getDefaultSchemaAccessStrategy

protected AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService