org.apache.nifi.processors.standard

Class SampleRecord

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.SampleRecord

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @Tags(value={"record","sample","reservoir","range","interval"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Samples the records of a FlowFile based on a specified sampling strategy (such as Reservoir Sampling). The resulting FlowFile may be of a fixed number of records (in the case of reservoir-based algorithms) or some subset of the total number of records (in the case of probabilistic sampling), or a deterministic number of records (in the case of interval sampling).")
 @SystemResourceConsideration(resource=MEMORY)
 @WritesAttribute(attribute="mime.type",description="The MIME type indicated by the record writer") @WritesAttribute(attribute="record.count",description="The number of records in the resulting flow file")
public class SampleRecord
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	SampleRecord.IntervalSamplingStrategy
(package private) static class	SampleRecord.ProbabilisticSamplingStrategy
(package private) static class	SampleRecord.RangeSamplingStrategy
(package private) static class	SampleRecord.ReservoirSamplingStrategy
(package private) static interface	SampleRecord.SamplingStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private static Pattern	INTERVAL_PATTERN
(package private) static AllowableValue	INTERVAL_SAMPLING
(package private) static String	INTERVAL_SAMPLING_KEY
(package private) static AllowableValue	PROBABILISTIC_SAMPLING
(package private) static String	PROBABILISTIC_SAMPLING_KEY
private static List<PropertyDescriptor>	properties
(package private) static PropertyDescriptor	RANDOM_SEED
private static Pattern	RANGE_PATTERN
(package private) static AllowableValue	RANGE_SAMPLING
(package private) static String	RANGE_SAMPLING_KEY
(package private) static PropertyDescriptor	RECORD_READER_FACTORY
(package private) static PropertyDescriptor	RECORD_WRITER_FACTORY
static Relationship	REL_FAILURE
static Relationship	REL_ORIGINAL
static Relationship	REL_SUCCESS
private static Set<Relationship>	relationships
(package private) static AllowableValue	RESERVOIR_SAMPLING
(package private) static String	RESERVOIR_SAMPLING_KEY
(package private) static PropertyDescriptor	RESERVOIR_SIZE
(package private) static PropertyDescriptor	SAMPLING_INTERVAL
(package private) static PropertyDescriptor	SAMPLING_PROBABILITY
(package private) static PropertyDescriptor	SAMPLING_RANGE
(package private) static PropertyDescriptor	SAMPLING_STRATEGY

Constructor Summary

Constructors

Constructor and Description
SampleRecord()

Method Summary

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

INTERVAL_SAMPLING_KEY

static final String INTERVAL_SAMPLING_KEY

See Also:

Constant Field Values

RANGE_SAMPLING_KEY

static final String RANGE_SAMPLING_KEY

See Also:

Constant Field Values

PROBABILISTIC_SAMPLING_KEY

static final String PROBABILISTIC_SAMPLING_KEY

See Also:

Constant Field Values

RESERVOIR_SAMPLING_KEY

static final String RESERVOIR_SAMPLING_KEY

See Also:

Constant Field Values

INTERVAL_SAMPLING

static final AllowableValue INTERVAL_SAMPLING

RANGE_SAMPLING

static final AllowableValue RANGE_SAMPLING

PROBABILISTIC_SAMPLING

static final AllowableValue PROBABILISTIC_SAMPLING

RESERVOIR_SAMPLING

static final AllowableValue RESERVOIR_SAMPLING

RANGE_PATTERN

private static final Pattern RANGE_PATTERN

INTERVAL_PATTERN

private static final Pattern INTERVAL_PATTERN

RECORD_READER_FACTORY

static final PropertyDescriptor RECORD_READER_FACTORY

RECORD_WRITER_FACTORY

static final PropertyDescriptor RECORD_WRITER_FACTORY

SAMPLING_STRATEGY

static final PropertyDescriptor SAMPLING_STRATEGY

SAMPLING_INTERVAL

static final PropertyDescriptor SAMPLING_INTERVAL

SAMPLING_RANGE

static final PropertyDescriptor SAMPLING_RANGE

SAMPLING_PROBABILITY

static final PropertyDescriptor SAMPLING_PROBABILITY

RESERVOIR_SIZE

static final PropertyDescriptor RESERVOIR_SIZE

RANDOM_SEED

static final PropertyDescriptor RANDOM_SEED

REL_ORIGINAL

public static final Relationship REL_ORIGINAL

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private static final List<PropertyDescriptor> properties

relationships

private static final Set<Relationship> relationships

Constructor Detail

SampleRecord

public SampleRecord()

Method Detail

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)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException