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

Class GetAdjacentIds

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.get.GetAdjacentIds

All Implemented Interfaces:

Closeable, AutoCloseable, GraphFilters, OperationView, SeededGraphFilters, Input<Iterable<? extends EntityId>>, InputOutput<Iterable<? extends EntityId>,Iterable<? extends EntityId>>, MultiEntityIdInput, MultiInput<EntityId>, Output<Iterable<? extends EntityId>>, Operation

public class GetAdjacentIds
extends Object
implements InputOutput<Iterable<? extends EntityId>,Iterable<? extends EntityId>>, MultiEntityIdInput, SeededGraphFilters

A GetAdjacentIds operation will return the vertex at the opposite end of connected edges to a provided seed vertex.

See Also:

GetAdjacentIds.Builder

Nested Class Summary

Nested Classes

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

Method Summary

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

createInputArray, setInput, setInputFromVerticesAndIds

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

GetAdjacentIds

public GetAdjacentIds()

Method Detail

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

getInput

public Iterable<? extends EntityId> getInput()

Specified by:

getInput in interface Input<Iterable<? extends EntityId>>

Specified by:

getInput in interface MultiInput<EntityId>

setInput

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

Specified by:

setInput in interface Input<Iterable<? extends EntityId>>

Specified by:

setInput in interface MultiInput<EntityId>

getOutputTypeReference

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

Specified by:

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

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.

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

shallowClone

public GetAdjacentIds 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