Package uk.gov.gchq.gaffer.named.operation

Class AddNamedOperation

java.lang.Object

uk.gov.gchq.gaffer.named.operation.AddNamedOperation

All Implemented Interfaces:

Closeable, AutoCloseable, Operation, Operations<Operation>

public class AddNamedOperation
extends Object
implements Operation, Operations<Operation>

A AddNamedOperation is an Operation for creating a new NamedOperation and adding it to a Gaffer graph.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AddNamedOperation.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
AddNamedOperation()

Method Summary

Modifier and Type	Method	Description
String	getDescription()
List<String>	getLabels()
com.fasterxml.jackson.databind.JsonNode	getOperationChainAsJsonNode()
String	getOperationChainAsString()
String	getOperationName()
Collection<Operation>	getOperations()	Should return a Collection of all operations contained within the Operations implementation.
Map<String,String>	getOptions()
Map<String,ParameterDetail>	getParameters()
AccessPredicate	getReadAccessPredicate()
List<String>	getReadAccessRoles()
Integer	getScore()
AccessPredicate	getWriteAccessPredicate()
List<String>	getWriteAccessRoles()
boolean	isOverwriteFlag()
void	setDescription(String description)
void	setLabels(List<String> labels)
void	setOperationChain(com.fasterxml.jackson.databind.JsonNode opChainNode)
void	setOperationChain(String operationChain)
void	setOperationChain(OperationChain operationChain)
void	setOperationName(String operationName)
void	setOptions(Map<String,String> options)
void	setOverwriteFlag(boolean overwriteFlag)
void	setParameters(Map<String,ParameterDetail> parameters)
void	setReadAccessPredicate(AccessPredicate readAccessPredicate)
void	setReadAccessRoles(List<String> readAccessRoles)
void	setScore(Integer score)
void	setWriteAccessPredicate(AccessPredicate writeAccessPredicate)
void	setWriteAccessRoles(List<String> writeAccessRoles)
AddNamedOperation	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.
void	updateOperations(Collection<Operation> operations)	Updates the operations using the provided collection.

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.Operation

_getNullOrOptions, addOption, close, containsOption, getOption, getOption, validate, validateRequiredFieldPresent

Methods inherited from interface uk.gov.gchq.gaffer.operation.Operations

flatten, getOperationsClass

Constructor Detail

AddNamedOperation

public AddNamedOperation()

Method Detail

isOverwriteFlag

public boolean isOverwriteFlag()

setOverwriteFlag

public void setOverwriteFlag(boolean overwriteFlag)

setOperationChain

public void setOperationChain(String operationChain)

setOperationChain

public void setOperationChain(com.fasterxml.jackson.databind.JsonNode opChainNode)

getOperationChainAsString

public String getOperationChainAsString()

getOperationChainAsJsonNode

public com.fasterxml.jackson.databind.JsonNode getOperationChainAsJsonNode()

setOperationChain

public void setOperationChain(OperationChain operationChain)

getOperationName

public String getOperationName()

setOperationName

public void setOperationName(String operationName)

getLabels

public List<String> getLabels()

setLabels

public void setLabels(List<String> labels)

getReadAccessRoles

public List<String> getReadAccessRoles()

setReadAccessRoles

public void setReadAccessRoles(List<String> readAccessRoles)

getWriteAccessRoles

public List<String> getWriteAccessRoles()

setWriteAccessRoles

public void setWriteAccessRoles(List<String> writeAccessRoles)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

setParameters

public void setParameters(Map<String,ParameterDetail> parameters)

getParameters

public Map<String,ParameterDetail> getParameters()

shallowClone

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

getScore

public Integer getScore()

setScore

public void setScore(Integer score)

getWriteAccessPredicate

public AccessPredicate getWriteAccessPredicate()

setWriteAccessPredicate

public void setWriteAccessPredicate(AccessPredicate writeAccessPredicate)

getReadAccessPredicate

public AccessPredicate getReadAccessPredicate()

setReadAccessPredicate

public void setReadAccessPredicate(AccessPredicate readAccessPredicate)

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

Returns:

a list of the operations in the operation chain resolved using the default parameters.

updateOperations

public void updateOperations(Collection<Operation> operations)

Description copied from interface: Operations

Updates the operations using the provided collection. By default this will just clear the current operations collection and add all the new operations.

Specified by:

updateOperations in interface Operations<Operation>

Parameters:

operations - the new operations.