annotate artifacts/src/main/java/org/dive4elements/river/exports/process/SQRelationProcessor.java @ 9801:1d7a72a50183 3.2.x tip

Assume Compose V2, consistently
author Tom Gottfried <tom@intevation.de>
date Thu, 23 Nov 2023 10:14:13 +0100
parents 0a5239a1e46e
children
rev   line source
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2013 by Bundesanstalt für Gewässerkunde
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
3 *
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
7 */
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
8
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
9 package org.dive4elements.river.exports.process;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
10
7990
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
11 import java.util.Map;
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
12 import java.util.List;
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
13 import java.util.ArrayList;
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
14 import java.text.DateFormat;
7990
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
15
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
16 import org.apache.logging.log4j.Logger;
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
17 import org.apache.logging.log4j.LogManager;
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
18
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
19 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
20 import org.dive4elements.artifacts.CallContext;
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
21 import org.dive4elements.river.artifacts.resources.Resources;
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
22 import org.dive4elements.river.exports.DiagramGenerator;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
23 import org.dive4elements.river.jfree.StyledXYSeries;
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
24 import org.dive4elements.river.jfree.RiverAnnotation;
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
25 import org.dive4elements.river.themes.ThemeDocument;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
26 import org.dive4elements.river.artifacts.model.FacetTypes;
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
27 import org.dive4elements.river.jfree.CollisionFreeXYTextAnnotation;
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
28 import org.jfree.chart.annotations.XYTextAnnotation;
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
29
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
30 import org.dive4elements.river.jfree.JFreeUtil;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
31
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
32 import org.dive4elements.river.artifacts.model.sq.SQ;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
33 import org.dive4elements.river.artifacts.model.sq.SQFunction;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
34
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
35 public class SQRelationProcessor extends DefaultProcessor {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
36
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
37 public static final String I18N_AXIS_LABEL =
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
38 "chart.sq_relation.yaxis.label";
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
39 public static final String I18N_AXIS_LABEL_DEFAULT =
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
40 "";
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
41
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
42 private final static Logger log =
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
43 LogManager.getLogger(SQRelationProcessor.class);
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
44
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
45 @Override
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
46 public void doOut(
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
47 DiagramGenerator generator,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
48 ArtifactAndFacet bundle,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
49 ThemeDocument theme,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
50 boolean visible) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
51 CallContext context = generator.getCallContext();
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
52 String facetName = bundle.getFacetName();
7990
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
53 StyledXYSeries series;
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
54 Object data = bundle.getData(context);
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
55 String desc = bundle.getFacetDescription();
7990
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
56 Map<String, String> metaData =
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
57 bundle.getFacet().getMetaData(bundle.getArtifact(), context);
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
58 if (data == null) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
59 // Check has been here before so we keep it but
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
60 // this should never happen.
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
61 log.error("Data is null for facet: " + facetName);
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
62 return;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
63 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
64
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
65 if (FacetTypes.IS.SQ_CURVE(facetName)) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
66 SQFunction func = (SQFunction) data;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
67
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
68 series = JFreeUtil.sampleFunction2DPositive(
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
69 func.getFunction(),
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
70 theme,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
71 desc,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
72 500,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
73 Math.max(func.getMinQ(), 0.01),
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
74 Math.max(func.getMaxQ(), 0.02));
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
75
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
76 } else if (FacetTypes.IS.SQ_MEASUREMENT(facetName) ||
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
77 FacetTypes.IS.SQ_OUTLIER(facetName)) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
78
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
79 SQ[] sqs = (SQ[]) data;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
80 series = new StyledXYSeries(desc, theme);
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
81 List<XYTextAnnotation> xy = new ArrayList<XYTextAnnotation>();
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
82
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
83 DateFormat dateFormat = DateFormat.getDateInstance(
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
84 DateFormat.SHORT,
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
85 Resources.getLocale(context.getMeta()));
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
86
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
87 for (SQ sq: sqs) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
88 double q = sq.getQ();
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
89 double s = sq.getS();
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
90 if (s > 0d && q > 0d) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
91 series.add(q, s, false);
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
92 // Annotate with measurement date
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
93 if (sq.getDate() != null) {
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
94 xy.add(new CollisionFreeXYTextAnnotation(
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
95 dateFormat.format(sq.getDate()), q, s));
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
96 }
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
97 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
98 }
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
99
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
100 if (visible && theme.parseShowPointLabel()) {
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
101
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
102 RiverAnnotation annotation = new RiverAnnotation(
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8588
diff changeset
103 "Messdatum", null, null, theme);
8540
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
104 annotation.setTextAnnotations(xy);
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
105 generator.addAnnotations(annotation);
422a78fbb4df (issue1753) Add SQ Measurement dates as text annotations to points
Andre Heinecke <andre.heinecke@intevation.de>
parents: 8202
diff changeset
106 }
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
107 } else {
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
108 log.error("Could not handle: " + facetName);
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
109 return;
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
110 }
7990
e3f2d8c006fb Add meta data to chart series in sq relation.
Raimund Renkert <rrenkert@intevation.de>
parents: 7240
diff changeset
111 series.putMetaData(metaData, bundle.getArtifact(), context);
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
112
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
113 if (log.isDebugEnabled()) {
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
114 log.debug("Series '" + desc + "' has "
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
115 + series.getItemCount() + " items.");
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
116
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
117 log.debug(" -> min x = " + series.getMinX());
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
118 log.debug(" -> max x = " + series.getMaxX());
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
119 log.debug(" -> min y = " + series.getMinY());
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 8022
diff changeset
120 log.debug(" -> max y = " + series.getMaxY());
7240
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
121 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
122
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
123 generator.addAxisSeries(series, axisName, visible);
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
124 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
125
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
126 @Override
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
127 public boolean canHandle(String facettype) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
128 return FacetTypes.IS.SQ_CURVE(facettype) ||
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
129 FacetTypes.IS.SQ_MEASUREMENT(facettype) ||
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
130 FacetTypes.IS.SQ_OUTLIER(facettype);
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
131 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
132
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
133 @Override
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
134 public String getAxisLabel(DiagramGenerator generator) {
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
135 return generator.msg(
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
136 I18N_AXIS_LABEL,
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
137 I18N_AXIS_LABEL_DEFAULT);
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
138 }
bb4a6b0077cf Add SQRelation Processor
Andre Heinecke <aheinecke@intevation.de>
parents:
diff changeset
139 }

http://dive4elements.wald.intevation.org