org.apache.nifi.lookup

Class CSVRecordLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.CSVRecordLookupService

All Implemented Interfaces:

ConfigurableComponent, ControllerService, LookupService<Record>, RecordLookupService

@Tags(value={"lookup","cache","enrich","join","csv","reloadable","key","value","record"})
 @CapabilityDescription(value="A reloadable CSV file-based lookup service. When the lookup key is found in the CSV file, the columns are returned as a Record. All returned fields will be strings.")
public class CSVRecordLookupService
extends AbstractControllerService
implements RecordLookupService

Field Summary

Fields

Modifier and Type	Field and Description
private ConcurrentMap<String,Record>	cache
private String	charset
static PropertyDescriptor	CHARSET
static PropertyDescriptor	CSV_FILE
(package private) static PropertyDescriptor	CSV_FORMAT
private String	csvFile
private org.apache.commons.csv.CSVFormat	csvFormat
static PropertyDescriptor	IGNORE_DUPLICATES
private boolean	ignoreDuplicates
private static String	KEY
private ReentrantLock	lock
static PropertyDescriptor	LOOKUP_KEY_COLUMN
private String	lookupKeyColumn
private List<PropertyDescriptor>	properties
private static Set<String>	REQUIRED_KEYS
private SynchronousFileWatcher	watcher

Constructor Summary

Constructors

Constructor and Description
CSVRecordLookupService()

Method Summary

Modifier and Type	Method and Description
Set<String>	getRequiredKeys()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ControllerServiceInitializationContext context)
private void	loadCache()
Optional<Record>	lookup(Map<String,Object> coordinates)
void	onEnabled(ConfigurationContext context)

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

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

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

customValidate, 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.lookup.RecordLookupService

getValueType

Methods inherited from interface org.apache.nifi.lookup.LookupService

lookup

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

KEY

private static final String KEY

See Also:

Constant Field Values

REQUIRED_KEYS

private static final Set<String> REQUIRED_KEYS

CSV_FILE

public static final PropertyDescriptor CSV_FILE

CSV_FORMAT

static final PropertyDescriptor CSV_FORMAT

CHARSET

public static final PropertyDescriptor CHARSET

LOOKUP_KEY_COLUMN

public static final PropertyDescriptor LOOKUP_KEY_COLUMN

IGNORE_DUPLICATES

public static final PropertyDescriptor IGNORE_DUPLICATES

properties

private List<PropertyDescriptor> properties

cache

private volatile ConcurrentMap<String,Record> cache

csvFile

private volatile String csvFile

csvFormat

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

charset

private volatile String charset

lookupKeyColumn

private volatile String lookupKeyColumn

ignoreDuplicates

private volatile boolean ignoreDuplicates

watcher

private volatile SynchronousFileWatcher watcher

lock

private final ReentrantLock lock

Constructor Detail

CSVRecordLookupService

public CSVRecordLookupService()

Method Detail

loadCache

private void loadCache()
                throws IllegalStateException,
                       IOException

Throws:

IllegalStateException

IOException

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

init

protected void init(ControllerServiceInitializationContext context)
             throws InitializationException

Overrides:

init in class AbstractControllerService

Throws:

InitializationException

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)
                          throws InitializationException,
                                 IOException

Throws:

InitializationException

IOException

lookup

public Optional<Record> lookup(Map<String,Object> coordinates)
                        throws LookupFailureException

Specified by:

lookup in interface LookupService<Record>

Throws:

LookupFailureException

getRequiredKeys

public Set<String> getRequiredKeys()

Specified by:

getRequiredKeys in interface LookupService<Record>