org.apache.flink.graph

Interface GraphAnalytic<K,VV,EV,T>

Type Parameters:

K - key type

VV - vertex value type

EV - edge value type

T - the return type

All Known Implementing Classes:

AverageClusteringCoefficient, AverageClusteringCoefficient, ChecksumHashCode, EdgeMetrics, EdgeMetrics, GlobalClusteringCoefficient, GlobalClusteringCoefficient, GraphAnalyticBase, TriadicCensus, TriadicCensus, VertexMetrics, VertexMetrics

public interface GraphAnalytic<K,VV,EV,T>

A GraphAnalytic is similar to a GraphAlgorithm but is terminal and results are retrieved via accumulators. A Flink program has a single point of execution. A GraphAnalytic defers execution to the user to allow composing multiple analytics and algorithms into a single program.

Method Summary

Modifier and Type	Method and Description
T	execute() Execute the program and return the result.
T	execute(String jobName) Execute the program and return the result.
T	getResult() This method must be called after the program has executed.
GraphAnalytic<K,VV,EV,T>	run(Graph<K,VV,EV> input) All GraphAnalytic processing must be terminated by an OutputFormat.

Method Detail

getResult

T getResult()

This method must be called after the program has executed. 1) "run" analytics and algorithms 2) call ExecutionEnvironment.execute() 3) get analytic results

Returns:

the result

execute

T execute()
   throws Exception

Execute the program and return the result.

Returns:

the result

Throws:

Exception

execute

T execute(String jobName)
   throws Exception

Execute the program and return the result.

Parameters:

jobName - the name to assign to the job

Returns:

the result

Throws:

Exception

run

GraphAnalytic<K,VV,EV,T> run(Graph<K,VV,EV> input)
                      throws Exception

All GraphAnalytic processing must be terminated by an OutputFormat. Rather than obtained via accumulators rather than returned by a DataSet.

Parameters:

input - input graph

Returns:

this

Throws:

Exception