org.apache.flink.graph

Class IterationConfiguration

java.lang.Object

org.apache.flink.graph.IterationConfiguration

Direct Known Subclasses:

GSAConfiguration, ScatterGatherConfiguration, VertexCentricConfiguration

public abstract class IterationConfiguration
extends Object

This is used as a base class for vertex-centric iteration or gather-sum-apply iteration configuration.

Constructor Summary

Constructors

Constructor and Description
IterationConfiguration()

Method Summary

Modifier and Type	Method and Description
Map<String,Aggregator<?>>	getAggregators() Gets the set of aggregators that are registered for this vertex-centric iteration.
String	getName(String defaultName) Gets the name of the iteration.
int	getParallelism() Gets the iteration's parallelism.
boolean	isOptNumVertices() Gets whether the number of vertices option is set.
boolean	isSolutionSetUnmanagedMemory() Gets whether the solution set is kept in managed memory (Flink's internal way of keeping object in serialized form) or as a simple object map.
void	registerAggregator(String name, Aggregator<?> aggregator) Registers a new aggregator.
void	setName(String name) Sets the name for the iteration.
void	setOptNumVertices(boolean optNumVertices) Sets the number of vertices option.
void	setParallelism(int parallelism) Sets the parallelism for the iteration.
void	setSolutionSetUnmanagedMemory(boolean unmanaged) Defines whether the solution set is kept in managed memory (Flink's internal way of keeping object in serialized form) or as a simple object map.

Methods inherited from class java.lang.Object

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

Constructor Detail

IterationConfiguration

public IterationConfiguration()

Method Detail

setName

public void setName(String name)

Sets the name for the iteration. The name is displayed in logs and messages.

Parameters:

name - The name for the iteration.

getName

public String getName(String defaultName)

Gets the name of the iteration.

Parameters:

defaultName -

Returns:

The name of the iteration.

setParallelism

public void setParallelism(int parallelism)

Sets the parallelism for the iteration.

Parameters:

parallelism - The parallelism.

getParallelism

public int getParallelism()

Gets the iteration's parallelism.

Returns:

The iterations parallelism, or -1, if not set.

setSolutionSetUnmanagedMemory

public void setSolutionSetUnmanagedMemory(boolean unmanaged)

Defines whether the solution set is kept in managed memory (Flink's internal way of keeping object in serialized form) or as a simple object map. By default, the solution set runs in managed memory.

Parameters:

unmanaged - True, to keep the solution set in unmanaged memory, false otherwise.

isSolutionSetUnmanagedMemory

public boolean isSolutionSetUnmanagedMemory()

Gets whether the solution set is kept in managed memory (Flink's internal way of keeping object in serialized form) or as a simple object map. By default, the solution set runs in managed memory.

Returns:

True, if the solution set is in unmanaged memory, false otherwise.

isOptNumVertices

public boolean isOptNumVertices()

Gets whether the number of vertices option is set. By default, the number of vertices option is not set.

Returns:

True, if the number of vertices option is set, false otherwise.

setOptNumVertices

public void setOptNumVertices(boolean optNumVertices)

Sets the number of vertices option. By default, the number of vertices option is not set.

Parameters:

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

registerAggregator

public void registerAggregator(String name,
                               Aggregator<?> aggregator)

Registers a new aggregator. Aggregators registered here are available during the execution of the vertex updates via GatherFunction.getIterationAggregator(String) and GatherFunction.getPreviousIterationAggregate(String).

Parameters:

name - The name of the aggregator, used to retrieve it and its aggregates during execution.

aggregator - The aggregator.

getAggregators

public Map<String,Aggregator<?>> getAggregators()

Gets the set of aggregators that are registered for this vertex-centric iteration.

Returns:

a Map of the registered aggregators, where the key is the aggregator name and the value is the Aggregator object