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

Class Join<I>

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.join.Join<I>

Type Parameters:

I - Iterable input type.

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends I>>, InputOutput<Iterable<? extends I>,Iterable<? extends uk.gov.gchq.koryphe.tuple.MapTuple>>, MultiInput<I>, Output<Iterable<? extends uk.gov.gchq.koryphe.tuple.MapTuple>>, Operation, Operations<Operation>

public class Join<I>
extends Object
implements InputOutput<Iterable<? extends I>,Iterable<? extends uk.gov.gchq.koryphe.tuple.MapTuple>>, MultiInput<I>, Operations<Operation>

A Join Operation is used to join two Iterables together, specifying a match and merge method.

Note: The input iterables are limited by default to 100,000 as these are read into memory as a Collection. This limit can be changed by adding specifying a collectionLimit in the Operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Join.Builder<I>

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
Join()

Method Summary

Modifier and Type	Method	Description
Object[]	createInputArray()
Integer	getCollectionLimit()
Iterable<? extends I>	getInput()
JoinType	getJoinType()
MatchKey	getMatchKey()
Match	getMatchMethod()
Operation	getOperation()
Collection<Operation>	getOperations()	Should return a Collection of all operations contained within the Operations implementation.
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends uk.gov.gchq.koryphe.tuple.MapTuple>>	getOutputTypeReference()
Boolean	isFlatten()
void	setCollectionLimit(Integer collectionLimit)
void	setFlatten(Boolean flatten)
void	setInput(Iterable<? extends I> leftSideInput)
void	setJoinType(JoinType joinType)
void	setMatchKey(MatchKey matchKey)
void	setMatchMethod(Match matchMethod)
void	setOperation(Operation rightSideOperation)
void	setOptions(Map<String,String> options)
Join<I>	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.Operations

flatten, getOperationsClass, updateOperations

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

Join

public Join()

Method Detail

getInput

public Iterable<? extends I> getInput()

Specified by:

getInput in interface Input<I>

Specified by:

getInput in interface MultiInput<I>

setInput

public void setInput(Iterable<? extends I> leftSideInput)

Specified by:

setInput in interface Input<I>

Specified by:

setInput in interface MultiInput<I>

getOperation

public Operation getOperation()

setOperation

public void setOperation(Operation rightSideOperation)

getMatchMethod

public Match getMatchMethod()

setMatchMethod

public void setMatchMethod(Match matchMethod)

getMatchKey

public MatchKey getMatchKey()

setMatchKey

public void setMatchKey(MatchKey matchKey)

setFlatten

public void setFlatten(Boolean flatten)

isFlatten

public Boolean isFlatten()

getJoinType

public JoinType getJoinType()

setJoinType

public void setJoinType(JoinType joinType)

getCollectionLimit

public Integer getCollectionLimit()

setCollectionLimit

public void setCollectionLimit(Integer collectionLimit)

shallowClone

public Join<I> 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.

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends uk.gov.gchq.koryphe.tuple.MapTuple>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<I>

getOperations

public Collection<Operation> getOperations()

Description copied from interface: Operations

Should return a Collection of all operations contained within the Operations implementation. The collection of operations may be modified by Gaffer.

Specified by:

getOperations in interface Operations<I>

Returns:

A Collection of Operations.

createInputArray

public Object[] createInputArray()

Specified by:

createInputArray in interface MultiInput<I>