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>>>
AGetWalks
class is used to retrieve all of the walks in a graph starting from one of a set of providedEntityId
s, 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 inputEntityId
s 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOperations(List<Output<Iterable<Element>>> operations)
Conditional
getConditional()
Iterable<? extends EntityId>
getInput()
int
getNumberOfGetEdgeOperations()
List<OperationChain<Iterable<Element>>>
getOperations()
Should return aCollection
of all operations contained within theOperations
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.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
flatten, 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
-
-
Method Detail
-
setConditional
public void setConditional(Conditional conditional)
-
getConditional
public Conditional getConditional()
-
getOperations
public List<OperationChain<Iterable<Element>>> getOperations()
Description copied from interface:Operations
Should return aCollection
of all operations contained within theOperations
implementation. The collection of operations may be modified by Gaffer.- Specified by:
getOperations
in interfaceOperations<OperationChain<Iterable<Element>>>
- Returns:
- A
Collection
ofOperation
s.
-
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.
-
getNumberOfGetEdgeOperations
public int getNumberOfGetEdgeOperations()
-
getOutputTypeReference
public com.fasterxml.jackson.core.type.TypeReference<Iterable<Walk>> getOutputTypeReference()
- Specified by:
getOutputTypeReference
in interfaceOutput<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 interfaceOperation
- Returns:
- shallow clone
-
isIncludePartial
public boolean isIncludePartial()
-
setIncludePartial
public void setIncludePartial(boolean includePartial)
-
getOptions
public Map<String,String> getOptions()
- Specified by:
getOptions
in interfaceOperation
- 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 interfaceOperation
- 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)
-
-