org.apache.flink.graph.drivers.parameter

Class ParameterizedBase

java.lang.Object

org.apache.flink.graph.drivers.parameter.ParameterizedBase

All Implemented Interfaces:

Parameterized

Direct Known Subclasses:

DriverBase, GraphKeyTypeTransform, InputBase, OutputBase, Runner

public abstract class ParameterizedBase
extends Object
implements Parameterized

Base class for a Parameterized which maintains a list of parameters used to print the command-line usage string and configure parameters.

Constructor Summary

Constructors

Constructor and Description
ParameterizedBase()

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter<?> parameter) Adds a parameter to the list.
void	configure(ParameterTool parameterTool) Read parameter values from the command-line arguments.
String	getName() A unique, human-readable identifier.
String	getUsage() Human-readable format for the command-line usage string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterizedBase

public ParameterizedBase()

Method Detail

addParameter

public void addParameter(Parameter<?> parameter)

Adds a parameter to the list. Parameter order is preserved when printing the command-line usage string.

Parameters:

parameter - to add to the list of parameters

getName

public String getName()

Description copied from interface: Parameterized

A unique, human-readable identifier. Presented to the user as the name of a selectable choice.

Specified by:

getName in interface Parameterized

Returns:

parameter name

getUsage

public String getUsage()

Description copied from interface: Parameterized

Human-readable format for the command-line usage string.

Specified by:

getUsage in interface Parameterized

Returns:

command-line documentation string

configure

public void configure(ParameterTool parameterTool)
               throws ProgramParametrizationException

Description copied from interface: Parameterized

Read parameter values from the command-line arguments.

Specified by:

configure in interface Parameterized

Parameters:

parameterTool - parameter parser

Throws:

ProgramParametrizationException - when configuration is invalid