org.apache.flink.graph.drivers.parameter

Class Simplify

java.lang.Object

org.apache.flink.graph.drivers.parameter.Simplify

All Implemented Interfaces:

Parameter<Simplify.Ordering>

public class Simplify
extends Object
implements Parameter<Simplify.Ordering>

A simple graph has no self-loops (edges where the source and target vertices are the same) and no duplicate edges. Flink stores an undirected graph as a directed graph where each undirected edge is represented by a directed edge in each direction.

This Parameter indicates whether to simplify the graph and if the graph should be directed or undirected.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Simplify.Ordering Whether and how to simplify the graph.

Constructor Summary

Constructors

Constructor and Description
Simplify(ParameterizedBase owner) Add this parameter to the list of parameters stored by owner.

Method Summary

Modifier and Type	Method and Description
void	configure(ParameterTool parameterTool) Read and parse the parameter value from command-line arguments.
String	getShortString()
String	getUsage() An informal usage string.
Simplify.Ordering	getValue() Get the parameter value.
boolean	isHidden() A hidden parameter is parsed from the command-line configuration but is not printed in the usage string.
<T extends Comparable<T>> Graph<T,NullValue,NullValue>	simplify(Graph<T,NullValue,NullValue> graph, int parallelism) Simplify the given graph based on the configured value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Simplify

public Simplify(ParameterizedBase owner)

Add this parameter to the list of parameters stored by owner.

Parameters:

owner - the Parameterized using this Parameter

Method Detail

getUsage

public String getUsage()

Description copied from interface: Parameter

An informal usage string. Parameter names are prefixed with "--".

Optional parameters are enclosed by "[" and "]".

Generic values are represented by all-caps with specific values enclosed by "<" and ">".

Specified by:

getUsage in interface Parameter<Simplify.Ordering>

Returns:

command-line usage string

isHidden

public boolean isHidden()

Description copied from interface: Parameter

A hidden parameter is parsed from the command-line configuration but is not printed in the usage string. This can be used for power-user options not displayed to the general user.

Specified by:

isHidden in interface Parameter<Simplify.Ordering>

Returns:

whether this parameter should be hidden from standard usage

configure

public void configure(ParameterTool parameterTool)

Description copied from interface: Parameter

Read and parse the parameter value from command-line arguments.

Specified by:

configure in interface Parameter<Simplify.Ordering>

Parameters:

parameterTool - parameter parser

getValue

public Simplify.Ordering getValue()

Description copied from interface: Parameter

Get the parameter value.

Specified by:

getValue in interface Parameter<Simplify.Ordering>

Returns:

parameter value

simplify

public <T extends Comparable<T>> Graph<T,NullValue,NullValue> simplify(Graph<T,NullValue,NullValue> graph,
                                                                       int parallelism)
                                                                throws Exception

Simplify the given graph based on the configured value.

Type Parameters:

T - graph key type

Parameters:

graph - input graph

Returns:

output graph

Throws:

Exception - on error

getShortString

public String getShortString()