org.knime.core.node.workflow
Class NodeProgress

java.lang.Object
  extended by org.knime.core.node.workflow.NodeProgress

public final class NodeProgress
extends Object

Contained in a NodeProgressEvent which is fired when the progress information has changed, either the progress (value between 0 and 1 or null), or the progress message (could also be null).

Author:
Thomas Gabriel, University of Konstanz

Constructor Summary
NodeProgress(Double progress, String message)
          Create a progress event based on progress value and message.
 
Method Summary
 String getMessage()
          Current progress message or null.
 Double getProgress()
          Current progress value or null.
 boolean hasMessage()
          If the progress message has changed (more correctly is not null).
 boolean hasProgress()
          If the progress value has changed (more correctly is not null).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeProgress

public NodeProgress(Double progress,
                    String message)
Create a progress event based on progress value and message. Both arguments can be null.

Parameters:
progress - The progress value or null.
message - The progress message or null.
Method Detail

hasProgress

public boolean hasProgress()
If the progress value has changed (more correctly is not null).

Returns:
true if the progress value is not null.

getProgress

public Double getProgress()
Current progress value or null.

Returns:
current progress value between 0 and 1, or null.

getMessage

public String getMessage()
Current progress message or null.

Returns:
current progress message or null.

hasMessage

public boolean hasMessage()
If the progress message has changed (more correctly is not null).

Returns:
true if the progress message is not null.


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.