org.apache.flink.graph.utils.proxy

Class GraphAlgorithmWrappingBase<K,VV,EV,R>

java.lang.Object

org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase<K,VV,EV,R>

Type Parameters:

K - ID type

VV - vertex value type

EV - edge value type

R - result type

All Implemented Interfaces:

GraphAlgorithm<K,VV,EV,R>

Direct Known Subclasses:

GraphAlgorithmWrappingDataSet, GraphAlgorithmWrappingGraph

public abstract class GraphAlgorithmWrappingBase<K,VV,EV,R>
extends Object
implements GraphAlgorithm<K,VV,EV,R>

A GraphAlgorithm transforms an input Graph into an output of type T. Subclasses of GraphAlgorithmWrappingBase wrap the output with a NoOpOperator. The input to the wrapped operators 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	parallelism

Constructor Summary

Constructors

Constructor and Description
GraphAlgorithmWrappingBase()

Method Summary

Modifier and Type	Method and Description
protected boolean	canMergeConfigurationWith(GraphAlgorithmWrappingBase other) First test whether the algorithm configurations can be merged before the call to mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).
String	getAlgorithmName() Algorithms are identified by name rather than by class to allow subclassing.
protected void	mergeConfiguration(GraphAlgorithmWrappingBase other) Merge the other configuration into this algorithm's after the call to canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.
GraphAlgorithmWrappingBase<K,VV,EV,R>	setParallelism(int parallelism) Set the parallelism for this algorithm's operators.

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.GraphAlgorithm

run

Field Detail

parallelism

protected int parallelism

Constructor Detail

GraphAlgorithmWrappingBase

public GraphAlgorithmWrappingBase()

Method Detail

setParallelism

public GraphAlgorithmWrappingBase<K,VV,EV,R> setParallelism(int parallelism)

Set the parallelism for this algorithm's operators. This parameter is necessary because processing a small amount of data with high operator parallelism is slow and wasteful with memory and buffers.

Operator parallelism should be set to this given value unless processing asymptotically more data, in which case the default job parallelism should be inherited.

Parameters:

parallelism - operator parallelism

Returns:

this

getAlgorithmName

public 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

canMergeConfigurationWith

protected boolean canMergeConfigurationWith(GraphAlgorithmWrappingBase other)

First test whether the algorithm configurations can be merged before the call to mergeConfiguration(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase).

Parameters:

other - the algorithm with which to compare configuration

Returns:

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

See Also:

mergeConfiguration(GraphAlgorithmWrappingBase)

mergeConfiguration

protected void mergeConfiguration(GraphAlgorithmWrappingBase other)

Merge the other configuration into this algorithm's after the call to canMergeConfigurationWith(org.apache.flink.graph.utils.proxy.GraphAlgorithmWrappingBase) has checked that the configurations can be merged.

Parameters:

other - the algorithm from which to merge configuration

See Also:

canMergeConfigurationWith(GraphAlgorithmWrappingBase)