org.hkijena.jipipe.api

Class JIPipeProgressInfo

java.lang.Object

org.hkijena.jipipe.api.JIPipeProgressInfo

All Implemented Interfaces:

org.scijava.Cancelable

Direct Known Subclasses:

JIPipePercentageProgressInfo

public class JIPipeProgressInfo
extends Object
implements org.scijava.Cancelable

This object is available inside a JIPipeRunnable and contains methods to report progress, logs, and request cancellation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeProgressInfo.StatusUpdatedEvent
static class	JIPipeProgressInfo.StatusUpdatedEventEmitter
static interface	JIPipeProgressInfo.StatusUpdatedEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static JIPipeProgressInfo	SILENT
static JIPipeProgressInfo	STDOUT

Constructor Summary

Constructors

Constructor and Description
JIPipeProgressInfo()
JIPipeProgressInfo(JIPipeProgressInfo other)

Method Summary

Modifier and Type	Method and Description
void	addMaxProgress(int maxProgress)
void	addProgress(int progress)
void	cancel()
void	cancel(String reason)
void	clearLog()
JIPipeProgressInfo	detachProgress() Creates a sub-progress that detaches the references to the global process counters.
String	getCancelReason()
StringBuilder	getLog()
String	getLogPrepend()
int	getMaxProgress()
JIPipeNotificationInbox	getNotifications()
int	getProgress()
JIPipeProgressInfo.StatusUpdatedEventEmitter	getStatusUpdatedEventEmitter()
void	incrementProgress()
boolean	isCanceled()
boolean	isCancelled()
boolean	isDetachedProgress() Returns true if the progress was detached from the root progress
boolean	isLogToStdOut()
boolean	isWithSpinner()
void	log(String message) Writes a message into the log
void	log(Throwable e)
JIPipePercentageProgressInfo	percentage(String text)
JIPipeProgressInfo	resolve(String logPrepend) Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages
JIPipeProgressInfo	resolve(String text, int index, int size) Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages.
JIPipeProgressInfo	resolveAndLog(String logPrepend) Applies resolve(logPrepend) and then logs an empty message
JIPipeProgressInfo	resolveAndLog(String text, int index, int size) Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages.
void	resolveAndLogForEach(String text, byte[] collection, BiConsumer<Byte,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
<T> void	resolveAndLogForEach(String text, Collection<T> collection, BiConsumer<T,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	resolveAndLogForEach(String text, double[] collection, BiConsumer<Double,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	resolveAndLogForEach(String text, float[] collection, BiConsumer<Float,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	resolveAndLogForEach(String text, int[] collection, BiConsumer<Integer,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	resolveAndLogForEach(String text, long[] collection, BiConsumer<Long,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	resolveAndLogForEach(String text, short[] collection, BiConsumer<Short,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
<T> void	resolveAndLogForEach(String text, T[] collection, BiConsumer<T,JIPipeProgressInfo> function) Applies a for-each operation where the progress is logged
void	setLogToStdOut(boolean value)
void	setMaxProgress(int maxProgress)
void	setNotifications(JIPipeNotificationInbox notifications)
void	setProgress(int progress)
void	setProgress(int count, int total) Sets the progress and max progress
void	setStatusUpdatedEventEmitter(JIPipeProgressInfo.StatusUpdatedEventEmitter statusUpdatedEventEmitter)
void	setWithSpinner(boolean b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SILENT

public static final JIPipeProgressInfo SILENT

STDOUT

public static final JIPipeProgressInfo STDOUT

Constructor Detail

JIPipeProgressInfo

public JIPipeProgressInfo()

JIPipeProgressInfo

public JIPipeProgressInfo(JIPipeProgressInfo other)

Method Detail

clearLog

public void clearLog()

incrementProgress

public void incrementProgress()

getLogPrepend

public String getLogPrepend()

getStatusUpdatedEventEmitter

public JIPipeProgressInfo.StatusUpdatedEventEmitter getStatusUpdatedEventEmitter()

setStatusUpdatedEventEmitter

public void setStatusUpdatedEventEmitter(JIPipeProgressInfo.StatusUpdatedEventEmitter statusUpdatedEventEmitter)

getProgress

public int getProgress()

setProgress

public void setProgress(int progress)

getMaxProgress

public int getMaxProgress()

setMaxProgress

public void setMaxProgress(int maxProgress)

isCancelled

public boolean isCancelled()

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface org.scijava.Cancelable

cancel

public void cancel(String reason)

Specified by:

cancel in interface org.scijava.Cancelable

getCancelReason

public String getCancelReason()

Specified by:

getCancelReason in interface org.scijava.Cancelable

cancel

public void cancel()

getLog

public StringBuilder getLog()

isLogToStdOut

public boolean isLogToStdOut()

setLogToStdOut

public void setLogToStdOut(boolean value)

isWithSpinner

public boolean isWithSpinner()

setWithSpinner

public void setWithSpinner(boolean b)

getNotifications

public JIPipeNotificationInbox getNotifications()

setNotifications

public void setNotifications(JIPipeNotificationInbox notifications)

log

public void log(String message)

Writes a message into the log

Parameters:

message - the message

isDetachedProgress

public boolean isDetachedProgress()

Returns true if the progress was detached from the root progress

Returns:

if the progress was detached

detachProgress

public JIPipeProgressInfo detachProgress()

Creates a sub-progress that detaches the references to the global process counters.

Returns:

progress info with the same properties as the current one, but with a detached progress

resolve

public JIPipeProgressInfo resolve(String logPrepend)

Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages

Parameters:

logPrepend - the category

Returns:

progress info with the same properties as the current one, but with messages prepended

resolve

public JIPipeProgressInfo resolve(String text,
                                  int index,
                                  int size)

Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages. This is a shortcut for resolve(text + " " + (index + 1) + "/" + size)

Parameters:

text - the category

index - index of the index operation

size - size of the index operation

Returns:

progress info with the same properties as the current one, but with messages prepended

resolveAndLog

public JIPipeProgressInfo resolveAndLog(String logPrepend)

Applies resolve(logPrepend) and then logs an empty message

Parameters:

logPrepend - the category

Returns:

progress info with the same properties as the current one, but with messages prepended

resolveAndLog

public JIPipeProgressInfo resolveAndLog(String text,
                                        int index,
                                        int size)

Creates a sub-progress that has the same cancellation and progress, but shows the new category in front of sub-messages. Shortcut for resolveAndLog(text + " " + (index + 1) + "/" + size)

Parameters:

text - the category

index - index of the index operation

size - size of the index operation

Returns:

progress info with the same properties as the current one, but with messages prepended

resolveAndLogForEach

public <T> void resolveAndLogForEach(String text,
                                     Collection<T> collection,
                                     BiConsumer<T,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Type Parameters:

T - collection contents

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public <T> void resolveAndLogForEach(String text,
                                     T[] collection,
                                     BiConsumer<T,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Type Parameters:

T - collection contents

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 int[] collection,
                                 BiConsumer<Integer,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 byte[] collection,
                                 BiConsumer<Byte,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 long[] collection,
                                 BiConsumer<Long,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 short[] collection,
                                 BiConsumer<Short,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 float[] collection,
                                 BiConsumer<Float,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

resolveAndLogForEach

public void resolveAndLogForEach(String text,
                                 double[] collection,
                                 BiConsumer<Double,JIPipeProgressInfo> function)

Applies a for-each operation where the progress is logged

Parameters:

text - the text

collection - the iterated collection

function - the function executed for each item in the collection

setProgress

public void setProgress(int count,
                        int total)

Sets the progress and max progress

Parameters:

count - the progress

total - the max progress

addMaxProgress

public void addMaxProgress(int maxProgress)

addProgress

public void addProgress(int progress)

percentage

public JIPipePercentageProgressInfo percentage(String text)

log

public void log(Throwable e)