org.apache.flink.graph.gsa

Class GSAConfiguration

java.lang.Object

org.apache.flink.graph.IterationConfiguration

org.apache.flink.graph.gsa.GSAConfiguration

public class GSAConfiguration
extends IterationConfiguration

A GSAConfiguration object can be used to set the iteration name and degree of parallelism, to register aggregators and use broadcast sets in the GatherFunction, SumFunction as well as ApplyFunction.

The GSAConfiguration object is passed as an argument to Graph.runGatherSumApplyIteration(org.apache.flink.graph.gsa.GatherFunction, org.apache.flink.graph.gsa.SumFunction, org.apache.flink.graph.gsa.ApplyFunction, int)

Constructor Summary

Constructors

Constructor and Description
GSAConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addBroadcastSetForApplyFunction(String name, org.apache.flink.api.java.DataSet<?> data) Adds a data set as a broadcast set to the apply function.
void	addBroadcastSetForGatherFunction(String name, org.apache.flink.api.java.DataSet<?> data) Adds a data set as a broadcast set to the gather function.
void	addBroadcastSetForSumFunction(String name, org.apache.flink.api.java.DataSet<?> data) Adds a data set as a broadcast set to the sum function.
List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.DataSet<?>>>	getApplyBcastVars() Get the broadcast variables of the ApplyFunction.
EdgeDirection	getDirection() Gets the direction from which the neighbors are to be selected By default the neighbors who are target of the edges are selected.
List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.DataSet<?>>>	getGatherBcastVars() Get the broadcast variables of the GatherFunction.
List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.DataSet<?>>>	getSumBcastVars() Get the broadcast variables of the SumFunction.
void	setDirection(EdgeDirection direction) Sets the direction in which neighbors are to be selected By default the neighbors who are target of the edges are selected.

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

GSAConfiguration

public GSAConfiguration()

Method Detail

addBroadcastSetForGatherFunction

public void addBroadcastSetForGatherFunction(String name,
                                             org.apache.flink.api.java.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.

addBroadcastSetForSumFunction

public void addBroadcastSetForSumFunction(String name,
                                          org.apache.flink.api.java.DataSet<?> data)

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

Parameters:

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

data - The data set to be broadcast.

addBroadcastSetForApplyFunction

public void addBroadcastSetForApplyFunction(String name,
                                            org.apache.flink.api.java.DataSet<?> data)

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

Parameters:

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

data - The data set to be broadcast.

getGatherBcastVars

public List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.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.

getSumBcastVars

public List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.DataSet<?>>> getSumBcastVars()

Get the broadcast variables of the SumFunction.

Returns:

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

getApplyBcastVars

public List<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.api.java.DataSet<?>>> getApplyBcastVars()

Get the broadcast variables of the ApplyFunction.

Returns:

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

getDirection

public EdgeDirection getDirection()

Gets the direction from which the neighbors are to be selected By default the neighbors who are target of the edges are selected.

Returns:

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

setDirection

public void setDirection(EdgeDirection direction)

Sets the direction in which neighbors are to be selected By default the neighbors who are target of the edges are selected.

Parameters:

direction - - IN, OUT or ALL