01: /*
02: * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI
03: * for visualizing and manipulating spatial features with geometry and attributes.
04: *
05: * Copyright (C) 2003 Vivid Solutions
06: *
07: * This program is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU General Public License
09: * as published by the Free Software Foundation; either version 2
10: * of the License, or (at your option) any later version.
11: *
12: * This program is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License
18: * along with this program; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20: *
21: * For more information, contact:
22: *
23: * Vivid Solutions
24: * Suite #1A
25: * 2328 Government Street
26: * Victoria BC V8T 5G5
27: * Canada
28: *
29: * (250)385-6040
30: * www.vividsolutions.com
31: */
32:
33: package com.vividsolutions.jump.task;
34:
35: /**
36: * Provides a simple interface between an operation (or "task") and the
37: * application in which it executes. Enables the task to report its progress,
38: * and to check whether the application has requested that it be cancelled.
39: */
40: public interface TaskMonitor {
41: /**
42: * Describes the status of the task.
43: * @param description a description of the progress of the overall task
44: */
45: public void report(String description);
46:
47: /**
48: * Reports the number of items processed.
49: * @param itemsDone the number of items that have been processed
50: * @param totalItems the total number of items being processed, or -1 if the
51: * total number is not known
52: * @param itemDescription a one-word description of the items, such as "features"
53: */
54: public void report(int itemsDone, int totalItems,
55: String itemDescription);
56:
57: /**
58: * Reports an Exception that occurred. The task may choose to carry on.
59: * @param exception an Exception that occurred during the execution of the task.
60: */
61: public void report(Exception exception);
62:
63: /**
64: * Notifies parties that the task will accept requests for cancellation
65: * (though the task is not obligated to cancel immediately, or at all
66: * for that matter).
67: */
68: public void allowCancellationRequests();
69:
70: /**
71: * Checks whether a party has requested that the task be cancelled. However,
72: * the task is not obligated to cancel immediately (or at all).
73: * @return whether a party has requested that the task be cancelled
74: */
75: public boolean isCancelRequested();
76: }
|