uk.gov.gchq.gaffer.function.context

Class ProducerFunctionContext<R,F extends ProducerFunction>

java.lang.Object

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

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

Type Parameters:

R - The type of reference used to project data into output tuples in this context.

F - The type of ProducerFunction wrapped by the context.

All Implemented Interfaces:

Serializable

public class ProducerFunctionContext<R,F extends ProducerFunction>
extends FunctionContext<F>

A ProducerFunctionContext wraps a ProducerFunction, and provides the references to project the results produced by a function into an output Tuple.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ProducerFunctionContext() Default constructor - used for serialisation.
ProducerFunctionContext(F function, List<R> projection) Create a ProducerFunctionContext that projects the results of the ProducerFunction into output Tuples using the specified projection references.

Method Summary

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

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

ProducerFunctionContext

public ProducerFunctionContext()

Default constructor - used for serialisation.

ProducerFunctionContext

public ProducerFunctionContext(F function,
                               List<R> projection)

Create a ProducerFunctionContext that projects the results of the ProducerFunction into output Tuples using the specified projection references.

Parameters:

function - ProducerFunction to be wrapped by the context.

projection - References to project output data.

Method Detail

getProjection

public List<R> getProjection()

Returns:

References to project data into an output Tuple.

setProjection

public void setProjection(List<R> projection)

Parameters:

projection - References to project data into an output Tuple.

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.