org.apache.giraph.job

Class GiraphJob

java.lang.Object

org.apache.giraph.job.GiraphJob

public class GiraphJob
extends Object

Generates an appropriate internal Job for using Giraph in Hadoop. Uses composition to avoid unwanted Job methods from exposure to the user.

Constructor Summary

Constructors

Constructor and Description
GiraphJob(org.apache.hadoop.conf.Configuration configuration, String jobName) Constructor.
GiraphJob(GiraphConfiguration giraphConfiguration, String jobName) Constructor.
GiraphJob(String jobName) Constructor that will instantiate the configuration

Method Summary

Modifier and Type	Method and Description
GiraphConfiguration	getConfiguration() Get the configuration from the internal job.
org.apache.hadoop.mapreduce.Job	getInternalJob() Be very cautious when using this method as it returns the internal job of GiraphJob.
String	getJobName()
boolean	run(boolean verbose) Runs the actual graph application through Hadoop Map-Reduce.
void	setJobName(String jobName)

Methods inherited from class java.lang.Object

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

Constructor Detail

GiraphJob

public GiraphJob(String jobName)
          throws IOException

Constructor that will instantiate the configuration

Parameters:

jobName - User-defined job name

Throws:

IOException

GiraphJob

public GiraphJob(org.apache.hadoop.conf.Configuration configuration,
                 String jobName)
          throws IOException

Constructor.

Parameters:

configuration - User-defined configuration

jobName - User-defined job name

Throws:

IOException

GiraphJob

public GiraphJob(GiraphConfiguration giraphConfiguration,
                 String jobName)
          throws IOException

Constructor.

Parameters:

giraphConfiguration - User-defined configuration

jobName - User-defined job name

Throws:

IOException

Method Detail

getJobName

public String getJobName()

setJobName

public void setJobName(String jobName)

getConfiguration

public GiraphConfiguration getConfiguration()

Get the configuration from the internal job.

Returns:

Configuration used by the job.

getInternalJob

public org.apache.hadoop.mapreduce.Job getInternalJob()

Be very cautious when using this method as it returns the internal job of GiraphJob. This should only be used for methods that require access to the actual Job, i.e. FileInputFormat#addInputPath().

Returns:

Internal job that will actually be submitted to Hadoop.

run

public final boolean run(boolean verbose)
                  throws IOException,
                         InterruptedException,
                         ClassNotFoundException

Runs the actual graph application through Hadoop Map-Reduce.

Parameters:

verbose - If true, provide verbose output, false otherwise

Returns:

True if success, false otherwise

Throws:

ClassNotFoundException

InterruptedException

IOException