Package org.apache.nifi.lookup

Class CSVRecordLookupService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.lookup.AbstractCSVLookupService

org.apache.nifi.lookup.CSVRecordLookupService

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, LookupService<Record>, RecordLookupService

@Tags({"lookup","cache","enrich","join","csv","reloadable","key","value","record"})
@CapabilityDescription("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. The first line of the csv file is considered as header.")
@Restricted(restrictions=@Restriction(requiredPermission=READ_FILESYSTEM,explanation="Provides operator the ability to read from any file that NiFi has access to."))
public class CSVRecordLookupService
extends AbstractCSVLookupService
implements RecordLookupService

Field Summary

Fields

Modifier and Type	Field	Description
private ConcurrentMap<String,Record>	cache
(package private) static final org.apache.nifi.components.PropertyDescriptor	CSV_FORMAT
private static final Set<String>	REQUIRED_KEYS

Fields inherited from class org.apache.nifi.lookup.AbstractCSVLookupService

charset, CHARSET, CSV_FILE, csvFile, csvFormat, DEFAULT, IGNORE_DUPLICATES, ignoreDuplicates, KEY, lock, LOOKUP_KEY_COLUMN, lookupKeyColumn, properties, RFC4180, watcher

Constructor Summary

Constructors

Constructor	Description
CSVRecordLookupService()

Method Summary

Modifier and Type	Method	Description
Set<String>	getRequiredKeys()
(package private) boolean	isCaching()
protected void	loadCache()
Optional<Record>	lookup(Map<String,Object> coordinates)
void	onDisabled()
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Methods inherited from class org.apache.nifi.lookup.AbstractCSVLookupService

getSupportedPropertyDescriptors, init

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.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.lookup.LookupService

lookup

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

getValueType

Field Details

REQUIRED_KEYS

private static final Set<String> REQUIRED_KEYS

CSV_FORMAT

static final org.apache.nifi.components.PropertyDescriptor CSV_FORMAT

cache

private volatile ConcurrentMap<String,Record> cache

Constructor Details

CSVRecordLookupService

public CSVRecordLookupService()

Method Details

loadCache

protected void loadCache()
                  throws IllegalStateException,
IOException

Specified by:

loadCache in class AbstractCSVLookupService

Throws:

IllegalStateException

IOException

onEnabled

@OnEnabled
public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)
               throws InitializationException,
IOException

Overrides:

onEnabled in class AbstractCSVLookupService

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>

onDisabled

@OnDisabled
public void onDisabled()

isCaching

boolean isCaching()