Package uk.gov.gchq.gaffer.operation.impl

Class Map<I,O>

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.Map<I,O>

Type Parameters:

I - the type of the input object

O - the type of the output object

All Implemented Interfaces:

Closeable, AutoCloseable, Input<I>, InputOutput<I,O>, Output<O>, Operation

public class Map<I,O>
extends Object
implements InputOutput<I,O>

A Map is a Gaffer Operation which maps an input I to an output O by applying a supplied Function or List of Functions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Map.Builder<I>
static class	Map.OutputBuilder<I,O>

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Constructor Summary

Constructors

Constructor	Description
Map()
Map(Function function)
Map(List<Function> functions)

Method Summary

Modifier and Type	Method	Description
List<Function>	getFunctions()
I	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<O>	getOutputTypeReference()
void	setFunction(Function function)
void	setFunctions(List<Function> funcs)
void	setInput(I input)
void	setOptions(Map<String,String> options)
Map<I,O>	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Input

close

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operation

_getNullOrOptions, addOption, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Methods inherited from interface uk.gov.gchq.gaffer.operation.io.Output

castToOutputType, getOutputClass, getOutputType

Constructor Detail

Map

public Map()

Map

public Map(Function function)

Map

public Map(List<Function> functions)

Method Detail

getInput

public I getInput()

Specified by:

getInput in interface Input<I>

setInput

public void setInput(I input)

Specified by:

setInput in interface Input<I>

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<O> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<I>

shallowClone

public Map<I,O> shallowClone()
                            throws org.apache.commons.lang3.exception.CloneFailedException

Description copied from interface: Operation

Operation implementations should ensure a ShallowClone method is implemented. Performs a shallow clone. Creates a new instance and copies the fields across. It does not clone the fields. If the operation contains nested operations, these must also be cloned.

Specified by:

shallowClone in interface Operation

Returns:

shallow clone

Throws:

org.apache.commons.lang3.exception.CloneFailedException - if a Clone error occurs

getOptions

public Map<String,String> getOptions()

Specified by:

getOptions in interface Operation

Returns:

the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

setOptions

public void setOptions(Map<String,String> options)

Specified by:

setOptions in interface Operation

Parameters:

options - the operation options. This may contain store specific options such as authorisation strings or and other properties required for the operation to be executed. Note these options will probably not be interpreted in the same way by every store implementation.

getFunctions

public List<Function> getFunctions()

setFunctions

public void setFunctions(List<Function> funcs)

setFunction

public void setFunction(Function function)