Package uk.gov.gchq.gaffer.federatedstore.operation

Class FederatedOperation<INPUT,OUTPUT>

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.operation.FederatedOperation<INPUT,OUTPUT>

Type Parameters:

INPUT - Input type of the payload operation

OUTPUT - Output type of the merge function

All Implemented Interfaces:

Closeable, AutoCloseable, IFederatedOperation, IFederationOperation, Input<INPUT>, InputOutput<INPUT,OUTPUT>, Output<OUTPUT>, Operation, Operations<Operation>

public class FederatedOperation<INPUT,OUTPUT>
extends Object
implements IFederationOperation, IFederatedOperation, InputOutput<INPUT,OUTPUT>, Operations<Operation>

This operation federates a payload operation across a given set of graphs and merges the results with a given function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FederatedOperation.Builder
static class	FederatedOperation.BuilderParent<INPUT,OUTPUT>

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

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

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

Method Summary

Modifier and Type	Method	Description
FederatedOperation<INPUT,OUTPUT>	deepClone()
boolean	equals(Object o)
List<String>	getGraphIds()
INPUT	getInput()	FederatedOperation does not have input.
BiFunction	getMergeFunction()
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	getOutputTypeReference()
Class<? extends Operation>	getPayloadClass()
Operation	getPayloadOperation()	Returns a shallow clone of the payload operation.
Operation	getUnClonedPayload()	Use responsibly internals including options may incorrectly get modified.
FederatedOperation<INPUT,OUTPUT>	graphIds(List<String> graphIds)
FederatedOperation<INPUT,OUTPUT>	graphIdsCSV(String graphIds)
int	hashCode()
boolean	hasPayloadOperation()
boolean	isSkipFailedFederatedExecution()
boolean	isUserRequestingAdminUsage()
FederatedOperation<INPUT,OUTPUT>	mergeFunction(BiFunction mergeFunction)
FederatedOperation<INPUT,OUTPUT>	options(Map<String,String> options)
boolean	payloadInstanceOf(Class<?> c)
FederatedOperation<INPUT,OUTPUT>	payloadOperation(Operation op)
void	setInput(INPUT input)	FederatedOperation does not have input, but will pass through to payload.
void	setOptions(Map<String,String> options)
FederatedOperation<INPUT,OUTPUT>	setUserRequestingAdminUsage(boolean adminRequest)
FederatedOperation<INPUT,OUTPUT>	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.
FederatedOperation<INPUT,OUTPUT>	skipFailedFederatedExecution(boolean skipFailedFederatedExecution)

Methods inherited from class java.lang.Object

getClass, 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.Operations

flatten, getOperationsClass, updateOperations

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

FederatedOperation

public FederatedOperation()

Method Detail

graphIds

public FederatedOperation<INPUT,OUTPUT> graphIds(List<String> graphIds)

Specified by:

graphIds in interface IFederatedOperation

graphIdsCSV

public FederatedOperation<INPUT,OUTPUT> graphIdsCSV(String graphIds)

Specified by:

graphIdsCSV in interface IFederatedOperation

payloadOperation

public FederatedOperation<INPUT,OUTPUT> payloadOperation(Operation op)

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<INPUT>

Returns:

A Collection of Operations.

mergeFunction

public FederatedOperation<INPUT,OUTPUT> mergeFunction(BiFunction mergeFunction)

isSkipFailedFederatedExecution

public boolean isSkipFailedFederatedExecution()

isUserRequestingAdminUsage

public boolean isUserRequestingAdminUsage()

Specified by:

isUserRequestingAdminUsage in interface IFederationOperation

setUserRequestingAdminUsage

public FederatedOperation<INPUT,OUTPUT> setUserRequestingAdminUsage(boolean adminRequest)

Specified by:

setUserRequestingAdminUsage in interface IFederationOperation

skipFailedFederatedExecution

public FederatedOperation<INPUT,OUTPUT> skipFailedFederatedExecution(boolean skipFailedFederatedExecution)

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.

options

public FederatedOperation<INPUT,OUTPUT> options(Map<String,String> options)

getGraphIds

public List<String> getGraphIds()

Specified by:

getGraphIds in interface IFederatedOperation

getPayloadOperation

public Operation getPayloadOperation()

Returns a shallow clone of the payload operation.

Returns:

cloned payload

hasPayloadOperation

public boolean hasPayloadOperation()

getUnClonedPayload

public Operation getUnClonedPayload()

Use responsibly internals including options may incorrectly get modified.

Returns:

uncloned payload

getPayloadClass

public Class<? extends Operation> getPayloadClass()

payloadInstanceOf

public boolean payloadInstanceOf(Class<?> c)

getMergeFunction

public BiFunction getMergeFunction()

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.

shallowClone

public FederatedOperation<INPUT,OUTPUT> 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

deepClone

public FederatedOperation<INPUT,OUTPUT> deepClone()
                                                 throws org.apache.commons.lang3.exception.CloneFailedException

Throws:

org.apache.commons.lang3.exception.CloneFailedException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<INPUT>

getInput

public INPUT getInput()

FederatedOperation does not have input.

Specified by:

getInput in interface Input<INPUT>

Returns:

null

setInput

public void setInput(INPUT input)

FederatedOperation does not have input, but will pass through to payload.

Specified by:

setInput in interface Input<INPUT>

Parameters:

input - input to passed to payload operation.