org.apache.nifi.processors.standard

Class AttributesToCSV

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.AttributesToCSV

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"csv","attributes","flowfile"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Generates a CSV representation of the input FlowFile Attributes. The resulting CSV can be written to either a newly generated attribute named \'CSVAttributes\' or written to the FlowFile as content.  If the attribute value contains a comma, newline or double quote, then the attribute value will be escaped with double quotes.  Any double quote characters in the attribute value are escaped with another double quote.")
 @WritesAttribute(attribute="CSVSchema",description="CSV representation of the Schema") @WritesAttribute(attribute="CSVData",description="CSV representation of Attributes")
public class AttributesToCSV
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ATTRIBUTES_LIST
static PropertyDescriptor	ATTRIBUTES_REGEX
private Set<String>	coreAttributes
private static String	DATA_ATTRIBUTE_NAME
static PropertyDescriptor	DESTINATION
private boolean	destinationContent
static PropertyDescriptor	INCLUDE_CORE_ATTRIBUTES
static PropertyDescriptor	INCLUDE_SCHEMA
private Boolean	includeCoreAttributes
private Boolean	includeSchema
static PropertyDescriptor	NULL_VALUE_FOR_EMPTY_STRING
private boolean	nullValForEmptyString
private static String	OUTPUT_MIME_TYPE
(package private) static AllowableValue	OUTPUT_NEW_ATTRIBUTE
(package private) static AllowableValue	OUTPUT_OVERWRITE_CONTENT
private static String	OUTPUT_SEPARATOR
private Pattern	pattern
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private static String	SCHEMA_ATTRIBUTE_NAME
private static String	SPLIT_REGEX

Constructor Summary

Constructors

Constructor and Description
AttributesToCSV()

Method Summary

Modifier and Type	Method and Description
private LinkedHashSet<String>	attributeListStringToSet(String attributeList)
private Map<String,String>	buildAttributesMapForFlowFile(FlowFile ff, Set<String> attributes, Pattern attPattern)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

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

DATA_ATTRIBUTE_NAME

private static final String DATA_ATTRIBUTE_NAME

See Also:

Constant Field Values

SCHEMA_ATTRIBUTE_NAME

private static final String SCHEMA_ATTRIBUTE_NAME

See Also:

Constant Field Values

OUTPUT_SEPARATOR

private static final String OUTPUT_SEPARATOR

See Also:

Constant Field Values

OUTPUT_MIME_TYPE

private static final String OUTPUT_MIME_TYPE

See Also:

Constant Field Values

SPLIT_REGEX

private static final String SPLIT_REGEX

See Also:

Constant Field Values

OUTPUT_OVERWRITE_CONTENT

static final AllowableValue OUTPUT_OVERWRITE_CONTENT

OUTPUT_NEW_ATTRIBUTE

static final AllowableValue OUTPUT_NEW_ATTRIBUTE

ATTRIBUTES_LIST

public static final PropertyDescriptor ATTRIBUTES_LIST

ATTRIBUTES_REGEX

public static final PropertyDescriptor ATTRIBUTES_REGEX

DESTINATION

public static final PropertyDescriptor DESTINATION

INCLUDE_CORE_ATTRIBUTES

public static final PropertyDescriptor INCLUDE_CORE_ATTRIBUTES

NULL_VALUE_FOR_EMPTY_STRING

public static final PropertyDescriptor NULL_VALUE_FOR_EMPTY_STRING

INCLUDE_SCHEMA

public static final PropertyDescriptor INCLUDE_SCHEMA

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

includeCoreAttributes

private volatile Boolean includeCoreAttributes

coreAttributes

private volatile Set<String> coreAttributes

destinationContent

private volatile boolean destinationContent

nullValForEmptyString

private volatile boolean nullValForEmptyString

pattern

private volatile Pattern pattern

includeSchema

private volatile Boolean includeSchema

Constructor Detail

AttributesToCSV

public AttributesToCSV()

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

buildAttributesMapForFlowFile

private Map<String,String> buildAttributesMapForFlowFile(FlowFile ff,
                                                         Set<String> attributes,
                                                         Pattern attPattern)

attributeListStringToSet

private LinkedHashSet<String> attributeListStringToSet(String attributeList)

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException