org.apache.tinkerpop.gremlin.process.computer

Interface GraphComputer

public interface GraphComputer

The GraphComputer is responsible for the execution of a VertexProgram and then a set of MapReduce jobs over the vertices in the Graph. It is up to the GraphComputer implementation to determine the appropriate memory structures given the computing substrate.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Matthias Broecheler (me@matthiasb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GraphComputer.Exceptions
static interface	GraphComputer.Features
static class	GraphComputer.Persist
static class	GraphComputer.ResultGraph

Method Summary

Modifier and Type	Method and Description
default GraphComputer.Features	features()
GraphComputer	mapReduce(MapReduce mapReduce) Add a MapReduce job to the set of MapReduce jobs to be executed by the GraphComputer.
GraphComputer	persist(GraphComputer.Persist persist) Set the GraphComputer.Persist level of the computation.
GraphComputer	program(VertexProgram vertexProgram) Set the VertexProgram to be executed by the GraphComputer.
GraphComputer	result(GraphComputer.ResultGraph resultGraph) Set the GraphComputer.ResultGraph of the computation.
Future<ComputerResult>	submit() Submit the VertexProgram and the set of MapReduce jobs for execution by the GraphComputer.

Method Detail

result

GraphComputer result(GraphComputer.ResultGraph resultGraph)

Set the GraphComputer.ResultGraph of the computation. If this is not set explicitly by the user, then the VertexProgram can choose the most efficient result for its intended use. If there is no declared vertex program, then the GraphComputer defaults to GraphComputer.ResultGraph.ORIGINAL.

Parameters:

resultGraph - the type of graph to be returned by ComputerResult.graph()

Returns:

the updated GraphComputer with newly set result graph

persist

GraphComputer persist(GraphComputer.Persist persist)

Set the GraphComputer.Persist level of the computation. If this is not set explicitly by the user, then the VertexProgram can choose the most efficient persist for the its intended use. If there is no declared vertex program, then the GraphComputer defaults to GraphComputer.Persist.NOTHING.

Parameters:

persist - the persistence level of the resultant computation

Returns:

the updated GraphComputer with newly set persist

program

GraphComputer program(VertexProgram vertexProgram)

Set the VertexProgram to be executed by the GraphComputer. There can only be one VertexProgram for the GraphComputer.

Parameters:

vertexProgram - the VertexProgram to be executed

Returns:

the updated GraphComputer with newly set VertexProgram

mapReduce

GraphComputer mapReduce(MapReduce mapReduce)

Add a MapReduce job to the set of MapReduce jobs to be executed by the GraphComputer. There can be any number of MapReduce jobs.

Parameters:

mapReduce - the MapReduce job to add to the computation

Returns:

the updated GraphComputer with newly added MapReduce job

submit

Future<ComputerResult> submit()

Submit the VertexProgram and the set of MapReduce jobs for execution by the GraphComputer.

Returns:

a Future denoting a reference to the asynchronous computation and where to get the DefaultComputerResult when its is complete.

features

default GraphComputer.Features features()