uk.gov.gchq.gaffer.operation.impl

Class Validate

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.Validate

All Implemented Interfaces:

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

public class Validate
extends Object
implements Validatable, InputOutput<Iterable<? extends Element>,Iterable<? extends Element>>, MultiInput<Element>

A Validate operation takes in Elements validates them using the store schema and returns the valid Elements. If skipInvalidElements is set to false, the handler should stop the operation if invalid elements are found. The Graph will automatically add this operation prior to all Validatable operations when executing.

See Also:

Validate.Builder

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Iterable<? extends Element>	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Element>>	getOutputTypeReference()
boolean	isSkipInvalidElements()
boolean	isValidate()
void	setInput(Iterable<? extends Element> input)
void	setOptions(Map<String,String> options)
void	setSkipInvalidElements(boolean skipInvalidElements)
void	setValidate(boolean validate)
Validate	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.Output

castToOutputType, getOutputClass

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

createInputArray, setInput

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

close

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

_getNullOrOptions, addOption, asOperationChain, getOption, getOption, validate, validateRequiredFieldPresent

Constructor Detail

Validate

public Validate()

Method Detail

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.

isValidate

public boolean isValidate()

Specified by:

isValidate in interface Validatable

Returns:

true if the operation should be validated. Otherwise false.

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.

setValidate

public void setValidate(boolean validate)

Specified by:

setValidate in interface Validatable

Parameters:

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

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Element>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<Iterable<? extends 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> input)

Specified by:

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

Specified by:

setInput in interface MultiInput<Element>

shallowClone

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