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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
package de.lmu.ifi.dbs.elki.logging;
/*
This file is part of ELKI:
Environment for Developing KDD-Applications Supported by Index-Structures
Copyright (C) 2015
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 java.io.OutputStream;
import java.io.Writer;
import java.util.Collection;
import java.util.logging.ErrorManager;
import java.util.logging.Formatter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.LogRecord;
import de.lmu.ifi.dbs.elki.logging.progress.Progress;
import de.lmu.ifi.dbs.elki.logging.progress.ProgressLogRecord;
import de.lmu.ifi.dbs.elki.logging.progress.ProgressTracker;
/**
* Handler that handles output to the console with clever formatting.
*
* @author Erich Schubert
* @since 0.2
*
* @apiviz.composedOf ProgressTracker
* @apiviz.uses LogRecord oneway - - processes
* @apiviz.has Formatter
* @apiviz.has OutputStreamLogger
*/
public class CLISmartHandler extends Handler {
/**
* Output stream for non-critical output.
*/
private Writer out;
/**
* Output stream for error output.
*/
private Writer err;
/**
* Formatter for regular messages (informational records)
*/
private Formatter msgformat = new MessageFormatter();
/**
* Formatter for debugging messages
*/
private Formatter debugformat = new ErrorFormatter();
/**
* Formatter for error messages
*/
private Formatter errformat = new ErrorFormatter();
/**
* Tracker for progress messages
*/
private ProgressTracker ptrack = new ProgressTracker();
/**
* Constructor
*
* @param out Regular output stream
* @param err Error output stream
*/
public CLISmartHandler(final OutputStream out, final OutputStream err) {
super();
this.out = new OutputStreamLogger(out);
this.err = new OutputStreamLogger(err);
}
/**
* Default constructor using {@link System#out} and {@link System#err}
*/
public CLISmartHandler() {
this(System.out, System.err);
}
/**
* Close output streams.
*/
@Override
public void close() throws SecurityException {
// we have wrapped the output streams in OutputStreamLogger anyway
// which will ignore any close() call.
}
/**
* Flush output streams
*/
@Override
public void flush() {
try {
out.flush();
}
catch(Exception ex) {
reportError(null, ex, ErrorManager.FLUSH_FAILURE);
}
try {
err.flush();
}
catch(Exception ex) {
reportError(null, ex, ErrorManager.FLUSH_FAILURE);
}
}
/**
* Publish a log record.
*/
@Override
public void publish(final LogRecord record) {
// determine destination
final Writer destination;
if(record.getLevel().intValue() >= Level.WARNING.intValue()) {
destination = this.err;
}
else {
destination = this.out;
}
// format
final String m;
// Progress records are handled specially.
if(record instanceof ProgressLogRecord) {
ProgressLogRecord prec = (ProgressLogRecord) record;
ptrack.addProgress(prec.getProgress());
Collection<Progress> completed = ptrack.removeCompleted();
Collection<Progress> progresses = ptrack.getProgresses();
StringBuilder buf = new StringBuilder();
if(completed.size() > 0) {
buf.append(OutputStreamLogger.CARRIAGE_RETURN);
for(Progress prog : completed) {
// TODO: use formatter, somehow?
prog.appendToBuffer(buf);
buf.append(OutputStreamLogger.NEWLINE);
}
}
if(progresses.size() > 0) {
boolean first = true;
buf.append(OutputStreamLogger.CARRIAGE_RETURN);
for(Progress prog : progresses) {
if(first) {
first = false;
}
else {
buf.append(' ');
}
// TODO: use formatter, somehow?
prog.appendToBuffer(buf);
}
}
m = buf.toString();
}
else {
// choose an appropriate formatter
final Formatter fmt;
// always format progress messages using the progress formatter.
if(record.getLevel().intValue() >= Level.WARNING.intValue()) {
// format errors using the error formatter
fmt = errformat;
}
else if(record.getLevel().intValue() <= Level.FINE.intValue()) {
// format debug statements using the debug formatter.
fmt = debugformat;
}
else {
// default to the message formatter.
fmt = msgformat;
}
try {
m = fmt.format(record);
}
catch(Exception ex) {
reportError(null, ex, ErrorManager.FORMAT_FAILURE);
return;
}
}
// write
try {
destination.write(m);
// always flush (although the streams should auto-flush already)
destination.flush();
}
catch(Exception ex) {
reportError(null, ex, ErrorManager.WRITE_FAILURE);
return;
}
}
}
|
