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

Class CountGroups

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.CountGroups

All Implemented Interfaces:

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

public class CountGroups
extends Object
implements InputOutput<Iterable<? extends Element>,GroupCounts>, MultiInput<Element>

A CountGroups operation takes in Elements and collects counts for the number of entity and edge groups used. To avoid counting all elements in the store, this operation has a limit, which can be set to skip counting the remaining groups.

See Also:

CountGroups.Builder

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
Iterable<? extends Element>	getInput()
Integer	getLimit()
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<GroupCounts>	getOutputTypeReference()
void	setInput(Iterable<? extends Element> input)
void	setLimit(Integer limit)
void	setOptions(Map<String,String> options)
CountGroups	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

CountGroups

public CountGroups()

CountGroups

public CountGroups(Integer limit)

Method Detail

getLimit

public Integer getLimit()

setLimit

public void setLimit(Integer limit)

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<GroupCounts>

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