org.apache.tinkerpop.gremlin.tinkergraph.process.computer

Class TinkerGraphComputer

java.lang.Object

org.apache.tinkerpop.gremlin.tinkergraph.process.computer.TinkerGraphComputer

All Implemented Interfaces:

GraphComputer

public final class TinkerGraphComputer
extends Object
implements GraphComputer

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.computer.GraphComputer

GraphComputer.Exceptions, GraphComputer.Features, GraphComputer.Persist, GraphComputer.ResultGraph

Constructor Summary

Constructors

Constructor and Description
TinkerGraphComputer(TinkerGraph graph)

Method Summary

Modifier and Type	Method and Description
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TinkerGraphComputer

public TinkerGraphComputer(TinkerGraph graph)

Method Detail

result

public GraphComputer result(GraphComputer.ResultGraph resultGraph)

Description copied from interface: GraphComputer

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.

Specified by:

result in interface GraphComputer

Parameters:

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

Returns:

the updated GraphComputer with newly set result graph

persist

public GraphComputer persist(GraphComputer.Persist persist)

Description copied from interface: GraphComputer

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.

Specified by:

persist in interface GraphComputer

Parameters:

persist - the persistence level of the resultant computation

Returns:

the updated GraphComputer with newly set persist

program

public GraphComputer program(VertexProgram vertexProgram)

Description copied from interface: GraphComputer

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

Specified by:

program in interface GraphComputer

Parameters:

vertexProgram - the VertexProgram to be executed

Returns:

the updated GraphComputer with newly set VertexProgram

mapReduce

public GraphComputer mapReduce(MapReduce mapReduce)

Description copied from interface: GraphComputer

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

Specified by:

mapReduce in interface GraphComputer

Parameters:

mapReduce - the MapReduce job to add to the computation

Returns:

the updated GraphComputer with newly added MapReduce job

submit

public Future<ComputerResult> submit()

Description copied from interface: GraphComputer

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

Specified by:

submit in interface GraphComputer

Returns:

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

toString

public String toString()

Overrides:

toString in class Object

features

public GraphComputer.Features features()

Specified by:

features in interface GraphComputer