Return-Path: X-Original-To: apmail-incubator-hama-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-hama-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 14D624733 for ; Thu, 2 Jun 2011 04:05:09 +0000 (UTC) Received: (qmail 56346 invoked by uid 500); 2 Jun 2011 04:05:09 -0000 Delivered-To: apmail-incubator-hama-commits-archive@incubator.apache.org Received: (qmail 56292 invoked by uid 500); 2 Jun 2011 04:05:08 -0000 Mailing-List: contact hama-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: hama-dev@incubator.apache.org Delivered-To: mailing list hama-commits@incubator.apache.org Received: (qmail 56167 invoked by uid 99); 2 Jun 2011 04:05:00 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 02 Jun 2011 04:05:00 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 02 Jun 2011 04:04:56 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id CD2742388A3B; Thu, 2 Jun 2011 04:04:36 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1130398 [5/30] - in /incubator/hama/site/publish/docs/r0.2.0/api: ./ org/ org/apache/ org/apache/hama/ org/apache/hama/bsp/ org/apache/hama/bsp/class-use/ org/apache/hama/class-use/ org/apache/hama/ipc/ org/apache/hama/ipc/class-use/ org/a... Date: Thu, 02 Jun 2011 04:04:33 -0000 To: hama-commits@incubator.apache.org From: edwardyoon@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110602040436.CD2742388A3B@eris.apache.org> Added: incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJob.html URL: http://svn.apache.org/viewvc/incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJob.html?rev=1130398&view=auto ============================================================================== --- incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJob.html (added) +++ incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJob.html Thu Jun 2 04:04:29 2011 @@ -0,0 +1,793 @@ + + + + + + +BSPJob (Hama 0.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +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 classBSPJob.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, + String jobFile) + +
+           
BSPJob(HamaConfiguration conf) + +
+           
BSPJob(HamaConfiguration conf, + Class<?> exampleClass) + +
+           
BSPJob(HamaConfiguration conf, + int numPeer) + +
+           
BSPJob(HamaConfiguration conf, + String jobName) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidfailTask(TaskAttemptID taskId) + +
+           
+ Class<? extends BSP>getBspClass() + +
+           
+ intgetNumBspTask() + +
+           
+ booleanisComplete() + +
+           
+ booleanisSuccessful() + +
+           
+ voidkillJob() + +
+           
+ voidkillTask(TaskAttemptID taskId) + +
+           
+ longprogress() + +
+           
+ voidset(String name, + String value) + +
+           
+ voidsetBspClass(Class<? extends BSP> cls) + +
+          Set the BSP algorithm class for the job.
+ voidsetInputPath(HamaConfiguration conf, + org.apache.hadoop.fs.Path iNPUTPATH) + +
+           
+ voidsetJar(String jar) + +
+           
+ voidsetJarByClass(Class<?> cls) + +
+           
+ voidsetJobName(String name) + +
+           
+ voidsetNumBspTask(int tasks) + +
+           
+ voidsetUser(String user) + +
+           
+ voidsetWorkingDirectory(org.apache.hadoop.fs.Path dir) + +
+           
+ voidsubmit() + +
+           
+ booleanwaitForCompletion(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 IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+BSPJob

+
+public BSPJob(HamaConfiguration conf)
+       throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+BSPJob

+
+public BSPJob(HamaConfiguration conf,
+              String jobName)
+       throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+BSPJob

+
+public BSPJob(BSPJobID jobID,
+              String jobFile)
+       throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+BSPJob

+
+public BSPJob(HamaConfiguration conf,
+              Class<?> exampleClass)
+       throws IOException
+
+
+ +
Throws: +
IOException
+
+
+ +

+BSPJob

+
+public BSPJob(HamaConfiguration conf,
+              int numPeer)
+
+
+ + + + + + + + +
+Method Detail
+ +

+setWorkingDirectory

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

+setBspClass

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

+

+
Parameters:
cls - +
Throws: +
IllegalStateException
+
+
+
+ +

+getBspClass

+
+public Class<? extends BSP> getBspClass()
+
+
+
+
+
+
+ +

+setJar

+
+public void setJar(String jar)
+
+
+
+
+
+
+ +

+setJarByClass

+
+public void setJarByClass(Class<?> cls)
+
+
+
+
+
+
+ +

+setJobName

+
+public void setJobName(String name)
+                throws IllegalStateException
+
+
+ +
Throws: +
IllegalStateException
+
+
+
+ +

+setInputPath

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

+setUser

+
+public void setUser(String user)
+
+
+
+
+
+
+ +

+progress

+
+public long progress()
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+isComplete

+
+public boolean isComplete()
+                   throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+isSuccessful

+
+public boolean isSuccessful()
+                     throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+killJob

+
+public void killJob()
+             throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+killTask

+
+public void killTask(TaskAttemptID taskId)
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+failTask

+
+public void failTask(TaskAttemptID taskId)
+              throws IOException
+
+
+ +
Throws: +
IOException
+
+
+
+ +

+submit

+
+public void submit()
+            throws IOException,
+                   InterruptedException
+
+
+ +
Throws: +
IOException +
InterruptedException
+
+
+
+ +

+waitForCompletion

+
+public boolean waitForCompletion(boolean verbose)
+                          throws IOException,
+                                 InterruptedException,
+                                 ClassNotFoundException
+
+
+ +
Throws: +
IOException +
InterruptedException +
ClassNotFoundException
+
+
+
+ +

+set

+
+public void set(String name,
+                String value)
+
+
+
+
+
+
+ +

+setNumBspTask

+
+public void setNumBspTask(int tasks)
+
+
+
+
+
+
+ +

+getNumBspTask

+
+public int getNumBspTask()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2011 The Apache Software Foundation + + Added: incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJobClient.TaskStatusFilter.html URL: http://svn.apache.org/viewvc/incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJobClient.TaskStatusFilter.html?rev=1130398&view=auto ============================================================================== --- incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJobClient.TaskStatusFilter.html (added) +++ incubator/hama/site/publish/docs/r0.2.0/api/org/apache/hama/bsp/BSPJobClient.TaskStatusFilter.html Thu Jun 2 04:04:29 2011 @@ -0,0 +1,373 @@ + + + + + + +BSPJobClient.TaskStatusFilter (Hama 0.2.0 API) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.apache.hama.bsp +
+Enum BSPJobClient.TaskStatusFilter

+
+java.lang.Object
+  extended by java.lang.Enum<BSPJobClient.TaskStatusFilter>
+      extended by org.apache.hama.bsp.BSPJobClient.TaskStatusFilter
+
+
+
All Implemented Interfaces:
Serializable, Comparable<BSPJobClient.TaskStatusFilter>
+
+
+
Enclosing class:
BSPJobClient
+
+
+
+
public static enum BSPJobClient.TaskStatusFilter
extends Enum<BSPJobClient.TaskStatusFilter>
+ + +

+

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ALL + +
+           
FAILED + +
+           
KILLED + +
+           
NONE + +
+           
SUCCEEDED + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static BSPJobClient.TaskStatusFiltervalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static BSPJobClient.TaskStatusFilter[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+NONE

+
+public static final BSPJobClient.TaskStatusFilter NONE
+
+
+
+
+
+ +

+KILLED

+
+public static final BSPJobClient.TaskStatusFilter KILLED
+
+
+
+
+
+ +

+FAILED

+
+public static final BSPJobClient.TaskStatusFilter FAILED
+
+
+
+
+
+ +

+SUCCEEDED

+
+public static final BSPJobClient.TaskStatusFilter SUCCEEDED
+
+
+
+
+
+ +

+ALL

+
+public static final BSPJobClient.TaskStatusFilter ALL
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static BSPJobClient.TaskStatusFilter[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (BSPJobClient.TaskStatusFilter c : BSPJobClient.TaskStatusFilter.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static BSPJobClient.TaskStatusFilter valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+Copyright © 2011 The Apache Software Foundation + +