org.apache.flink.graph.drivers.parameter

Interface Parameterized

All Known Subinterfaces:

Driver<K,VV,EV>, Input<K,VV,EV>, Output<T>, Transform<II,IO,RI,RO>

All Known Implementing Classes:

AdamicAdar, CirculantGraph, ClusteringCoefficient, CompleteGraph, ConnectedComponents, CSV, CSV, CycleGraph, DriverBase, EchoGraph, EdgeList, EmptyGraph, GeneratedGraph, GeneratedMultiGraph, GraphKeyTypeTransform, GraphMetrics, GridGraph, Hash, HITS, HypercubeGraph, InputBase, JaccardIndex, OutputBase, PageRank, ParameterizedBase, PathGraph, Print, RMatGraph, Runner, SingletonEdgeGraph, StarGraph, TriangleListing

public interface Parameterized

A configurable command-line choice, such as an input or algorithm.

Method Summary

Modifier and Type	Method and Description
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.

Method Detail

getName

String getName()

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

Returns:

parameter name

getUsage

String getUsage()

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

Returns:

command-line documentation string

configure

void configure(ParameterTool parameterTool)
        throws ProgramParametrizationException

Read parameter values from the command-line arguments.

Parameters:

parameterTool - parameter parser

Throws:

ProgramParametrizationException - when configuration is invalid