org.gvsig.tools.task

Interface SimpleTaskStatus

All Superinterfaces:

CancellableTask, Observable, TaskStatus

All Known Implementing Classes:

BaseTaskStatus, DefaultFLyrRaster.RasterTaskStatus, SimpleTaskStatusDelegated

public interface SimpleTaskStatus
extends TaskStatus

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleTaskStatus	FAKE_STATUS

Method Summary

Modifier and Type	Method and Description
void	abort() Used by the task to inform that it has terminated with errors.
static void	abort(SimpleTaskStatus status)
void	add() Add this TaskStatus to the TaskStatusManager.
void	cancel() Used by the task to inform that it has terminated cancelled by the user or another task.
static void	cancel(SimpleTaskStatus status)
static SimpleTaskStatus	get(SimpleTaskStatus status)
boolean	getAutoRemove() Return the autoremove value of this TaskStatus.
long	getCurValue()
void	incrementCurrentValue()
static void	incrementCurrentValue(SimpleTaskStatus status)
static boolean	isCancellationRequested(SimpleTaskStatus status)
static void	message(SimpleTaskStatus status, java.lang.String message)
void	message(java.lang.String message) Used by the task to set a message associated to the current action of the task
void	pop() Este metodo esta pensado para restaurar los ultimos valores de progreso y mensaje que se guardaron invocando al metodo push().
static void	pop(SimpleTaskStatus status)
void	push() Este metodo guarda los valores de progreso y el mensaje de la tarea para ser restaurados posteriormente invocando al metodo pop().
static void	push(SimpleTaskStatus status)
void	remove() Remove this TaskStatus from the TaskStatusManager
void	restart()
void	setAutoremove(boolean autoremove) Used by the task to inform that this TaskStatus is removed from the manager automatically when the task is terminated and the manager need.
void	setCancellable(boolean cancellable) Used by the task to inform that this task es cacellable.
void	setCurValue(long value) Used by the task to set the current step of the task.
static void	setCurValue(SimpleTaskStatus status, long value)
void	setIndeterminate() Set the estatus of task to inteterminate.
static void	setIndeterminate(SimpleTaskStatus status)
void	setRangeOfValues(long min, long max) Used by the task to set the value for min and max steps of the task.
static void	setRangeOfValues(SimpleTaskStatus status, long min, long max)
void	setTitle(java.lang.String title) Used by the task to set the title associated to the task.
void	setTittle(java.lang.String tittle) Deprecated. @see setTitle(String)
void	terminate() Used by the task to inform that it has terminated without errors.
static void	terminate(SimpleTaskStatus status)

Methods inherited from interface org.gvsig.tools.task.TaskStatus

getCode, getCompleted, getLabel, getLastModification, getManager, getMessage, getProgressLabel, getTitle, isAborted, isCancellable, isCancelled, isIndeterminate, isRunning

Methods inherited from interface org.gvsig.tools.task.CancellableTask

cancelRequest, isCancellationRequested

Methods inherited from interface org.gvsig.tools.observer.Observable

addObserver, deleteObserver, deleteObservers

Field Detail

FAKE_STATUS

static final SimpleTaskStatus FAKE_STATUS

Method Detail

cancel

static void cancel(SimpleTaskStatus status)

message

static void message(SimpleTaskStatus status,
                    java.lang.String message)

setRangeOfValues

static void setRangeOfValues(SimpleTaskStatus status,
                             long min,
                             long max)

setCurValue

static void setCurValue(SimpleTaskStatus status,
                        long value)

incrementCurrentValue

static void incrementCurrentValue(SimpleTaskStatus status)

terminate

static void terminate(SimpleTaskStatus status)

abort

static void abort(SimpleTaskStatus status)

pop

static void pop(SimpleTaskStatus status)

setIndeterminate

static void setIndeterminate(SimpleTaskStatus status)

push

static void push(SimpleTaskStatus status)

isCancellationRequested

static boolean isCancellationRequested(SimpleTaskStatus status)

get

static SimpleTaskStatus get(SimpleTaskStatus status)

setTittle

void setTittle(java.lang.String tittle)

Deprecated. @see setTitle(String)

Used by the task to set the title associated to the task. It can't be changed.

Parameters:

tittle -

setTitle

void setTitle(java.lang.String title)

Used by the task to set the title associated to the task. It can't be changed.

Parameters:

title -

message

void message(java.lang.String message)

Used by the task to set a message associated to the current action of the task

Parameters:

message -

setRangeOfValues

void setRangeOfValues(long min,
                      long max)

Used by the task to set the value for min and max steps of the task. These are used with the "curvalue" to calculate the percentage of completion.

Parameters:

min -

max -

setCurValue

void setCurValue(long value)

Used by the task to set the current step of the task.

Parameters:

value -

See Also:

setRangeOfValues

incrementCurrentValue

void incrementCurrentValue()

terminate

void terminate()

Used by the task to inform that it has terminated without errors.

cancel

void cancel()

Used by the task to inform that it has terminated cancelled by the user or another task.

abort

void abort()

Used by the task to inform that it has terminated with errors.

remove

void remove()

Remove this TaskStatus from the TaskStatusManager

add

void add()

Add this TaskStatus to the TaskStatusManager. If TaskStatus already in the manager this is updated.

setCancellable

void setCancellable(boolean cancellable)

Used by the task to inform that this task es cacellable.

Parameters:

cancellable -

setAutoremove

void setAutoremove(boolean autoremove)

Used by the task to inform that this TaskStatus is removed from the manager automatically when the task is terminated and the manager need.

Parameters:

autoremove -

getAutoRemove

boolean getAutoRemove()

Return the autoremove value of this TaskStatus.

Returns:

setIndeterminate

void setIndeterminate()

Set the estatus of task to inteterminate. Reset values of range and current value.

push

void push()

Este metodo guarda los valores de progreso y el mensaje de la tarea para ser restaurados posteriormente invocando al metodo pop(). Los metodos push() y pop() estan pensado para gestionar subtareas dentro de un tareas, de forma que las subtareas puedan tener su propio progreso y mensaje mientras se estan ejecutando.

See Also:

#pop()}

pop

void pop()

Este metodo esta pensado para restaurar los ultimos valores de progreso y mensaje que se guardaron invocando al metodo push().

See Also:

#push()}

restart

void restart()

getCurValue

long getCurValue()