org.apache.uima.ducc.cli
Class DuccJobSubmit

java.lang.Object
  extended by org.apache.uima.ducc.cli.CliBase
      extended by org.apache.uima.ducc.cli.DuccJobSubmit
All Implemented Interfaces:
org.apache.uima.ducc.cli.IUiOptions

public class DuccJobSubmit
extends CliBase

Submit a DUCC job


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.uima.ducc.cli.IUiOptions
org.apache.uima.ducc.cli.IUiOptions.ClasspathOrderParms, org.apache.uima.ducc.cli.IUiOptions.UiOption
 
Field Summary
static org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts
           
 
Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions
help_width
 
Constructor Summary
DuccJobSubmit(ArrayList<String> args)
           
DuccJobSubmit(ArrayList<String> args, IDuccCallback consoleCb)
          This form of the constructor allows the API user to capture messages, rather than directing them to stdout.
DuccJobSubmit(Properties props)
           
DuccJobSubmit(Properties props, IDuccCallback consoleCb)
          This form of the constructor allows the API user to capture messages, rather than directing them to stdout.
DuccJobSubmit(String[] args)
           
DuccJobSubmit(String[] args, IDuccCallback consoleCb)
          This form of the constructor allows the API user to capture messages, rather than directing them to stdout.
 
Method Summary
 boolean execute()
          Execute collects the job parameters, does basic error and correctness checking, and sends the job properties to the DUCC orchestrator for execution.
 int getReturnCode()
          Return appropriate rc when job has completed.
static void main(String[] args)
          Main method, as used by the executable jar or direct java invocation.
 
Methods inherited from class org.apache.uima.ducc.cli.CliBase
getDuccId, isConsoleAttached, makeOptions, setProperty, waitForCompletion
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

opts

public static org.apache.uima.ducc.cli.IUiOptions.UiOption[] opts
Constructor Detail

DuccJobSubmit

public DuccJobSubmit(String[] args)
              throws Exception
Parameters:
args - Array of string arguments as described in the DUCC CLI reference.
Throws:
Exception

DuccJobSubmit

public DuccJobSubmit(ArrayList<String> args)
              throws Exception
Parameters:
args - List of string arguments as described in the DUCC CLI reference.
Throws:
Exception

DuccJobSubmit

public DuccJobSubmit(Properties props)
              throws Exception
Parameters:
props - Properties file of arguments, as described in the DUCC CLI reference.
Throws:
Exception

DuccJobSubmit

public DuccJobSubmit(ArrayList<String> args,
                     IDuccCallback consoleCb)
              throws Exception
This form of the constructor allows the API user to capture messages, rather than directing them to stdout.

Parameters:
args - List of string arguments as described in the DUCC CLI reference.
consoleCb - If provided, messages are directed to it instead of stdout.
Throws:
Exception

DuccJobSubmit

public DuccJobSubmit(String[] args,
                     IDuccCallback consoleCb)
              throws Exception
This form of the constructor allows the API user to capture messages, rather than directing them to stdout.

Parameters:
args - Array of string arguments as described in the DUCC CLI reference.
consoleCb - If provided, messages are directed to it instead of stdout.
Throws:
Exception

DuccJobSubmit

public DuccJobSubmit(Properties props,
                     IDuccCallback consoleCb)
              throws Exception
This form of the constructor allows the API user to capture messages, rather than directing them to stdout.

Parameters:
props - Properties file contianing string arguments as described in the DUCC CLI reference.
consoleCb - If provided, messages are directed to it instead of stdout.
Throws:
Exception
Method Detail

execute

public boolean execute()
                throws Exception
Execute collects the job parameters, does basic error and correctness checking, and sends the job properties to the DUCC orchestrator for execution.

Specified by:
execute in class CliBase
Returns:
True if the orchestrator accepts the job; false otherwise.
Throws:
Exception - The specific exception is a function of the implementor.

getReturnCode

public int getReturnCode()
Return appropriate rc when job has completed.

Overrides:
getReturnCode in class CliBase
Returns:
The exit code from the job.

main

public static void main(String[] args)
Main method, as used by the executable jar or direct java invocation.

Parameters:
args - arguments as described in the DUCC CLI reference.


Copyright © 2012–2014 The Apache Software Foundation. All rights reserved.