org.apache.giraph.utils

Class ConfigurationUtils

java.lang.Object

org.apache.giraph.utils.ConfigurationUtils

public final class ConfigurationUtils
extends Object

Translate command line args into Configuration Key-Value pairs.

Method Summary

Modifier and Type	Method and Description
static void	addOption(String opt, String longOpt, boolean hasArg, String description) Callers can place additional options to be parsed and stored in our job's GiraphConfiguration via this utility call.
static void	configureIfPossible(Object object, ImmutableClassesGiraphConfiguration configuration) Configure an object with an ImmutableClassesGiraphConfiguration if that objects supports it.
static Class<? extends TypesHolder>	getTypesHolderClass(org.apache.hadoop.conf.Configuration conf) Get a class which is parameterized by the graph types defined by user.
static org.apache.commons.cli.CommandLine	parseArgs(GiraphConfiguration giraphConf, String[] args) Translate CLI arguments to GiraphRunner or 'bin/hadoop jar' into Configuration Key-Value pairs.

Methods inherited from class java.lang.Object

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

Method Detail

configureIfPossible

public static void configureIfPossible(Object object,
                                       ImmutableClassesGiraphConfiguration configuration)

Configure an object with an ImmutableClassesGiraphConfiguration if that objects supports it.

Parameters:

object - The object to configure

configuration - The configuration

getTypesHolderClass

public static Class<? extends TypesHolder> getTypesHolderClass(org.apache.hadoop.conf.Configuration conf)

Get a class which is parameterized by the graph types defined by user. The types holder is actually an interface that any class which holds all of Giraph types can implement. It is used with reflection to infer the Giraph types. The current order of type holders we try are: 1) The TypesHolder class directly. 2) The Computation class, as that holds all the types.

Parameters:

conf - Configuration

Returns:

TypesHolder or null if could not find one.

parseArgs

public static org.apache.commons.cli.CommandLine parseArgs(GiraphConfiguration giraphConf,
                                                           String[] args)
                                                    throws ClassNotFoundException,
                                                           org.apache.commons.cli.ParseException,
                                                           IOException

Translate CLI arguments to GiraphRunner or 'bin/hadoop jar' into Configuration Key-Value pairs.

Parameters:

giraphConf - the current job Configuration.

args - the raw CLI args to parse

Returns:

a CommandLine object, or null if the job run should exit.

Throws:

ClassNotFoundException

org.apache.commons.cli.ParseException

IOException

addOption

public static void addOption(String opt,
                             String longOpt,
                             boolean hasArg,
                             String description)

Callers can place additional options to be parsed and stored in our job's GiraphConfiguration via this utility call. These options will ONLY be parsed and placed into the CommandLine returned from parseArgs Calling code must query this CommandLine to take action on these options.

Parameters:

opt - short options name, i.e. -h

longOpt - long option name, i.e. --help

hasArg - should we expect an argument for this option?

description - English description of this option.