blob: b5eee462c99c57465630dc05249ff02a67ad0ce4 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
package de.lmu.ifi.dbs.elki.logging.progress;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2011
Ludwig-Maximilians-Universität München
Lehr- und Forschungseinheit für Datenbanksysteme
ELKI Development Team
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import de.lmu.ifi.dbs.elki.logging.Logging;
/**
* This progress class is used for multi-step processing.
*
* @author Erich Schubert
*/
public class StepProgress extends FiniteProgress {
/**
* Title of the current step.
*/
String stepTitle = "";
/**
* Constructor.
* This constructor does not use a logger; initial logging will happen on the first beginStep call.
*
* @param total Total number of steps.
*/
@SuppressWarnings("deprecation")
public StepProgress(int total) {
super("Step", total);
}
/**
* Constructor.
* This constructor does not use a logger; initial logging will happen on the first beginStep call.
*
* @param task Task title
* @param total Total number of steps.
*/
@SuppressWarnings("deprecation")
public StepProgress(String task, int total) {
super(task, total);
}
// No constructor with auto logging - call beginStep() first
@Override
public StringBuffer appendToBuffer(StringBuffer buf) {
buf.append(super.getTask());
if (isComplete()) {
buf.append(": complete.");
} else {
buf.append(" #").append(getProcessed()+1).append("/").append(getTotal());
buf.append(": ").append(getStepTitle());
}
buf.append("\n");
return buf;
}
/**
* Do a new step.
*
* @param step Step number
* @param stepTitle Step title
*/
@Deprecated
public void beginStep(int step, String stepTitle) {
setProcessed(step - 1);
this.stepTitle = stepTitle;
}
/**
* Do a new step and log it
*
* @param step Step number
* @param stepTitle Step title
* @param logger Logger to report to.
*/
public void beginStep(int step, String stepTitle, Logging logger) {
setProcessed(step - 1);
this.stepTitle = stepTitle;
logger.progress(this);
}
/**
* Mark the progress as completed.
*/
@Deprecated
public void setCompleted() {
setProcessed(getTotal());
}
/**
* Mark the progress as completed and log it.
*
* @param logger Logger to report to.
*/
public void setCompleted(Logging logger) {
setProcessed(getTotal());
logger.progress(this);
}
/**
* @return the stepTitle
*/
protected String getStepTitle() {
return stepTitle;
}
}
|
