|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.uima.ducc.cli.CliBase
public abstract class CliBase
Define common methods and data used by all the DUCC API and CLI.
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 |
---|
Fields inherited from interface org.apache.uima.ducc.cli.IUiOptions |
---|
help_width |
Constructor Summary | |
---|---|
CliBase()
|
Method Summary | |
---|---|
abstract boolean |
execute()
All extenders must implement execute - this method does whatever processing on the input is needed and passes the CLI request to the internal DUCC processes. |
long |
getDuccId()
This returns the unique numeric id for the requested work. |
int |
getReturnCode()
This returns the return code from the execution of the requested work. |
boolean |
isConsoleAttached()
This is used to find if the remote console is redirected to the local process, and if so, is it still active. |
static org.apache.commons.cli.Options |
makeOptions(org.apache.uima.ducc.cli.IUiOptions.UiOption[] optlist)
|
boolean |
setProperty(String key,
String value)
Set a property via the API. |
boolean |
waitForCompletion()
Wait for the listeners - maybe a console listener, maybe a job listener, maybe both. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CliBase()
Method Detail |
---|
public abstract boolean execute() throws Exception
Exception
- The specific exception is a function of the implementor.public static org.apache.commons.cli.Options makeOptions(org.apache.uima.ducc.cli.IUiOptions.UiOption[] optlist)
public boolean setProperty(String key, String value)
key
- This is the property name.value
- This is the value of the property.
public int getReturnCode()
public long getDuccId()
public boolean isConsoleAttached()
public boolean waitForCompletion()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |