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

Class DeleteElements

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.delete.DeleteElements

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends Element>>, MultiInput<Element>, Operation, Validatable

public class DeleteElements
extends Object
implements Validatable, MultiInput<Element>

A DeleteElements operation is a Validatable operation for deleting elements. This is a core operation that all stores should be able to handle. This operation requires an Iterable of Elements to be deleted. Handlers should throw an OperationException if unsuccessful. For normal operation handlers the operation View will be ignored.

See Also:

DeleteElements.Builder

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Object[]	createInputArray()
boolean	equals(Object obj)
Iterable<? extends Element>	getInput()
Map<String,String>	getOptions()
int	hashCode()
boolean	isSkipInvalidElements()
boolean	isValidate()
void	setInput(Iterable<? extends Element> elements)
void	setOptions(Map<String,String> options)
void	setSkipInvalidElements(boolean skipInvalidElements)
void	setValidate(boolean validate)
DeleteElements	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, 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

Constructor Detail

DeleteElements

public DeleteElements()

Method Detail

isValidate

public boolean isValidate()

Specified by:

isValidate in interface Validatable

Returns:

true if the operation should be validated. Otherwise false.

setValidate

public void setValidate(boolean validate)

Specified by:

setValidate in interface Validatable

Parameters:

validate - true if the operation should be validated. Otherwise false.

isSkipInvalidElements

public boolean isSkipInvalidElements()

Specified by:

isSkipInvalidElements in interface Validatable

Returns:

true if invalid elements should be skipped. Otherwise false if the operation should fail.

setSkipInvalidElements

public void setSkipInvalidElements(boolean skipInvalidElements)

Specified by:

setSkipInvalidElements in interface Validatable

Parameters:

skipInvalidElements - true if invalid elements should be skipped. Otherwise false if the operation should fail.

createInputArray

public Object[] createInputArray()

Specified by:

createInputArray in interface MultiInput<Element>

getInput

public Iterable<? extends Element> getInput()

Specified by:

getInput in interface Input<Iterable<? extends Element>>

Specified by:

getInput in interface MultiInput<Element>

setInput

public void setInput(Iterable<? extends Element> elements)

Specified by:

setInput in interface Input<Iterable<? extends Element>>

Specified by:

setInput in interface MultiInput<Element>

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.

shallowClone

public DeleteElements 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object