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(value={"csv","parse","record","row","reader","delimited","comma","separated","values"})
 @CapabilityDescription(value="Parses CSV-formatted data, returning each row in the CSV file as a separate record. This reader assumes that the first line in the content is the column names and all subsequent lines are the values. See Controller Service\'s Usage for further documentation.")
public class CSVReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CSVReader()

Method Summary

Modifier and Type	Method and Description
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, ComponentLog logger)
protected AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String strategy, SchemaRegistry schemaRegistry, ConfigurationContext context)
protected SchemaAccessStrategy	getSchemaAccessStrategy(String allowableValue, SchemaRegistry schemaRegistry, ValidationContext context)
protected List<AllowableValue>	getSchemaAccessStrategyValues()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	storeCsvFormat(ConfigurationContext context)

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

customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAcessStrategyDescriptor, getSuppliedSchemaFields, storeSchemaAccessStrategy

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

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, 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.serialization.RecordReaderFactory

createRecordReader

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

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

headerDerivedAllowableValue

private final AllowableValue headerDerivedAllowableValue

APACHE_COMMONS_CSV

public static final AllowableValue APACHE_COMMONS_CSV

JACKSON_CSV

public static final AllowableValue JACKSON_CSV

CSV_PARSER

public static final PropertyDescriptor CSV_PARSER

csvParser

private volatile String csvParser

csvFormat

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

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

Constructor Detail

CSVReader

public CSVReader()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

storeCsvFormat

@OnEnabled
public void storeCsvFormat(ConfigurationContext context)

createRecordReader

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

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

SchemaNotFoundException

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String strategy,
                                                       SchemaRegistry schemaRegistry,
                                                       ConfigurationContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String allowableValue,
                                                       SchemaRegistry schemaRegistry,
                                                       ValidationContext 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