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

Class GenerateElements<OBJ>

java.lang.Object

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

Type Parameters:

OBJ - the type of objects in the input iterable.

All Implemented Interfaces:

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

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

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

See Also:

GenerateElements.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateElements.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
GenerateElements()
GenerateElements(Function<Iterable<? extends OBJ>,Iterable<? extends Element>> elementGenerator)	Constructs a GenerateElements operation with a ElementGenerator to convert objects into Elements.

Method Summary

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

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

GenerateElements

public GenerateElements()

GenerateElements

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

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

Parameters:

elementGenerator - an ElementGenerator to convert objects into Elements

Method Detail

getElementGenerator

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

Returns:

an ElementGenerator to convert objects into Elements

getInput

public Iterable<? extends OBJ> getInput()

Specified by:

getInput in interface Input<OBJ>

Specified by:

getInput in interface MultiInput<OBJ>

setInput

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

Specified by:

setInput in interface Input<OBJ>

Specified by:

setInput in interface MultiInput<OBJ>

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<OBJ>

shallowClone

public GenerateElements<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.