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>
AValidate
operation takes inElement
s validates them using the store schema and returns the validElement
s. 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 allValidatable
operations when executing.- See Also:
Validate.Builder
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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 Description Validate()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.MultiInput
createInputArray, setInput
-
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.io.Output
castToOutputType, getOutputClass, getOutputType
-
-
-
-
Method Detail
-
isSkipInvalidElements
public boolean isSkipInvalidElements()
- Specified by:
isSkipInvalidElements
in interfaceValidatable
- Returns:
- true if invalid elements should be skipped. Otherwise false if the operation should fail.
-
isValidate
public boolean isValidate()
- Specified by:
isValidate
in interfaceValidatable
- Returns:
- true if the operation should be validated. Otherwise false.
-
setSkipInvalidElements
public void setSkipInvalidElements(boolean skipInvalidElements)
- Specified by:
setSkipInvalidElements
in interfaceValidatable
- 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 interfaceValidatable
- 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 interfaceOutput<Iterable<? extends 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 interfaceOperation
- Returns:
- shallow clone
-
getOptions
public Map<String,String> getOptions()
- Specified by:
getOptions
in interfaceOperation
- 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 interfaceOperation
- 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.
-
-