org.apache.hama.bsp
Class BSPJob

java.lang.Object
  extended by org.apache.hama.bsp.BSPJobContext
      extended by org.apache.hama.bsp.BSPJob

public class BSPJob
extends BSPJobContext

A BSP job configuration. BSPJob is the primary interface for a user to describe a BSP job to the Hama BSP framework for execution.


Nested Class Summary
static class BSPJob.JobState
           
 
Field Summary
 
Fields inherited from class org.apache.hama.bsp.BSPJobContext
conf, INPUT_FORMAT_CLASS_ATTR, OUTPUT_FORMAT_CLASS_ATTR, WORK_CLASS_ATTR, WORKING_DIR
 
Constructor Summary
BSPJob()
           
BSPJob(BSPJobID jobID, java.lang.String jobFile)
           
BSPJob(HamaConfiguration conf)
           
BSPJob(HamaConfiguration conf, java.lang.Class<?> exampleClass)
           
BSPJob(HamaConfiguration conf, int numPeer)
           
BSPJob(HamaConfiguration conf, java.lang.String jobName)
           
 
Method Summary
 void failTask(TaskAttemptID taskId)
           
 java.lang.Class<? extends BSP> getBspClass()
           
 int getNumBspTask()
           
 boolean isComplete()
           
 boolean isSuccessful()
           
 void killJob()
           
 void killTask(TaskAttemptID taskId)
           
 long progress()
           
 void set(java.lang.String name, java.lang.String value)
           
 void setBspClass(java.lang.Class<? extends BSP> cls)
          Set the BSP algorithm class for the job.
 void setInputPath(HamaConfiguration conf, org.apache.hadoop.fs.Path iNPUTPATH)
           
 void setJar(java.lang.String jar)
           
 void setJarByClass(java.lang.Class<?> cls)
           
 void setJobName(java.lang.String name)
           
 void setNumBspTask(int tasks)
           
 void setUser(java.lang.String user)
           
 void setWorkingDirectory(org.apache.hadoop.fs.Path dir)
           
 void submit()
           
 boolean waitForCompletion(boolean verbose)
           
 
Methods inherited from class org.apache.hama.bsp.BSPJobContext
get, getConf, getInt, getJar, getJobID, getJobName, getLocalPath, getUser, getWorkingDirectory, writeXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BSPJob

public BSPJob()
       throws java.io.IOException
Throws:
java.io.IOException

BSPJob

public BSPJob(HamaConfiguration conf)
       throws java.io.IOException
Throws:
java.io.IOException

BSPJob

public BSPJob(HamaConfiguration conf,
              java.lang.String jobName)
       throws java.io.IOException
Throws:
java.io.IOException

BSPJob

public BSPJob(BSPJobID jobID,
              java.lang.String jobFile)
       throws java.io.IOException
Throws:
java.io.IOException

BSPJob

public BSPJob(HamaConfiguration conf,
              java.lang.Class<?> exampleClass)
       throws java.io.IOException
Throws:
java.io.IOException

BSPJob

public BSPJob(HamaConfiguration conf,
              int numPeer)
Method Detail

setWorkingDirectory

public void setWorkingDirectory(org.apache.hadoop.fs.Path dir)
                         throws java.io.IOException
Throws:
java.io.IOException

setBspClass

public void setBspClass(java.lang.Class<? extends BSP> cls)
                 throws java.lang.IllegalStateException
Set the BSP algorithm class for the job.

Parameters:
cls -
Throws:
java.lang.IllegalStateException

getBspClass

public java.lang.Class<? extends BSP> getBspClass()

setJar

public void setJar(java.lang.String jar)

setJarByClass

public void setJarByClass(java.lang.Class<?> cls)

setJobName

public void setJobName(java.lang.String name)
                throws java.lang.IllegalStateException
Throws:
java.lang.IllegalStateException

setInputPath

public void setInputPath(HamaConfiguration conf,
                         org.apache.hadoop.fs.Path iNPUTPATH)

setUser

public void setUser(java.lang.String user)

progress

public long progress()
              throws java.io.IOException
Throws:
java.io.IOException

isComplete

public boolean isComplete()
                   throws java.io.IOException
Throws:
java.io.IOException

isSuccessful

public boolean isSuccessful()
                     throws java.io.IOException
Throws:
java.io.IOException

killJob

public void killJob()
             throws java.io.IOException
Throws:
java.io.IOException

killTask

public void killTask(TaskAttemptID taskId)
              throws java.io.IOException
Throws:
java.io.IOException

failTask

public void failTask(TaskAttemptID taskId)
              throws java.io.IOException
Throws:
java.io.IOException

submit

public void submit()
            throws java.io.IOException,
                   java.lang.InterruptedException
Throws:
java.io.IOException
java.lang.InterruptedException

waitForCompletion

public boolean waitForCompletion(boolean verbose)
                          throws java.io.IOException,
                                 java.lang.InterruptedException,
                                 java.lang.ClassNotFoundException
Throws:
java.io.IOException
java.lang.InterruptedException
java.lang.ClassNotFoundException

set

public void set(java.lang.String name,
                java.lang.String value)

setNumBspTask

public void setNumBspTask(int tasks)

getNumBspTask

public int getNumBspTask()


Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.