uk.gov.gchq.gaffer.function.context

Class ConsumerFunctionContext<R,F extends ConsumerFunction>

java.lang.Object

uk.gov.gchq.gaffer.function.context.FunctionContext<F>

uk.gov.gchq.gaffer.function.context.ConsumerFunctionContext<R,F>

Type Parameters:

R - The type of reference used to select data from input tuples in this context.

F - The type of ConsumerFunction wrapped by the context.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConsumerProducerFunctionContext, PassThroughFunctionContext

public class ConsumerFunctionContext<R,F extends ConsumerFunction>
extends FunctionContext<F>

A ConsumerFunctionContext wraps a ConsumerFunction, and provides the references to select data from an input Tuple so they can be consumed by the function.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsumerFunctionContext.Builder<R,F extends ConsumerFunction> Implementation of the Builder pattern for ConsumerFunctionContext.

Constructor Summary

Constructors

Constructor and Description
ConsumerFunctionContext() Default constructor - used for serialisation.
ConsumerFunctionContext(F function, List<R> selection) Create a ConsumerFunctionContext that selects data from input Tuples using the specified selection references to pass arguments to the ConsumerFunction.

Method Summary

Modifier and Type	Method and Description
List<R>	getSelection()
Object[]	select(Tuple<R> tuple) Select data from an input Tuple.
void	setSelection(List<R> selection)

Methods inherited from class uk.gov.gchq.gaffer.function.context.FunctionContext

getFunction, setFunction

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsumerFunctionContext

public ConsumerFunctionContext()

Default constructor - used for serialisation.

ConsumerFunctionContext

public ConsumerFunctionContext(F function,
                               List<R> selection)

Create a ConsumerFunctionContext that selects data from input Tuples using the specified selection references to pass arguments to the ConsumerFunction.

Parameters:

function - ConsumerFunction to be wrapped by the context.

selection - References to select input data.

Method Detail

getSelection

public List<R> getSelection()

Returns:

References to select data from an input Tuple.

setSelection

public void setSelection(List<R> selection)

Parameters:

selection - References to select data from an input Tuple.

select

public Object[] select(Tuple<R> tuple)

Select data from an input Tuple.

Note: due to re-use of the container used to return input data, this method is not thread safe.

Parameters:

tuple - Input tuple to select from.

Returns:

Selected values.