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

Class RemoveGraph

java.lang.Object

uk.gov.gchq.gaffer.federatedstore.operation.RemoveGraph

All Implemented Interfaces:

Closeable, AutoCloseable, IFederationOperation, Output<Boolean>, Operation

Direct Known Subclasses:

RemoveGraphAndDeleteAllData

public class RemoveGraph
extends Object
implements IFederationOperation, Output<Boolean>

An Operation used for removing graphs from a FederatedStore.

Requires:

• graphId

Does not delete the graph, just removes it from the scope of the FederatedStore.

See Also:

FederatedStore, Graph

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoveGraph.Builder

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

Method Summary

Modifier and Type	Method	Description
String	getGraphId()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Boolean>	getOutputTypeReference()
boolean	isRemoveCache()
boolean	isUserRequestingAdminUsage()
void	setGraphId(String graphId)
void	setOptions(Map<String,String> options)
void	setRemoveCache(boolean removeCache)
RemoveGraph	setUserRequestingAdminUsage(boolean adminRequest)
RemoveGraph	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.Operation

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

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

RemoveGraph

public RemoveGraph()

Method Detail

getGraphId

public String getGraphId()

setGraphId

public void setGraphId(String graphId)

shallowClone

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

isUserRequestingAdminUsage

public boolean isUserRequestingAdminUsage()

Specified by:

isUserRequestingAdminUsage in interface IFederationOperation

setUserRequestingAdminUsage

public RemoveGraph setUserRequestingAdminUsage(boolean adminRequest)

Specified by:

setUserRequestingAdminUsage in interface IFederationOperation

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<Boolean> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Boolean>

isRemoveCache

public boolean isRemoveCache()

setRemoveCache

public void setRemoveCache(boolean removeCache)