uk.gov.gchq.gaffer.function

Class FilterFunction

java.lang.Object

uk.gov.gchq.gaffer.function.ConsumerFunction

uk.gov.gchq.gaffer.function.FilterFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

MultiFilterFunction, SimpleFilterFunction

public abstract class FilterFunction
extends ConsumerFunction

A FilterFunction is a ConsumerFunction that tests input records against some criteria, returning a boolean result to indicate whether the input passes or fails the test. The result of any filter can be reversed by setting the not option.

For example:
FilterFunction isA = new IsA(Integer.class);
boolean result = isA.isValid({1}); //result = true
result = isA.isValid({"a"}); //result = false
isA.setNot(true); // flip results result = isA.isValid({1}); //result = false
result = isA.isValid({"a"}) // result = true

Constructor Summary

Constructors

Constructor and Description
FilterFunction()

Method Summary

Modifier and Type	Method and Description
abstract boolean	isValid(Object[] input) Executes this FilterFunction with an input record.
abstract FilterFunction	statelessClone() Create a deep copy of this Function, including any configuration values.

Methods inherited from class uk.gov.gchq.gaffer.function.ConsumerFunction

equals, getInputClasses, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FilterFunction

public FilterFunction()

Method Detail

isValid

public abstract boolean isValid(Object[] input)

Executes this FilterFunction with an input record. Input records should match the types reported by getInputClasses().

Parameters:

input - Input record to test.

Returns:

true if input record passes the test.

statelessClone

public abstract FilterFunction statelessClone()

Description copied from interface: Function

Create a deep copy of this Function, including any configuration values. Stateful functions should have their state initialised.

Specified by:

statelessClone in interface Function

Specified by:

statelessClone in class ConsumerFunction

Returns:

Deep copy of this Function.