public class ConnectedComponentVertexProgram extends Object implements VertexProgram<String>
Modifier and Type | Class and Description |
---|---|
static class |
ConnectedComponentVertexProgram.Builder |
VertexProgram.Features
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT |
VERTEX_PROGRAM
Modifier and Type | Method and Description |
---|---|
static ConnectedComponentVertexProgram.Builder |
build() |
ConnectedComponentVertexProgram |
clone()
When multiple workers on a single machine need VertexProgram instances, it is possible to use clone.
|
void |
execute(Vertex vertex,
Messenger<String> 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()
The
Memory keys that will be used during the computation. |
Set<MessageScope> |
getMessageScopes(Memory memory)
This method returns all the
MessageScope possibilities for a particular iteration of the vertex program. |
GraphComputer.Persist |
getPreferredPersist() |
GraphComputer.ResultGraph |
getPreferredResultGraph() |
Set<VertexComputeKey> |
getVertexComputeKeys()
The
Element properties that will be mutated during the computation. |
void |
loadState(Graph graph,
org.apache.commons.configuration2.Configuration config)
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 config)
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.
|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createVertexProgram, getMapReducers, getMessageCombiner, getTraverserRequirements, workerIterationEnd, workerIterationStart
public static final String COMPONENT
public void loadState(Graph graph, org.apache.commons.configuration2.Configuration config)
VertexProgram
loadState
in interface VertexProgram<String>
graph
- the graph that the VertexProgram will run againstconfig
- the configuration to load the state of the VertexProgram from.public void storeState(org.apache.commons.configuration2.Configuration config)
VertexProgram
storeState
in interface VertexProgram<String>
config
- the configuration to store the state of the VertexProgram in.public void setup(Memory memory)
VertexProgram
GraphComputer
and as such, is not called for each vertex.
During this stage, the Memory
should be initialized to to its "start state."setup
in interface VertexProgram<String>
memory
- The global memory of the GraphComputerpublic void execute(Vertex vertex, Messenger<String> messenger, Memory memory)
VertexProgram
Memory
is read, it is according to the aggregated state yielded in the previous iteration.
When the Memory
is written, the data will be aggregated at the end of the iteration for reading in the next iteration.execute
in interface VertexProgram<String>
vertex
- the Vertex
to execute the VertexProgram
onmessenger
- the messenger that moves data between verticesmemory
- the shared state between all vertices in the computationpublic Set<VertexComputeKey> getVertexComputeKeys()
VertexProgram
Element
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.getVertexComputeKeys
in interface VertexProgram<String>
public Set<MemoryComputeKey> getMemoryComputeKeys()
VertexProgram
Memory
keys that will be used during the computation.
These are the only keys that can be read or written throughout the life of the GraphComputer
.
The default is an empty set.getMemoryComputeKeys
in interface VertexProgram<String>
public boolean terminate(Memory memory)
VertexProgram
GraphComputer
and as such, is not called for each Vertex
.
The Memory
maintains the aggregated data from the last execute() iteration.terminate
in interface VertexProgram<String>
memory
- The global memory of the GraphComputer
public Set<MessageScope> getMessageScopes(Memory memory)
VertexProgram
MessageScope
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.getMessageScopes
in interface VertexProgram<String>
memory
- an immutable form of the Memory
public GraphComputer.ResultGraph getPreferredResultGraph()
getPreferredResultGraph
in interface VertexProgram<String>
public GraphComputer.Persist getPreferredPersist()
getPreferredPersist
in interface VertexProgram<String>
public ConnectedComponentVertexProgram clone()
VertexProgram
VertexProgram.storeState(org.apache.commons.configuration2.Configuration)
and VertexProgram.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.clone
in interface VertexProgram<String>
clone
in class Object
public VertexProgram.Features getFeatures()
getFeatures
in interface VertexProgram<String>
public static ConnectedComponentVertexProgram.Builder build()
Copyright © 2013–2022 Apache Software Foundation. All rights reserved.