org.apache.flink.graph.spargel

Class ScatterGatherConfiguration

java.lang.Object

org.apache.flink.graph.IterationConfiguration

org.apache.flink.graph.spargel.ScatterGatherConfiguration

public class ScatterGatherConfiguration
extends IterationConfiguration

A ScatterGatherConfiguration object can be used to set the iteration name and degree of parallelism, to register aggregators and use broadcast sets in the GatherFunction and ScatterFunction

The VertexCentricConfiguration object is passed as an argument to ( org.apache.flink.graph.spargel.GatherFunction, org.apache.flink.graph.spargel.ScatterFunction, int, ScatterGatherConfiguration).

Constructor Summary

Constructors

Constructor and Description
ScatterGatherConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addBroadcastSetForGatherFunction(String name, DataSet<?> data) Adds a data set as a broadcast set to the gather function.
void	addBroadcastSetForScatterFunction(String name, DataSet<?> data) Adds a data set as a broadcast set to the scatter function.
EdgeDirection	getDirection() Gets the direction in which messages are sent in the ScatterFunction.
List<Tuple2<String,DataSet<?>>>	getGatherBcastVars() Get the broadcast variables of the GatherFunction.
List<Tuple2<String,DataSet<?>>>	getScatterBcastVars() Get the broadcast variables of the ScatterFunction.
boolean	isOptDegrees() Gets whether the degrees option is set.
void	setDirection(EdgeDirection direction) Sets the direction in which messages are sent in the ScatterFunction.
void	setOptDegrees(boolean optDegrees) Sets the degree option.

Methods inherited from class org.apache.flink.graph.IterationConfiguration

getAggregators, getName, getParallelism, isOptNumVertices, isSolutionSetUnmanagedMemory, registerAggregator, setName, setOptNumVertices, setParallelism, setSolutionSetUnmanagedMemory

Methods inherited from class java.lang.Object

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

Constructor Detail

ScatterGatherConfiguration

public ScatterGatherConfiguration()

Method Detail

addBroadcastSetForScatterFunction

public void addBroadcastSetForScatterFunction(String name,
                                              DataSet<?> data)

Adds a data set as a broadcast set to the scatter function.

Parameters:

name - The name under which the broadcast data is available in the scatter function.

data - The data set to be broadcast.

addBroadcastSetForGatherFunction

public void addBroadcastSetForGatherFunction(String name,
                                             DataSet<?> data)

Adds a data set as a broadcast set to the gather function.

Parameters:

name - The name under which the broadcast data is available in the gather function.

data - The data set to be broadcast.

getScatterBcastVars

public List<Tuple2<String,DataSet<?>>> getScatterBcastVars()

Get the broadcast variables of the ScatterFunction.

Returns:

a List of Tuple2, where the first field is the broadcast variable name and the second field is the broadcast DataSet.

getGatherBcastVars

public List<Tuple2<String,DataSet<?>>> getGatherBcastVars()

Get the broadcast variables of the GatherFunction.

Returns:

a List of Tuple2, where the first field is the broadcast variable name and the second field is the broadcast DataSet.

isOptDegrees

public boolean isOptDegrees()

Gets whether the degrees option is set. By default, the degrees option is not set.

Returns:

True, if the degree option is set, false otherwise.

setOptDegrees

public void setOptDegrees(boolean optDegrees)

Sets the degree option. By default, the degrees option is not set.

Parameters:

optDegrees - True, to set this option, false otherwise.

getDirection

public EdgeDirection getDirection()

Gets the direction in which messages are sent in the ScatterFunction. By default the messaging direction is OUT.

Returns:

an EdgeDirection, which can be either IN, OUT or ALL.

setDirection

public void setDirection(EdgeDirection direction)

Sets the direction in which messages are sent in the ScatterFunction. By default the messaging direction is OUT.

Parameters:

direction - - IN, OUT or ALL