org.apache.flink.graph.drivers

Class GraphMetrics<K extends Comparable<K>,VV,EV>

java.lang.Object

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

org.apache.flink.graph.drivers.DriverBase<K,VV,EV>

org.apache.flink.graph.drivers.GraphMetrics<K,VV,EV>

All Implemented Interfaces:

Driver<K,VV,EV>, Parameterized

public class GraphMetrics<K extends Comparable<K>,VV,EV>
extends DriverBase<K,VV,EV>

Driver for directed and undirected graph metrics analytics.

See Also:

org.apache.flink.graph.library.metric.directed.EdgeMetrics, org.apache.flink.graph.library.metric.directed.VertexMetrics, org.apache.flink.graph.library.metric.undirected.EdgeMetrics, org.apache.flink.graph.library.metric.undirected.VertexMetrics

Field Summary

Fields inherited from class org.apache.flink.graph.drivers.DriverBase

parallelism

Constructor Summary

Constructors

Constructor and Description
GraphMetrics()

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 class org.apache.flink.graph.drivers.parameter.ParameterizedBase

addParameter, configure, getName, getUsage

Methods inherited from class java.lang.Object

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

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

configure, getName, getUsage

Constructor Detail

GraphMetrics

public GraphMetrics()

Method Detail

getShortDescription

public String getShortDescription()

Description copied from interface: Driver

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

Returns:

short description

getLongDescription

public String getLongDescription()

Description copied from interface: Driver

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

Returns:

long description

plan

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

Description copied from interface: Driver

"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

public void printAnalytics(PrintStream out)

Description copied from interface: Driver

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

Specified by:

printAnalytics in interface Driver<K extends Comparable<K>,VV,EV>

Overrides:

printAnalytics in class DriverBase<K extends Comparable<K>,VV,EV>

Parameters:

out - output stream for printing results