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

Class GenerateObjects<OBJ>

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.generate.GenerateObjects<OBJ>

Type Parameters:

OBJ - the type of objects in the output iterable.

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends Element>>, InputOutput<Iterable<? extends Element>,Iterable<? extends OBJ>>, MultiInput<Element>, Output<Iterable<? extends OBJ>>, Operation

public class GenerateObjects<OBJ>
extends Object
implements InputOutput<Iterable<? extends Element>,Iterable<? extends OBJ>>, MultiInput<Element>

An GenerateObjects operation generates an Iterable of objects from an Iterable of Elements.

See Also:

GenerateObjects.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateObjects.Builder<OBJ>

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
GenerateObjects()
GenerateObjects(Function<Iterable<? extends Element>,Iterable<? extends OBJ>> elementGenerator)	Constructs a GenerateObjects operation with an ElementGenerator to convert Elements into objects.

Method Summary

Modifier and Type	Method	Description
Object[]	createInputArray()
Function<Iterable<? extends Element>,Iterable<? extends OBJ>>	getElementGenerator()
Iterable<? extends Element>	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends OBJ>>	getOutputTypeReference()
void	setInput(Iterable<? extends Element> input)
void	setOptions(Map<String,String> options)
GenerateObjects<OBJ>	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

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

GenerateObjects

public GenerateObjects()

GenerateObjects

public GenerateObjects(Function<Iterable<? extends Element>,Iterable<? extends OBJ>> elementGenerator)

Constructs a GenerateObjects operation with an ElementGenerator to convert Elements into objects. This constructor takes in no input Elements and could by used in a operation chain where the elements are provided by the previous operation.

Parameters:

elementGenerator - an ElementGenerator to convert Elements into objects

Method Detail

getElementGenerator

public Function<Iterable<? extends Element>,Iterable<? extends OBJ>> getElementGenerator()

Returns:

an ElementGenerator to convert Elements into objects

getInput

public Iterable<? extends Element> getInput()

Specified by:

getInput in interface Input<OBJ>

Specified by:

getInput in interface MultiInput<OBJ>

setInput

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

Specified by:

setInput in interface Input<OBJ>

Specified by:

setInput in interface MultiInput<OBJ>

createInputArray

public Object[] createInputArray()

Specified by:

createInputArray in interface MultiInput<OBJ>

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends OBJ>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<OBJ>

shallowClone

public GenerateObjects<OBJ> 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.