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

Class Limit<T>

java.lang.Object

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

All Implemented Interfaces:

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

public class Limit<T>
extends Object
implements InputOutput<Iterable<? extends T>,Iterable<? extends T>>, MultiInput<T>

A Limit operation takes in an Iterable of items and limits the iterable to a given number of items. It simply wraps the input iterable in a LimitedIterable so the data is not stored in memory.

See Also:

Limit.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Limit.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
Limit()
Limit(Integer resultLimit)
Limit(Integer resultLimit, boolean truncate)

Method Summary

Modifier and Type	Method	Description
Iterable<? extends T>	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends T>>	getOutputTypeReference()
Integer	getResultLimit()
Boolean	getTruncate()
void	setInput(Iterable<? extends T> input)
void	setOptions(Map<String,String> options)
void	setResultLimit(Integer resultLimit)
void	setTruncate(boolean truncate)
Limit<T>	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.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, validate, validateRequiredFieldPresent

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

Limit

public Limit()

Limit

public Limit(Integer resultLimit)

Limit

public Limit(Integer resultLimit,
             boolean truncate)

Method Detail

getResultLimit

public Integer getResultLimit()

setResultLimit

public void setResultLimit(Integer resultLimit)

getTruncate

public Boolean getTruncate()

setTruncate

public void setTruncate(boolean truncate)

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<Iterable<? extends T>> getOutputTypeReference()

Specified by:

getOutputTypeReference in interface Output<T>

shallowClone

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