|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.task.AbstractMonitor
Defines common behavior for classes that implement Monitor.
This base class lets a task record several types of information:
Field Summary | |
protected boolean |
_monitorError
|
protected boolean |
_monitorInfo
|
protected boolean |
_monitorProgress
|
protected boolean |
_monitorWarning
|
protected boolean |
_trace
Debug flag |
static java.lang.String |
code_id
|
protected static WSTrace |
trace
|
Constructor Summary | |
AbstractMonitor()
|
Method Summary | |
boolean |
checkBreak()
|
protected static java.lang.String |
formatData(PersistentObject po,
java.lang.String actionTaken)
|
java.lang.Object |
getProperty(java.lang.String name)
|
void |
monitorDeath(java.lang.Throwable throes)
A task must signal a fatal exception. |
void |
monitorDone(WavesetResult res)
A task must signal completion by returning its result. |
void |
monitorErrorData(PersistentObject po)
|
void |
monitorErrorData(PersistentObject po,
java.lang.String actionTaken)
|
void |
monitorErrorData(java.lang.String s)
|
void |
monitorErrorMsg(Message msg)
|
void |
monitorErrorMsg(java.lang.String msg)
|
void |
monitorErrorMsg(java.lang.Throwable e)
|
void |
monitorInputData(PersistentObject po)
|
void |
monitorInputData(PersistentObject po,
java.lang.String actionTaken)
|
void |
monitorInputData(java.lang.String s)
|
protected void |
monitorMessage(Message msg)
|
protected void |
monitorMessage(java.lang.Object msg,
Severity severity)
|
void |
monitorOutputData(PersistentObject po)
|
void |
monitorOutputData(PersistentObject po,
java.lang.String actionTaken)
|
void |
monitorOutputData(java.lang.String s)
|
void |
monitorOutputMsg(Message msg)
|
void |
monitorOutputMsg(java.lang.String msg)
|
void |
monitorProgress(java.lang.String s)
A task reports (terse) progress such as "Extracted 127 of 129 accounts read.". |
void |
monitorWarningMsg(Message msg)
|
void |
monitorWarningMsg(java.lang.String msg)
|
void |
monitorWarningMsg(java.lang.Throwable e)
|
protected static void |
println(java.lang.Object o)
Ubiquitous macro. |
void |
setMonitorProgress(boolean b)
|
void |
setMonitorSeverity(Severity severity)
Specify the threshold for monitoring. |
void |
setProperty(java.lang.String name,
java.lang.Object value)
|
void |
setTrace(boolean b)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
protected static WSTrace trace
protected boolean _trace
protected boolean _monitorProgress
protected boolean _monitorError
protected boolean _monitorWarning
protected boolean _monitorInfo
Constructor Detail |
public AbstractMonitor()
Method Detail |
public void setTrace(boolean b)
public void monitorInputData(java.lang.String s)
monitorInputData
in interface Monitor
public void monitorOutputData(java.lang.String s)
monitorOutputData
in interface Monitor
public void monitorErrorData(java.lang.String s)
monitorErrorData
in interface Monitor
protected void monitorMessage(Message msg)
public void monitorProgress(java.lang.String s)
monitorProgress
in interface Monitor
public void monitorDone(WavesetResult res)
Monitor
monitorDone
in interface Monitor
public void monitorDeath(java.lang.Throwable throes)
Monitor
This allows the monitor to free any resources, as well as to report the untimely death of the subject task in a standard way.
monitorDeath
in interface Monitor
public boolean checkBreak()
checkBreak
in interface Monitor
public void setMonitorProgress(boolean b)
setMonitorProgress
in interface Monitor
public void setMonitorSeverity(Severity severity)
Monitor
If the threshold is null
Severity.OK
(the default), then everything will be monitored.
Setting the threshold to Severity.WARNING
will suppress informational messages.
Setting the threshold to Severity.ERROR
will suppress both informational and warning messages.
Setting the threshold to null
suppresses
all of informational, warning, and non-fatal error messages.
NOTE: This threshold does not affect the behavior of monitorDone, monitorDeath, checkBreak, or monitorProgress.
setMonitorSeverity
in interface Monitor
public void monitorInputData(PersistentObject po)
monitorInputData
in interface Monitor
public void monitorInputData(PersistentObject po, java.lang.String actionTaken)
monitorInputData
in interface Monitor
public void monitorOutputData(PersistentObject po)
monitorOutputData
in interface Monitor
public void monitorOutputData(PersistentObject po, java.lang.String actionTaken)
monitorOutputData
in interface Monitor
public void monitorOutputMsg(Message msg)
monitorOutputMsg
in interface Monitor
public void monitorOutputMsg(java.lang.String msg)
monitorOutputMsg
in interface Monitor
public void monitorErrorData(PersistentObject po)
monitorErrorData
in interface Monitor
public void monitorErrorData(PersistentObject po, java.lang.String actionTaken)
monitorErrorData
in interface Monitor
public void monitorWarningMsg(Message msg)
monitorWarningMsg
in interface Monitor
public void monitorWarningMsg(java.lang.Throwable e)
monitorWarningMsg
in interface Monitor
public void monitorWarningMsg(java.lang.String msg)
monitorWarningMsg
in interface Monitor
public void monitorErrorMsg(Message msg)
monitorErrorMsg
in interface Monitor
public void monitorErrorMsg(java.lang.Throwable e)
monitorErrorMsg
in interface Monitor
public void monitorErrorMsg(java.lang.String msg)
monitorErrorMsg
in interface Monitor
public void setProperty(java.lang.String name, java.lang.Object value)
setProperty
in interface Monitor
public java.lang.Object getProperty(java.lang.String name)
getProperty
in interface Monitor
protected void monitorMessage(java.lang.Object msg, Severity severity)
protected static java.lang.String formatData(PersistentObject po, java.lang.String actionTaken)
protected static void println(java.lang.Object o)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |