Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.task;

import java.util.Date;

import org.gvsig.tools.observer.Observer;

public interface SimpleTaskStatus extends TaskStatus {

    public static SimpleTaskStatus FAKE_STATUS = new SimpleTaskStatus() {

        @Override

        public String getTitle() {

            return "";

        }

        @Override

        public void cancel() {

        }

        @Override

        public void setTitle(String title) {

        }

        @Override

        public void setTittle(String tittle) {

        }

        @Override

        public void message(String message) {

        }

        @Override

        public void setRangeOfValues(long min, long max) {

        }

        @Override

        public void setCurValue(long value) {

        }

        @Override

        public void incrementCurrentValue() {

        }

        @Override

        public void terminate() {

        }

        @Override

        public void setCancellable(boolean cancellable) {

        }

        @Override

        public void remove() {

        }

        @Override

        public void abort() {

        }

        @Override

        public void add() {

        }

        @Override

        public void restart() {

        }

        @Override

        public void pop() {

        }

        @Override

        public void setIndeterminate() {

        }

        @Override

        public boolean getAutoRemove() {

            return false;

        }

        @Override

        public void setAutoremove(boolean autoremove) {

        }

        @Override

        public void push() {

        }

        @Override

        public String getCode() {

            return null;

        }

        @Override

        public int getCompleted() {

            return 0;

        }

        @Override

        public String getLabel() {

            return "";

        }

        @Override

        public String getProgressLabel() {

            return "";

        }

        @Override

        public String getMessage() {

            return null;

        }

        @Override

        public boolean isCancelled() {

            return false;

        }

        @Override

        public boolean isAborted() {

            return false;

        }

        @Override

        public boolean isRunning() {

            return false;

        }

        @Override

        public Date getLastModification() {

            return new Date();

        }

        @Override

        public TaskStatusManager getManager() {

            return null;

        }

        @Override

        public boolean isIndeterminate() {

            return true;

        }

        @Override

        public boolean isCancellable() {

            return true;

        }

        @Override

        public boolean isCancellationRequested() {

            return false;

        }

        @Override

        public void cancelRequest() {

        }

        @Override

        public void addObserver(Observer o) {

        }

        @Override

        public void deleteObserver(Observer o) {

        }

        @Override

        public void deleteObservers() {

        }

        @Override

        public long getCurValue() {

            return 0;

        }

    };

    public static SimpleTaskStatus get(SimpleTaskStatus status) {

        if( status==null ) {

            return FAKE_STATUS;

        }

        return status;

    }

    /**

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

     * changed.

     *

     * @param tittle

     *

     * @deprecated @see {@link SimpleTaskStatus#setTitle(String)}

     */

    public void setTittle(String tittle);

    /**

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

     * changed.

     *

     * @param title

     */

    public void setTitle(String title);

    /**

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

     * task

     *

     * @param message

     */

    public void message(String message);

    /**

     * 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.

     *

     * @param min

     * @param max

     */

    public void setRangeOfValues(long min, long max);

    /**

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

     *

     * @param value

     * @see setRangeOfValues

     *

     */

    public void setCurValue(long value);

    public void incrementCurrentValue();

    /**

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

     */

    public void terminate();

    /**

     * Used by the task to inform that it has terminated cancelled by the user

     * or another task.

     */

    public void cancel();

    /**

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

     */

    public void abort();

    /**

     * Remove this TaskStatus from the TaskStatusManager

     */

    public void remove();

    /**

     * Add this TaskStatus to the TaskStatusManager. If TaskStatus already in

     * the manager this is updated.

     */

    public void add();

    /**

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

     *

     * @param cancellable

     */

    public void setCancellable(boolean cancellable);

    /**

     * Used by the task to inform that this TaskStatus is removed from the

     * manager automatically when the task is terminated and the manager need.

     *

     * @param autoremove

     */

    public void setAutoremove(boolean autoremove);

    /**

     * Return the autoremove value of this TaskStatus.

     *

     * @return

     */

    public boolean getAutoRemove();

    /**

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

     * current value.

     */

    public void setIndeterminate();

    /**

     * Este metodo guarda los valores de progreso y el mensaje de la tarea para

     * ser restaurados posteriormente invocando al metodo {@link #pop()}.

     *

     * Los metodos {@link #push()} y {@link #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 {@link #pop()}

     */

    public void push();

    /**

     * Este metodo esta pensado para restaurar los ultimos valores de progreso y

     * mensaje que se guardaron invocando al metodo {@link #push()}.

     *

     * @see {@link #push()}

     */

    public void pop();

    public void restart();

    public long getCurValue();

}