author | František Kučera <franta-hg@frantovo.cz> |
Thu, 24 Oct 2019 21:43:08 +0200 | |
branch | v_0 |
changeset 250 | aae5009bd0af |
parent 238 | 4a1864c3e867 |
permissions | -rw-r--r-- |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
1 |
/** |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
2 |
* SQL-DK |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
3 |
* Copyright © 2015 František Kučera (frantovo.cz) |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
4 |
* |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
5 |
* This program is free software: you can redistribute it and/or modify |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
6 |
* it under the terms of the GNU General Public License as published by |
250
aae5009bd0af
fix license version: GNU GPLv3
František Kučera <franta-hg@frantovo.cz>
parents:
238
diff
changeset
|
7 |
* the Free Software Foundation, version 3 of the License. |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
8 |
* |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
9 |
* This program is distributed in the hope that it will be useful, |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
12 |
* GNU General Public License for more details. |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
13 |
* |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
14 |
* You should have received a copy of the GNU General Public License |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
15 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
16 |
*/ |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
17 |
package info.globalcode.sql.dk.formatting; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
18 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
19 |
import info.globalcode.sql.dk.Functions; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
20 |
import info.globalcode.sql.dk.configuration.PropertyDeclaration; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
21 |
import info.globalcode.sql.dk.logging.LoggerProducer; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
22 |
import java.math.BigDecimal; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
23 |
import java.math.MathContext; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
24 |
import java.math.RoundingMode; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
25 |
import java.util.List; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
26 |
import java.util.logging.Level; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
27 |
import java.util.logging.Logger; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
28 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
29 |
/** |
228
3787c999d12c
BarChartFormatter: TODO comments
František Kučera <franta-hg@frantovo.cz>
parents:
226
diff
changeset
|
30 |
* TODO: min/max values – range for case that no value is 100 % |
3787c999d12c
BarChartFormatter: TODO comments
František Kučera <franta-hg@frantovo.cz>
parents:
226
diff
changeset
|
31 |
* |
3787c999d12c
BarChartFormatter: TODO comments
František Kučera <franta-hg@frantovo.cz>
parents:
226
diff
changeset
|
32 |
* TODO: multiple barcharts in same table (last column is still default) + multiple resultsets |
3787c999d12c
BarChartFormatter: TODO comments
František Kučera <franta-hg@frantovo.cz>
parents:
226
diff
changeset
|
33 |
* |
3787c999d12c
BarChartFormatter: TODO comments
František Kučera <franta-hg@frantovo.cz>
parents:
226
diff
changeset
|
34 |
* TODO: negative values - bar starting from the middle, not always from the left |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
35 |
* |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
36 |
* @author Ing. František Kučera (frantovo.cz) |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
37 |
*/ |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
38 |
@PropertyDeclaration(name = BarChartFormatter.PROPERTY_PRECISION, type = Integer.class, defaultValue = BarChartFormatter.PROPERTY_PRECISION_DEFAULT, description = "number of characters representing 100 % in the bar chart") |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
39 |
public class BarChartFormatter extends TabularPrefetchingFormatter { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
40 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
41 |
public static final String NAME = "barchart"; // bash-completion:formatter |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
42 |
public static final String PROPERTY_PRECISION = "precision"; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
43 |
protected static final String PROPERTY_PRECISION_DEFAULT = "100"; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
44 |
private static final MathContext mathContext = MathContext.DECIMAL128; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
45 |
public static final Logger log = LoggerProducer.getLogger(); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
46 |
private final BigDecimal chartPrecision; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
47 |
private final char chartFull; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
48 |
private final char chartEmpty; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
49 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
50 |
public BarChartFormatter(FormatterContext formatterContext) { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
51 |
super(formatterContext); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
52 |
chartPrecision = BigDecimal.valueOf(formatterContext.getProperties().getInteger(PROPERTY_PRECISION, Integer.parseInt(PROPERTY_PRECISION_DEFAULT))); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
53 |
chartFull = isAsciiNostalgia() ? '#' : '█'; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
54 |
chartEmpty = isAsciiNostalgia() ? '~' : '░'; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
55 |
// TODO: consider using partial blocks for more precision: https://en.wikipedia.org/wiki/Block_Elements |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
56 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
57 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
58 |
@Override |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
59 |
protected void postprocessPrefetchedResultSet(ColumnsHeader currentHeader, List<Object[]> currentResultSet) { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
60 |
super.postprocessPrefetchedResultSet(currentHeader, currentResultSet); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
61 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
62 |
updateColumnWidth(currentHeader.getColumnCount(), chartPrecision.intValue()); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
63 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
64 |
BigDecimal maximum = BigDecimal.ZERO; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
65 |
BigDecimal minimum = BigDecimal.ZERO; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
66 |
int lastIndex = currentHeader.getColumnCount() - 1; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
67 |
|
226
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
68 |
Object valueObject = null; |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
69 |
try { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
70 |
for (Object[] row : currentResultSet) { |
226
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
71 |
valueObject = row[lastIndex]; |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
72 |
if (valueObject != null) { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
73 |
BigDecimal value = new BigDecimal(valueObject.toString()); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
74 |
maximum = maximum.max(value); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
75 |
minimum = minimum.min(value); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
76 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
77 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
78 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
79 |
BigDecimal range = maximum.subtract(minimum); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
80 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
81 |
for (Object[] row : currentResultSet) { |
226
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
82 |
valueObject = row[lastIndex]; |
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
83 |
if (valueObject == null) { |
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
84 |
row[lastIndex] = ""; |
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
85 |
} else { |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
86 |
BigDecimal value = new BigDecimal(valueObject.toString()); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
87 |
BigDecimal valueFromMinimum = value.subtract(minimum); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
88 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
89 |
BigDecimal points = chartPrecision.divide(range, mathContext).multiply(valueFromMinimum, mathContext); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
90 |
int pointsRounded = points.setScale(0, RoundingMode.HALF_UP).intValue(); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
91 |
row[lastIndex] = Functions.repeat(chartFull, pointsRounded) + Functions.repeat(chartEmpty, chartPrecision.intValue() - pointsRounded); |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
92 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
93 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
94 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
95 |
} catch (NumberFormatException e) { |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
96 |
// https://en.wiktionary.org/wiki/parsable |
226
b40153eb7716
BarChartFormatter: format null as an empty/missing bar + better logging
František Kučera <franta-hg@frantovo.cz>
parents:
224
diff
changeset
|
97 |
log.log(Level.SEVERE, "Last column must be number or an object with toString() value parsable to a number. But was „{0}“", valueObject); |
224
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
98 |
// FIXME: throw FormatterException |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
99 |
throw e; |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
100 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
101 |
} |
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
102 |
|
36db9fd27436
BarChartFormatter: first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff
changeset
|
103 |
} |