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

Class GenerateSplitPointsFromSample<T>

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.GenerateSplitPointsFromSample<T>

Type Parameters:

T - the type of splits

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends T>>, InputOutput<Iterable<? extends T>,List<T>>, MultiInput<T>, Output<List<T>>, Operation

public class GenerateSplitPointsFromSample<T>
extends Object
implements Operation, InputOutput<Iterable<? extends T>,List<T>>, MultiInput<T>

The GenerateSplitPointsFromSample operation takes an Iterable sample and generates a List of split points from that. The sample and split points are normally UTF strings but this may differ for different Stores.

You can manually set the number of splits using the numSplits field. If you don't set it then the Gaffer Store should calculate a number of splits for you.

See Also:

GenerateSplitPointsFromSample.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenerateSplitPointsFromSample.Builder<T>

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

Method Summary

Modifier and Type	Method	Description
Iterable<? extends T>	getInput()
Integer	getNumSplits()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<List<T>>	getOutputTypeReference()
void	setInput(Iterable<? extends T> input)
void	setNumSplits(Integer numSplits)
void	setOptions(Map<String,String> options)
GenerateSplitPointsFromSample<T>	shallowClone()	Operation implementations should ensure a ShallowClone method is implemented.
uk.gov.gchq.koryphe.ValidationResult	validate()	Validates an operation.

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

close

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, validateRequiredFieldPresent

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

GenerateSplitPointsFromSample

public GenerateSplitPointsFromSample()

Method Detail

validate

public uk.gov.gchq.koryphe.ValidationResult validate()

Description copied from interface: Operation

Validates an operation. This should be used to validate that fields have been be configured correctly. By default no validation is applied. Override this method to implement validation.

Specified by:

validate in interface Operation

Returns:

validation result.

getInput

public Iterable<? extends T> getInput()

Specified by:

getInput in interface Input<T>

Specified by:

getInput in interface MultiInput<T>

setInput

public void setInput(Iterable<? extends T> input)

Specified by:

setInput in interface Input<T>

Specified by:

setInput in interface MultiInput<T>

getOutputTypeReference

public com.fasterxml.jackson.core.type.TypeReference<List<T>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<T>

shallowClone

public GenerateSplitPointsFromSample<T> 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.

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.

getNumSplits

public Integer getNumSplits()

setNumSplits

public void setNumSplits(Integer numSplits)