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

Class SummariseGroupOverRanges

java.lang.Object

uk.gov.gchq.gaffer.accumulostore.operation.impl.SummariseGroupOverRanges

All Implemented Interfaces:

Closeable, AutoCloseable, GraphFilters, OperationView, SeededGraphFilters, Input<Iterable<? extends Pair<? extends ElementId,? extends ElementId>>>, InputOutput<Iterable<? extends Pair<? extends ElementId,? extends ElementId>>,Iterable<? extends Element>>, MultiInput<Pair<? extends ElementId,? extends ElementId>>, Output<Iterable<? extends Element>>, Operation

public class SummariseGroupOverRanges
extends Object
implements InputOutput<Iterable<? extends Pair<? extends ElementId,? extends ElementId>>,Iterable<? extends Element>>, MultiInput<Pair<? extends ElementId,? extends ElementId>>, SeededGraphFilters

A SummariseGroupOverRanges operation will return an Element that represents the aggregated form of all data between the provided range for the provided group. Note that one result per tablet on which data in the desired range resides will be returned, with large data sets and/or large ranges more likely to produce multiple results and you will need to cache the results and aggregate them again to get a final answer. For this reason it is recommended your provided ranges do not over-lap as you will be unable to tell for a given result which range the result is from. Standard filtering will still occur before the final aggregation of the vertices.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SummariseGroupOverRanges.Builder

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.Operation

Operation.BaseBuilder<OP extends Operation,B extends Operation.BaseBuilder<OP,?>>

Nested classes/interfaces inherited from interface uk.gov.gchq.gaffer.operation.graph.SeededGraphFilters

SeededGraphFilters.IncludeIncomingOutgoingType

Constructor Summary

Constructors

Constructor	Description
SummariseGroupOverRanges()

Method Summary

Modifier and Type	Method	Description
DirectedType	getDirectedType()
SeededGraphFilters.IncludeIncomingOutgoingType	getIncludeIncomingOutGoing()
Iterable<? extends Pair<? extends ElementId,? extends ElementId>>	getInput()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<? extends Element>>	getOutputTypeReference()
View	getView()
void	setDirectedType(DirectedType directedType)
void	setIncludeIncomingOutGoing(SeededGraphFilters.IncludeIncomingOutgoingType inOutType)
void	setInput(Iterable<? extends Pair<? extends ElementId,? extends ElementId>> input)
void	setOptions(Map<String,String> options)
void	setView(View view)
SummariseGroupOverRanges	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.graph.GraphFilters

validate, validateFlags

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.graph.OperationView

setViews, validate, validate, validatePostAggregationFilter, validatePostTransformFilter, validatePreAggregationFilter

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

castToOutputType, getOutputClass, getOutputType

Constructor Detail

SummariseGroupOverRanges

public SummariseGroupOverRanges()

Method Detail

getInput

public Iterable<? extends Pair<? extends ElementId,? extends ElementId>> getInput()

Specified by:

getInput in interface Input<Iterable<? extends Pair<? extends ElementId,? extends ElementId>>>

Specified by:

getInput in interface MultiInput<Pair<? extends ElementId,? extends ElementId>>

setInput

public void setInput(Iterable<? extends Pair<? extends ElementId,? extends ElementId>> input)

Specified by:

setInput in interface Input<Iterable<? extends Pair<? extends ElementId,? extends ElementId>>>

Specified by:

setInput in interface MultiInput<Pair<? extends ElementId,? extends ElementId>>

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<Iterable<? extends Element>>

getIncludeIncomingOutGoing

public SeededGraphFilters.IncludeIncomingOutgoingType getIncludeIncomingOutGoing()

Specified by:

getIncludeIncomingOutGoing in interface SeededGraphFilters

Returns:

includeIncomingOutGoing a SeededGraphFilters.IncludeIncomingOutgoingType that controls the incoming/outgoing direction of Edges that are filtered out in the operation.

See Also:

SeededGraphFilters.IncludeIncomingOutgoingType

setIncludeIncomingOutGoing

public void setIncludeIncomingOutGoing(SeededGraphFilters.IncludeIncomingOutgoingType inOutType)

Specified by:

setIncludeIncomingOutGoing in interface SeededGraphFilters

Parameters:

inOutType - a SeededGraphFilters.IncludeIncomingOutgoingType that controls the incoming/outgoing direction of Edges that are filtered out in the operation.

See Also:

SeededGraphFilters.IncludeIncomingOutgoingType

getView

public View getView()

Specified by:

getView in interface OperationView

Returns:

the View for the operation.

See Also:

View

setView

public void setView(View view)

Specified by:

setView in interface OperationView

Parameters:

view - the View for the operation.

See Also:

View

getDirectedType

public DirectedType getDirectedType()

Specified by:

getDirectedType in interface GraphFilters

setDirectedType

public void setDirectedType(DirectedType directedType)

Specified by:

setDirectedType in interface GraphFilters

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 SummariseGroupOverRanges 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