org.apache.nifi.processors.standard

Class CalculateRecordStats

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.CalculateRecordStats

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"record","stats","metrics"})
 @CapabilityDescription(value="A processor that can count the number of items in a record set, as well as provide counts based on user-defined criteria on subsets of the record set.")
 @InputRequirement(value=INPUT_REQUIRED)
 @DynamicProperty(name="Record Path property",
                 value="The Record Path value",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES,
                 description="A Record Path value, pointing to a field to be counted")
 @WritesAttribute(attribute="record.count",description="A count of the records in the record set in the FlowFile.") @WritesAttribute(attribute="recordStats.<User Defined Property Name>.count",description="A count of the records that contain a value for the user defined property.") @WritesAttribute(attribute="recordStats.<User Defined Property Name>.<value>.count",description="Each value discovered for the user defined property will have its own count attribute. Total number of top N value counts to be added is defined by the limit configuration.")
public class CalculateRecordStats
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private RecordPathCache	cache
(package private) static PropertyDescriptor	LIMIT
(package private) static List<PropertyDescriptor>	PROPERTIES
(package private) static String	RECORD_COUNT_ATTR
(package private) static PropertyDescriptor	RECORD_READER
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_SUCCESS
(package private) static Set	RELATIONSHIPS

Constructor Summary

Constructors

Constructor and Description
CalculateRecordStats()

Method Summary

Modifier and Type	Method and Description
protected Map	filterBySize(Map<String,Integer> values, Integer limit, List<String> baseKeys)
protected Map<String,RecordPath>	getRecordPaths(ProcessContext context, FlowFile flowFile)
Set<Relationship>	getRelationships()
protected Map<String,String>	getStats(FlowFile flowFile, Map<String,RecordPath> paths, ProcessContext context, ProcessSession session)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onEnabled(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, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, 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

RECORD_COUNT_ATTR

static final String RECORD_COUNT_ATTR

See Also:

Constant Field Values

RECORD_READER

static final PropertyDescriptor RECORD_READER

LIMIT

static final PropertyDescriptor LIMIT

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_FAILURE

static final Relationship REL_FAILURE

cache

private RecordPathCache cache

RELATIONSHIPS

static final Set RELATIONSHIPS

PROPERTIES

static final List<PropertyDescriptor> PROPERTIES

Constructor Detail

CalculateRecordStats

public CalculateRecordStats()

Method Detail

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onEnabled

@OnScheduled
public void onEnabled(ProcessContext context)

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getRecordPaths

protected Map<String,RecordPath> getRecordPaths(ProcessContext context,
                                                FlowFile flowFile)

getStats

protected Map<String,String> getStats(FlowFile flowFile,
                                      Map<String,RecordPath> paths,
                                      ProcessContext context,
                                      ProcessSession session)

filterBySize

protected Map filterBySize(Map<String,Integer> values,
                           Integer limit,
                           List<String> baseKeys)