|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.ExecutionMonitor
public class ExecutionMonitor
This node's execution monitor handles the progress and later also memory management for each node model's execution.
This monitor keeps a NodeProgressMonitor
and forwards the
progress, as well as the cancel request to it.
Constructor Summary | |
---|---|
ExecutionMonitor()
Creates a new execution monitor with an empty default progress monitor. |
|
ExecutionMonitor(NodeProgressMonitor progress)
Creates a new execution monitor with the given progress monitor which can be null . |
Method Summary | |
---|---|
void |
checkCanceled()
|
ExecutionMonitor |
createSilentSubProgress(double maxProg)
Creates an execution monitor with a partial progress range, which ignores any message set. |
(package private) NodeProgressMonitor |
createSilentSubProgressMonitor(double maxProg)
Factory method to create a new silent sub progress monitor. |
ExecutionMonitor |
createSubProgress(double maxProg)
Creates an execution monitor with a partial progress range. |
(package private) NodeProgressMonitor |
createSubProgressMonitor(double maxProg)
Factory method to create a new sub progress monitor. |
NodeProgressMonitor |
getProgressMonitor()
|
(package private) boolean |
isCanceled()
|
void |
setMessage(String message)
|
void |
setProgress(double progress)
|
void |
setProgress(double progress,
String message)
|
void |
setProgress(String message)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ExecutionMonitor()
public ExecutionMonitor(NodeProgressMonitor progress)
null
.
progress
- The progress monitor can be null.Method Detail |
---|
public final NodeProgressMonitor getProgressMonitor()
boolean isCanceled()
true
if the execution has been canceled.NodeProgressMonitor.checkCanceled()
public void checkCanceled() throws CanceledExecutionException
CanceledExecutionException
- which indicated the execution will be
canceled by this call.NodeProgressMonitor.checkCanceled()
public void setProgress(double progress)
progress
- The progress values to set in the monitor.NodeProgressMonitor.setProgress(double)
public void setProgress(double progress, String message)
progress
- The progress values to set in the monitor.message
- The message to be shown in the progress monitor.NodeProgressMonitor.setProgress(double)
public void setMessage(String message)
message
- The message to be shown in the progress monitor.NodeProgressMonitor.setMessage(String)
public void setProgress(String message)
message
- The message to be shown in the progress monitor.NodeProgressMonitor.setProgress(String)
public ExecutionMonitor createSubProgress(double maxProg)
maxProg
- The fraction of the progress this sub progress
contributes to the whole progress
IllegalArgumentException
- If the argument is not in (0, 1].public ExecutionMonitor createSilentSubProgress(double maxProg)
createSubProgress(double)
message in that it
does not report any message but rather ignores any new string message.
maxProg
- The fraction of the progress this sub progress
contributes to the whole progress
IllegalArgumentException
- If the argument is not in (0, 1].NodeProgressMonitor createSubProgressMonitor(double maxProg)
maxProg
- The fraction of the progress this sub progress
contributes to the whole progress
IllegalArgumentException
- If the argument is not in [0, 1].NodeProgressMonitor createSilentSubProgressMonitor(double maxProg)
maxProg
- The fraction of the progress this sub progress
contributes to the whole progress
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |