org.apache.flink.graph.drivers

Interface Driver<K,VV,EV>

Type Parameters:

K - graph ID type

VV - vertex value type

EV - edge value type

All Superinterfaces:

Parameterized

All Known Implementing Classes:

AdamicAdar, ClusteringCoefficient, ConnectedComponents, DriverBase, EdgeList, GraphMetrics, HITS, JaccardIndex, PageRank, TriangleListing

public interface Driver<K,VV,EV>
extends Parameterized

A driver for one or more GraphAlgorithm and/or GraphAnalytic.

It is preferable to include multiple, overlapping algorithms/analytics in the same driver both for simplicity and since this examples module demonstrates Flink capabilities rather than absolute performance.

Method Summary

Modifier and Type	Method and Description
String	getLongDescription() A multi-line description, presented in the algorithm usage.
String	getShortDescription() A one-line description, presented in the algorithm listing.
org.apache.flink.api.java.DataSet	plan(org.apache.flink.graph.Graph<K,VV,EV> graph) "Run" algorithms and analytics on the input graph.
void	printAnalytics(PrintStream out) Analytic results are summaries so are always printed to the console irrespective of the chosen Output.

Methods inherited from interface org.apache.flink.graph.drivers.parameter.Parameterized

configure, getName, getUsage

Method Detail

getShortDescription

String getShortDescription()

A one-line description, presented in the algorithm listing.

Returns:

short description

getLongDescription

String getLongDescription()

A multi-line description, presented in the algorithm usage.

Returns:

long description

plan

org.apache.flink.api.java.DataSet plan(org.apache.flink.graph.Graph<K,VV,EV> graph)
                                throws Exception

"Run" algorithms and analytics on the input graph. The execution plan is not finalized here but in the output methods.

Drivers are first configured, next planned, and finally the chosen output method is called.

A null value should be returned when the Driver does not execute a GraphAlgorithm but only executes a GraphAnalytic.

Parameters:

graph - input graph

Throws:

Exception - on error

printAnalytics

void printAnalytics(PrintStream out)

Analytic results are summaries so are always printed to the console irrespective of the chosen Output.

Parameters:

out - output stream for printing results