org.apache.nifi.processors.standard

Class ConvertCharacterSet

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ConvertCharacterSet

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @InputRequirement(value=INPUT_REQUIRED)
 @SupportsBatching
 @Tags(value={"text","convert","characterset","character set"})
 @CapabilityDescription(value="Converts a FlowFile\'s content from one character set to another")
public class ConvertCharacterSet
extends AbstractProcessor

This processor reads files in as text according to the specified character set and it outputs another text file according to the given character set. The character sets supported depend on the version of the JRE and is platform specific. In addition, the JVM can be expanded with additional character sets to support. More information on which character sets are supported can be found in the JDK documentation under the docs directory in the following path: ....\technotes\guides\intl\encoding.doc.html

The conversion process is very passive. For conversions that do not map perfectly the conversion will replace unmappable or unrecognized input using the '?' character.

The following properties are required:

• input.charset - The character set of the original file contents
• output.charset - The character set of the resulting file

The following properties are optional:

• N/A -

The following relationships are required:

• success - the id of the processor to transfer successfully converted files
• failure - the id of the processor to transfer unsuccessfully converted files

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	INPUT_CHARSET
static int	MAX_BUFFER_SIZE
static PropertyDescriptor	OUTPUT_CHARSET
private List<PropertyDescriptor>	properties
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
ConvertCharacterSet()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext 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

INPUT_CHARSET

public static final PropertyDescriptor INPUT_CHARSET

OUTPUT_CHARSET

public static final PropertyDescriptor OUTPUT_CHARSET

REL_SUCCESS

public static final Relationship REL_SUCCESS

MAX_BUFFER_SIZE

public static final int MAX_BUFFER_SIZE

See Also:

Constant Field Values

relationships

private Set<Relationship> relationships

properties

private List<PropertyDescriptor> properties

Constructor Detail

ConvertCharacterSet

public ConvertCharacterSet()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor