uk.gov.gchq.gaffer.function.context

Class PassThroughFunctionContext<R,F extends ConsumerProducerFunction>

java.lang.Object

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

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

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

Type Parameters:

R - The type of reference used to select from and project into tuples in this context.

F - The type of ConsumerProducerFunction wrapped by the context.

All Implemented Interfaces:

Serializable

public class PassThroughFunctionContext<R,F extends ConsumerProducerFunction>
extends ConsumerFunctionContext<R,F>

A PassThroughFunctionContext extends a ConsumerFunctionContext to wrap a ConsumerProducerFunction where the consumed and produced data have the same structure (they have the same references and types). This is effectively equivalent to a ConsumerProducerFunctionContext where the selection and projection references must be identical - PassThroughFunctionContext enforces that constraint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PassThroughFunctionContext() Default constructor - used for serialisation.
PassThroughFunctionContext(F function, List<R> selection) Create a PassThroughFunctionContext that wraps a ConsumerProducerFunction, using the specified references for selection and projection.

Method Summary

Modifier and Type	Method and Description
void	project(Tuple<R> tuple, Object[] values) Project data into an output Tuple.

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

getSelection, select, setSelection

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

PassThroughFunctionContext

public PassThroughFunctionContext()

Default constructor - used for serialisation.

PassThroughFunctionContext

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

Create a PassThroughFunctionContext that wraps a ConsumerProducerFunction, using the specified references for selection and projection.

Parameters:

function - ConsumerProducerFunction to be wrapped by the context.

selection - References to select and project data.

Method Detail

project

public void project(Tuple<R> tuple,
                    Object[] values)

Project data into an output Tuple.

Parameters:

tuple - Output tuple to project into.

values - Results to project.