uk.gov.gchq.gaffer.function.processor

Class Filter<R>

java.lang.Object

uk.gov.gchq.gaffer.function.processor.Processor<R,ConsumerFunctionContext<R,FilterFunction>>

uk.gov.gchq.gaffer.function.processor.Filter<R>

Type Parameters:

R - The type of reference used by tuples.

All Implemented Interfaces:

Cloneable

public class Filter<R>
extends Processor<R,ConsumerFunctionContext<R,FilterFunction>>

A Filter is a Processor that tests input Tuples against FilterFunctions. The functions are executed in order and the overall filter result for a given tuple is a logical AND of each filter function result. Tuples only pass the filter if all functions return a positive (true) result, and they fail as soon as any function returns a negative (false) result.

If performance is a concern then simple, faster filters or those with a higher probability of failure should be configured to run first.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Filter.Builder<R> Implementation of the Builder pattern for Filter.

Constructor Summary

Constructors

Constructor and Description
Filter() Default constructor - used for serialisation.
Filter(ConsumerFunctionContext<R,FilterFunction>... functions) Create a Filter that executes the given FunctionContexts.
Filter(List<ConsumerFunctionContext<R,FilterFunction>> functions) Create a Filter that executes the given FunctionContexts.

Method Summary

Modifier and Type	Method and Description
Filter<R>	clone() Create a deep copy of this Filter.
boolean	filter(Tuple<R> tuple) Test an input Tuple against FilterFunctions, performing a logical AND.

Methods inherited from class uk.gov.gchq.gaffer.function.processor.Processor

addFunction, addFunctions, equals, getFunctions, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Filter

public Filter()

Default constructor - used for serialisation.

Filter

public Filter(List<ConsumerFunctionContext<R,FilterFunction>> functions)

Create a Filter that executes the given FunctionContexts.

Parameters:

functions - FunctionContexts to execute.

Filter

@SafeVarargs
public Filter(ConsumerFunctionContext<R,FilterFunction>... functions)

Create a Filter that executes the given FunctionContexts.

Parameters:

functions - FunctionContexts to execute.

Method Detail

clone

public Filter<R> clone()

Create a deep copy of this Filter.

Specified by:

clone in class Processor<R,ConsumerFunctionContext<R,FilterFunction>>

Returns:

Deep copy of this Filter.

filter

public boolean filter(Tuple<R> tuple)

Test an input Tuple against FilterFunctions, performing a logical AND.

Parameters:

tuple - Tuple to be filtered.

Returns:

Logical AND of filter function results.