annotate artifacts/src/main/java/org/dive4elements/river/exports/process/QOutProcessor.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
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
3 *
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
7 */
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
8
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
9 package org.dive4elements.river.exports.process;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
10
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
11 import org.apache.logging.log4j.Logger;
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
12 import org.apache.logging.log4j.LogManager;
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13 import org.jfree.data.xy.XYSeries;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
16 import org.dive4elements.artifacts.CallContext;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
17 import org.dive4elements.river.artifacts.model.FacetTypes;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
18 import org.dive4elements.river.artifacts.model.WQKms;
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
19 import org.dive4elements.river.artifacts.model.FlowVelocityData;
7289
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
20 import org.dive4elements.river.model.FlowVelocityMeasurementValue.FastFlowVelocityMeasurementValue;
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
21
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
22 import org.dive4elements.river.exports.StyledSeriesBuilder;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
23 import org.dive4elements.river.exports.XYChartGenerator;
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
24 import org.dive4elements.river.exports.DiagramGenerator;
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
25 import org.dive4elements.river.jfree.StyledXYSeries;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
26 import org.dive4elements.river.themes.ThemeDocument;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
27
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
28 /**
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
29 * Add data to chart/generator.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
30 *
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
31 * @author <a href="mailto:bjoern.ricks@intevation.de">Björn Ricks</a>
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
32 */
7057
1011a40ee79c Add Default Processor implementation and make processors inherit it.
Andre Heinecke <aheinecke@intevation.de>
parents: 6929
diff changeset
33 public class QOutProcessor extends DefaultProcessor {
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
34
7084
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
35 public static final String I18N_LONGITUDINAL_LABEL =
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
36 "chart.longitudinal.section.yaxis.second.label";
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
37
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
38 public static final String
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
39 I18N_LONGITUDINAL_LABEL_DEFAULT = "Q [m\u00b3/s]";
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
40
8202
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 7399
diff changeset
41 /** Private log. */
e4606eae8ea5 sed src/**/*.java 's/logger/log/g'
Sascha L. Teichmann <teichmann@intevation.de>
parents: 7399
diff changeset
42 private static final Logger log =
9726
0a5239a1e46e Upgrade to Log4j 2
Tom Gottfried <tom@intevation.de>
parents: 8856
diff changeset
43 LogManager.getLogger(QOutProcessor.class);
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
44
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
45 @Override
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
46 public void doOut(
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
47 DiagramGenerator generator,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
48 ArtifactAndFacet bundle,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
49 ThemeDocument theme,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
50 boolean visible) {
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
51 CallContext context = generator.getCallContext();
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
52 Object data = bundle.getData(context);
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
53 XYSeries series = new StyledXYSeries(
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
54 bundle.getFacetDescription(), theme);
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
55 String facetName = bundle.getFacetName();
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
56
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
57 if (facetName.equals(FacetTypes.FLOW_VELOCITY_DISCHARGE)) {
7289
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
58 if (data instanceof FlowVelocityData) {
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
59 FlowVelocityData fData = (FlowVelocityData) data;
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
60 StyledSeriesBuilder.addPoints(series, fData.getQPoints(), true);
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
61 }
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
62 else {
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
63 FastFlowVelocityMeasurementValue fData =
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
64 (FastFlowVelocityMeasurementValue) data;
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
65 double[][] points = new double[][] {
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
66 {fData.getStation()},{fData.getQ()}};
7289
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
67 StyledSeriesBuilder.addPoints(series, points, true);
015e12aac2dc issue1512: Adjusted Q and WOutProcessors to handle data
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7163
diff changeset
68 }
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
69 } else {
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
70 WQKms wqkms = (WQKms) data;
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
71 StyledSeriesBuilder.addStepPointsKmQ(series, wqkms);
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
72 }
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
73
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
74 generator.addAxisSeries(series, axisName, visible);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
75 }
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
76
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
77 @Override
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
78 public void doOut(
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
79 XYChartGenerator generator,
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
80 ArtifactAndFacet bundle,
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
81 ThemeDocument theme,
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
82 boolean visible,
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
83 int index)
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
84 {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
85 CallContext context = generator.getCallContext();
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
86 WQKms wqkms = (WQKms) bundle.getData(context);
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
87
8856
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
88 XYSeries series = new StyledXYSeries(
5e38e2924c07 Fix code style.
Tom Gottfried <tom@intevation.de>
parents: 8202
diff changeset
89 bundle.getFacetDescription(), theme);
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
90
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
91 StyledSeriesBuilder.addStepPointsKmQ(series, wqkms);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
92
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
93 generator.addAxisSeries(series, index, visible);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
94
7081
3c4efd4b2c19 Simplyfy / unify "invert axis" logic
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
95 /* Check if the diagram should be inverted*/
3c4efd4b2c19 Simplyfy / unify "invert axis" logic
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
96 generator.setInverted(wqkms.guessRTLData());
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
97 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
98
7084
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
99 @Override
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
100 public String getAxisLabel(DiagramGenerator generator) {
7108
54fa03dad18c Default to the label of longitundial Q axis in the QProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7088
diff changeset
101 return generator.msg(I18N_LONGITUDINAL_LABEL,
54fa03dad18c Default to the label of longitundial Q axis in the QProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7088
diff changeset
102 I18N_LONGITUDINAL_LABEL_DEFAULT);
7084
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
103 }
f0731aa7b735 Implement Label handling
Andre Heinecke <aheinecke@intevation.de>
parents: 7081
diff changeset
104
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
105 /**
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
106 * Returns true if facettype is q-type.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
107 */
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
108 @Override
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
109 public boolean canHandle(String facetType) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
110 if (facetType == null) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
111 return false;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
112 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
113
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
114 if (facetType.equals(FacetTypes.STATIC_WQKMS_Q)
6929
35ecfd1a861a Let QOutProcessor also handle Discharge/Q-data.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 6927
diff changeset
115 || facetType.equals(FacetTypes.LONGITUDINAL_Q)
7163
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
116 || facetType.startsWith(FacetTypes.DISCHARGE_LONGITUDINAL_Q)
704a33c0f5a2 Handle flow velocity discharge in the new part of the QOutProcessor
Andre Heinecke <aheinecke@intevation.de>
parents: 7109
diff changeset
117 || facetType.startsWith(FacetTypes.FLOW_VELOCITY_DISCHARGE)) {
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
118 return true;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
119 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
120 return false;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
121 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
122 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
123 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org