Class ShortestPathVertexProgram
- java.lang.Object
-
- org.apache.tinkerpop.gremlin.process.computer.search.path.ShortestPathVertexProgram
-
- All Implemented Interfaces:
Cloneable
,VertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
public class ShortestPathVertexProgram extends Object implements VertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Author:
- Daniel Kuppitz (http://gremlin.guru)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ShortestPathVertexProgram.Builder
-
Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.computer.VertexProgram
VertexProgram.Features
-
-
Field Summary
Fields Modifier and Type Field Description static org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Edge,Number>
DEFAULT_DISTANCE_TRAVERSAL
static org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Vertex,Edge>
DEFAULT_EDGE_TRAVERSAL
static org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Vertex,?>
DEFAULT_VERTEX_FILTER_TRAVERSAL
static String
SHORTEST_PATHS
-
Fields inherited from interface org.apache.tinkerpop.gremlin.process.computer.VertexProgram
VERTEX_PROGRAM
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ShortestPathVertexProgram.Builder
build()
VertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
clone()
When multiple workers on a single machine need VertexProgram instances, it is possible to use clone.void
execute(Vertex vertex, Messenger<org.javatuples.Triplet<Path,Edge,Number>> messenger, Memory memory)
This method denotes the main body of the computation and is executed on each vertex in the graph.VertexProgram.Features
getFeatures()
Set<MemoryComputeKey>
getMemoryComputeKeys()
TheMemory
keys that will be used during the computation.Set<MessageScope>
getMessageScopes(Memory memory)
This method returns all theMessageScope
possibilities for a particular iteration of the vertex program.GraphComputer.Persist
getPreferredPersist()
GraphComputer.ResultGraph
getPreferredResultGraph()
Set<VertexComputeKey>
getVertexComputeKeys()
TheElement
properties that will be mutated during the computation.void
loadState(Graph graph, org.apache.commons.configuration2.Configuration configuration)
When it is necessary to load the state of the VertexProgram, this method is called.void
setup(Memory memory)
The method is called at the beginning of the computation.void
storeState(org.apache.commons.configuration2.Configuration configuration)
When it is necessary to store the state of the VertexProgram, this method is called.boolean
terminate(Memory memory)
The method is called at the end of each iteration to determine if the computation is complete.String
toString()
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.computer.VertexProgram
getMapReducers, getMessageCombiner, getTraverserRequirements, workerIterationEnd, workerIterationStart
-
-
-
-
Field Detail
-
SHORTEST_PATHS
public static final String SHORTEST_PATHS
- See Also:
- Constant Field Values
-
DEFAULT_VERTEX_FILTER_TRAVERSAL
public static final org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Vertex,?> DEFAULT_VERTEX_FILTER_TRAVERSAL
-
DEFAULT_EDGE_TRAVERSAL
public static final org.apache.tinkerpop.gremlin.process.traversal.util.PureTraversal<Vertex,Edge> DEFAULT_EDGE_TRAVERSAL
-
-
Method Detail
-
loadState
public void loadState(Graph graph, org.apache.commons.configuration2.Configuration configuration)
Description copied from interface:VertexProgram
When it is necessary to load the state of the VertexProgram, this method is called. This is typically required when the VertexProgram needs to be serialized to another machine. Note that what is loaded is simply the instance state, not any processed data.- Specified by:
loadState
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
graph
- the graph that the VertexProgram will run againstconfiguration
- the configuration to load the state of the VertexProgram from.
-
storeState
public void storeState(org.apache.commons.configuration2.Configuration configuration)
Description copied from interface:VertexProgram
When it is necessary to store the state of the VertexProgram, this method is called. This is typically required when the VertexProgram needs to be serialized to another machine. Note that what is stored is simply the instance/configuration state, not any processed data. The default implementation provided simply stores the VertexProgram class name for reflective reconstruction. It is typically a good idea to VertexProgram.super.storeState().- Specified by:
storeState
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
configuration
- the configuration to store the state of the VertexProgram in.
-
getVertexComputeKeys
public Set<VertexComputeKey> getVertexComputeKeys()
Description copied from interface:VertexProgram
TheElement
properties that will be mutated during the computation. All properties in the graph are readable, but only the keys specified here are writable. The default is an empty set.- Specified by:
getVertexComputeKeys
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Returns:
- the set of element keys that will be mutated during the vertex program's execution
-
getMemoryComputeKeys
public Set<MemoryComputeKey> getMemoryComputeKeys()
Description copied from interface:VertexProgram
TheMemory
keys that will be used during the computation. These are the only keys that can be read or written throughout the life of theGraphComputer
. The default is an empty set.- Specified by:
getMemoryComputeKeys
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Returns:
- the set of memory keys that will be read/written
-
getMessageScopes
public Set<MessageScope> getMessageScopes(Memory memory)
Description copied from interface:VertexProgram
This method returns all theMessageScope
possibilities for a particular iteration of the vertex program. The returned messages scopes are the scopes that will be used to send messages during the stated iteration. It is not a requirement that all stated messages scopes be used, just that it is possible that they be used during the iteration.- Specified by:
getMessageScopes
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
memory
- an immutable form of theMemory
- Returns:
- all possible message scopes during said vertex program iteration
-
clone
public VertexProgram<org.javatuples.Triplet<Path,Edge,Number>> clone()
Description copied from interface:VertexProgram
When multiple workers on a single machine need VertexProgram instances, it is possible to use clone. This will provide a speedier way of generating instances, over theVertexProgram.storeState(org.apache.commons.configuration2.Configuration)
andVertexProgram.loadState(org.apache.tinkerpop.gremlin.structure.Graph, org.apache.commons.configuration2.Configuration)
model. The default implementation simply returns the object as it assumes that the VertexProgram instance is a stateless singleton.
-
getPreferredResultGraph
public GraphComputer.ResultGraph getPreferredResultGraph()
- Specified by:
getPreferredResultGraph
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
-
getPreferredPersist
public GraphComputer.Persist getPreferredPersist()
- Specified by:
getPreferredPersist
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
-
setup
public void setup(Memory memory)
Description copied from interface:VertexProgram
The method is called at the beginning of the computation. The method is global to theGraphComputer
and as such, is not called for each vertex. During this stage, theMemory
should be initialized to to its "start state."- Specified by:
setup
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
memory
- The global memory of the GraphComputer
-
execute
public void execute(Vertex vertex, Messenger<org.javatuples.Triplet<Path,Edge,Number>> messenger, Memory memory)
Description copied from interface:VertexProgram
This method denotes the main body of the computation and is executed on each vertex in the graph. This method is logically executed in parallel on all vertices in the graph. When theMemory
is read, it is according to the aggregated state yielded in the previous iteration. When theMemory
is written, the data will be aggregated at the end of the iteration for reading in the next iteration.- Specified by:
execute
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
vertex
- theVertex
to execute theVertexProgram
onmessenger
- the messenger that moves data between verticesmemory
- the shared state between all vertices in the computation
-
terminate
public boolean terminate(Memory memory)
Description copied from interface:VertexProgram
The method is called at the end of each iteration to determine if the computation is complete. The method is global to theGraphComputer
and as such, is not called for eachVertex
. TheMemory
maintains the aggregated data from the last execute() iteration.- Specified by:
terminate
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
- Parameters:
memory
- The global memory of theGraphComputer
- Returns:
- whether or not to halt the computation
-
build
public static ShortestPathVertexProgram.Builder build()
-
getFeatures
public VertexProgram.Features getFeatures()
- Specified by:
getFeatures
in interfaceVertexProgram<org.javatuples.Triplet<Path,Edge,Number>>
-
-