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

Class ToMap

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.output.ToMap

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends Element>>, InputOutput<Iterable<? extends Element>,Iterable<? extends Map<String,Object>>>, MultiInput<Element>, Output<Iterable<? extends Map<String,Object>>>, Operation

public class ToMap
extends Object
implements InputOutput<Iterable<? extends Element>,Iterable<? extends Map<String,Object>>>, MultiInput<Element>

A ToMap operation takes in an Iterable of items and uses a MapGenerator to convert each item into a Map of key-value pairs.

See Also:

ToMap.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToMap.Builder

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
ToMap()
ToMap(MapGenerator elementGenerator)

Method Summary

Modifier and Type	Method	Description
MapGenerator	getElementGenerator()
Iterable<? extends Element>	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Map<String,Object>>>	getOutputTypeReference()
void	setInput(Iterable<? extends Element> input)
void	setOptions(Map<String,String> options)
ToMap	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.io.MultiInput

createInputArray, setInput

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

ToMap

public ToMap()

ToMap

public ToMap(MapGenerator elementGenerator)

Method Detail

getElementGenerator

public MapGenerator getElementGenerator()

getInput

public Iterable<? extends Element> getInput()

Specified by:

getInput in interface Input<Iterable<? extends Element>>

Specified by:

getInput in interface MultiInput<Element>

setInput

public void setInput(Iterable<? extends Element> input)

Specified by:

setInput in interface Input<Iterable<? extends Element>>

Specified by:

setInput in interface MultiInput<Element>

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Map<String,Object>>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Iterable<? extends Map<String,Object>>>

shallowClone

public ToMap shallowClone()

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

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.