org.apache.flink.graph

Class Runner

java.lang.Object

org.apache.flink.graph.drivers.parameter.ParameterizedBase

org.apache.flink.graph.Runner

All Implemented Interfaces:

Parameterized

public class Runner
extends ParameterizedBase

This default main class executes Flink drivers.

An execution has one input, one algorithm, and one output. Anything more complex can be expressed as a user program written in a JVM language.

Inputs and algorithms are decoupled by, respectively, producing and consuming a graph. Currently only Graph is supported but later updates may add support for new graph types such as BipartiteGraph.

Algorithms must explicitly support each type of output via implementation of interfaces. This is scalable as the number of outputs is small and finite.

Constructor Summary

Constructors

Constructor and Description
Runner(String[] args) Create an algorithm runner from the given arguments.

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.java.ExecutionEnvironment	getExecutionEnvironment() Get the ExecutionEnvironment.
String	getName() A unique, human-readable identifier.
org.apache.flink.api.java.DataSet	getResult() Get the result DataSet.
static void	main(String[] args)
Runner	run() Setup the Flink job with the graph input, algorithm, and output.

Methods inherited from class org.apache.flink.graph.drivers.parameter.ParameterizedBase

addParameter, configure, getUsage

Methods inherited from class java.lang.Object

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

Constructor Detail

Runner

public Runner(String[] args)

Create an algorithm runner from the given arguments.

Parameters:

args - command-line arguments

Method Detail

getName

public String getName()

Description copied from interface: Parameterized

A unique, human-readable identifier. Presented to the user as the name of a selectable choice.

Specified by:

getName in interface Parameterized

Overrides:

getName in class ParameterizedBase

Returns:

parameter name

getExecutionEnvironment

public org.apache.flink.api.java.ExecutionEnvironment getExecutionEnvironment()

Get the ExecutionEnvironment. The ExecutionEnvironment is only available after calling run().

Returns:

the ExecutionEnvironment

getResult

public org.apache.flink.api.java.DataSet getResult()

Get the result DataSet. The result is only available after calling run().

Returns:

the result DataSet

run

public Runner run()
           throws Exception

Setup the Flink job with the graph input, algorithm, and output.

To then execute the job call execute().

Returns:

this

Throws:

Exception - on error

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception