org.apache.flink.graph.utils.proxy

Class GraphAlgorithmDelegatingDataSet<K,VV,EV,T>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmDelegatingDataSet<K,VV,EV,T>

Type Parameters:

K - ID type

VV - vertex value type

EV - edge value type

T - output type

All Implemented Interfaces:

GraphAlgorithm<K,VV,EV,org.apache.flink.api.java.DataSet<T>>

Direct Known Subclasses:

AdamicAdar, EdgeDegreePair, EdgeDegreesPair, EdgeSourceDegree, EdgeSourceDegrees, EdgeTargetDegree, EdgeTargetDegrees, HITS, JaccardIndex, LocalClusteringCoefficient, LocalClusteringCoefficient, TriangleListing, TriangleListing, VertexDegree, VertexDegrees, VertexInDegree, VertexOutDegree

public abstract class GraphAlgorithmDelegatingDataSet<K,VV,EV,T>
extends Object
implements GraphAlgorithm<K,VV,EV,org.apache.flink.api.java.DataSet<T>>

A GraphAlgorithm transforms an input Graph into an output of type T. A GraphAlgorithmDelegatingDataSet wraps the resultant DataSet with a delegating proxy object. The delegated object can be replaced when the same algorithm is run on the same input with a mergeable configuration. This allows algorithms to be composed of implicitly reusable algorithms without publicly sharing intermediate DataSets.

Constructor Summary

Constructors

Constructor and Description
GraphAlgorithmDelegatingDataSet()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
protected abstract String	getAlgorithmName() Algorithms are identified by name rather than by class to allow subclassing.
int	hashCode()
protected abstract boolean	mergeConfiguration(GraphAlgorithmDelegatingDataSet other) An algorithm must first test whether the configurations can be merged before merging individual fields.
org.apache.flink.api.java.DataSet<T>	run(Graph<K,VV,EV> input)
protected abstract org.apache.flink.api.java.DataSet<T>	runInternal(Graph<K,VV,EV> input) The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphAlgorithmDelegatingDataSet

public GraphAlgorithmDelegatingDataSet()

Method Detail

getAlgorithmName

protected abstract String getAlgorithmName()

Algorithms are identified by name rather than by class to allow subclassing.

Returns:

name of the algorithm, which may be shared by multiple classes implementing the same algorithm and generating the same output

mergeConfiguration

protected abstract boolean mergeConfiguration(GraphAlgorithmDelegatingDataSet other)

An algorithm must first test whether the configurations can be merged before merging individual fields.

Parameters:

other - the algorithm with which to compare and merge

Returns:

true if and only if configuration has been merged and the algorithm's output can be reused

runInternal

protected abstract org.apache.flink.api.java.DataSet<T> runInternal(Graph<K,VV,EV> input)
                                                             throws Exception

The implementation of the algorithm, renamed from GraphAlgorithm.run(Graph).

Parameters:

input - the input graph

Returns:

the algorithm's output

Throws:

Exception

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

run

public final org.apache.flink.api.java.DataSet<T> run(Graph<K,VV,EV> input)
                                               throws Exception

Specified by:

run in interface GraphAlgorithm<K,VV,EV,org.apache.flink.api.java.DataSet<T>>

Throws:

Exception