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

Class GetWalks

java.lang.Object

uk.gov.gchq.gaffer.operation.impl.GetWalks

All Implemented Interfaces:

Closeable, AutoCloseable, Input<Iterable<? extends EntityId>>, InputOutput<Iterable<? extends EntityId>,Iterable<Walk>>, MultiEntityIdInput, MultiInput<EntityId>, Output<Iterable<Walk>>, Operation, Operations<OperationChain<Iterable<Element>>>

public class GetWalks
extends Object
implements InputOutput<Iterable<? extends EntityId>,Iterable<Walk>>, MultiEntityIdInput, Operations<OperationChain<Iterable<Element>>>

A GetWalks class is used to retrieve all of the walks in a graph starting from one of a set of provided EntityIds, with a maximum length.

A GetWalks operation is configured using a user-supplied list of GetElements operations. These are executed sequentially, with the output of one operation providing the input EntityIds for the next.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetWalks.Builder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_RESULTS_LIMIT
static String	HOP_DEFINITION

Constructor Summary

Constructors

Constructor	Description
GetWalks()

Method Summary

Modifier and Type	Method	Description
void	addOperations(List<Output<Iterable<Element>>> operations)
List<Operation>	flatten()	Recursively flattens nested operations.
Conditional	getConditional()
Iterable<? extends EntityId>	getInput()
int	getNumberOfGetEdgeOperations()
List<OperationChain<Iterable<Element>>>	getOperations()	Should return a Collection of all operations contained within the Operations implementation.
Map<String,String>	getOptions()
com.fasterxml.jackson.core.type.TypeReference<Iterable<Walk>>	getOutputTypeReference()
Integer	getResultsLimit()
boolean	isIncludePartial()
void	setConditional(Conditional conditional)
void	setIncludePartial(boolean includePartial)
void	setInput(Iterable<? extends EntityId> input)
void	setOperations(List<Output<Iterable<Element>>> operations)
void	setOptions(Map<String,String> options)
void	setResultsLimit(Integer resultsLimit)
GetWalks	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.MultiEntityIdInput

createInputArray, setInput, setInputFromVerticesAndIds

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

getOperationsClass, updateOperations

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

castToOutputType, getOutputClass, getOutputType

Field Detail

HOP_DEFINITION

public static final String HOP_DEFINITION

See Also:

Constant Field Values

DEFAULT_RESULTS_LIMIT

public static final int DEFAULT_RESULTS_LIMIT

See Also:

Constant Field Values

Constructor Detail

GetWalks

public GetWalks()

Method Detail

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>

setConditional

public void setConditional(Conditional conditional)

getConditional

public Conditional getConditional()

getOperations

public List<OperationChain<Iterable<Element>>> getOperations()

Description copied from interface: Operations

Should return a Collection of all operations contained within the Operations implementation. The collection of operations may be modified by Gaffer.

Specified by:

getOperations in interface Operations<OperationChain<Iterable<Element>>>

Returns:

A Collection of Operations.

setOperations

public void setOperations(List<Output<Iterable<Element>>> operations)

addOperations

public void addOperations(List<Output<Iterable<Element>>> operations)

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.

flatten

public List<Operation> flatten()

Description copied from interface: Operations

Recursively flattens nested operations.

Specified by:

flatten in interface Operations<OperationChain<Iterable<Element>>>

Returns:

a list of flattened operations.

getNumberOfGetEdgeOperations

public int getNumberOfGetEdgeOperations()

getOutputTypeReference

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

Specified by:

getOutputTypeReference in interface Output<Iterable<Walk>>

shallowClone

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

isIncludePartial

public boolean isIncludePartial()

setIncludePartial

public void setIncludePartial(boolean includePartial)

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.

getResultsLimit

public Integer getResultsLimit()

setResultsLimit

public void setResultsLimit(Integer resultsLimit)