it.geosolutions.geobatch.flow.event
Interface IProgressListener

All Superinterfaces:

java.util.EventListener

All Known Subinterfaces:

EventConsumerListener

All Known Implementing Classes:

BaseEventConsumer.EventConsumerListenerForwarder, ProgressListener, ProgressListenerForwarder

public interface IProgressListener
extends java.util.EventListener

Listener interface for monitorable object.

This Listner is designed to have stateful information, such as current task running or current progress percentage, so it should be bound to one object only.

Author:

ETj

Method Summary

void	completed() The process has successfully ended.
void	failed(java.lang.Throwable exception) The process has ended with an error
Identifiable	getOwner()
float	getProgress() Get a progress indicator, between 0.0 and 100.0
java.lang.String	getTask() Get the name of the current task.
void	paused() The process has been paused
void	progressing() The process has just advanced a bit.
void	resumed() The process has been resumed
void	setProgress(float progress) Used by the notifier.
void	setTask(java.lang.String currentTask) Used by the notifier.
void	started() The process has been started
void	terminated() The process has been terminated

Method Detail

started

void started()

The process has been started

progressing

void progressing()

The process has just advanced a bit.

See Also:

getProgress(), getTask()

paused

void paused()

The process has been paused

resumed

void resumed()

The process has been resumed

completed

void completed()

The process has successfully ended.

failed

void failed(java.lang.Throwable exception)

The process has ended with an error

terminated

void terminated()

The process has been terminated

getProgress

float getProgress()

Get a progress indicator, between 0.0 and 100.0

getTask

java.lang.String getTask()

Get the name of the current task.

setProgress

void setProgress(float progress)

Used by the notifier.

setTask

void setTask(java.lang.String currentTask)

Used by the notifier.

getOwner

Identifiable getOwner()

Returns:

the owner of the listener