Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/exports/process/QOutProcessor.java @ 7075:253d80af5b7f generator-refactoring

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
More Processor refactoring - Unify aandf aaf and bundle variable names to bundle - Factor out diagram inversion code - Add function with new signature to BedDiffYear and QOut processors
author Andre Heinecke <aheinecke@intevation.de>
date Fri, 20 Sep 2013 16:25:43 +0200
parents 1011a40ee79c
children 3c4efd4b2c19
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
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
11 import org.apache.log4j.Logger;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
12 import org.jfree.data.xy.XYSeries;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15 import org.dive4elements.artifacts.CallContext;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
16 import org.dive4elements.river.artifacts.model.FacetTypes;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
17 import org.dive4elements.river.artifacts.model.WKms;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
18 import org.dive4elements.river.artifacts.model.WQKms;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
19
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
20 import org.dive4elements.river.exports.StyledSeriesBuilder;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
21 import org.dive4elements.river.exports.XYChartGenerator;
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
22 import org.dive4elements.river.exports.DiagramGenerator;
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
23 import org.dive4elements.river.jfree.StyledXYSeries;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
24 import org.dive4elements.river.themes.ThemeDocument;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
25 import org.dive4elements.river.utils.DataUtil;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
26
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 * Add data to chart/generator.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
29 *
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
30 * @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
31 */
7057
1011a40ee79c Add Default Processor implementation and make processors inherit it.
Andre Heinecke <aheinecke@intevation.de>
parents: 6929
diff changeset
32 public class QOutProcessor extends DefaultProcessor {
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
33
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
34 /** Private logger. */
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
35 private static final Logger logger =
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
36 Logger.getLogger(QOutProcessor.class);
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
37
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
38 @Override
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
39 public void doOut(
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
40 DiagramGenerator generator,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
41 ArtifactAndFacet bundle,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
42 ThemeDocument theme,
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
43 boolean visible) {
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
44 CallContext context = generator.getCallContext();
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
45 WQKms wqkms = (WQKms) bundle.getData(context);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
46
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
47 XYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
48
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
49 StyledSeriesBuilder.addStepPointsKmQ(series, wqkms);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
50
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
51 generator.addAxisSeries(series, axisName, visible);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
52
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
53 generator.handleLTRWaterFlowInversion(wqkms);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
54 }
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
55
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
56 @Override
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
57 public void doOut(
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
58 XYChartGenerator generator,
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
59 ArtifactAndFacet bundle,
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
60 ThemeDocument theme,
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
61 boolean visible,
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
62 int index)
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
63 {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
64 CallContext context = generator.getCallContext();
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
65 WQKms wqkms = (WQKms) bundle.getData(context);
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
66
7075
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
67 XYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
68
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
69 StyledSeriesBuilder.addStepPointsKmQ(series, wqkms);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
70
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
71 generator.addAxisSeries(series, index, visible);
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
72
253d80af5b7f More Processor refactoring
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
73 invertAxis(generator, wqkms);
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
74 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
75
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
76 /**
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
77 * Returns true if facettype is q-type.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
78 */
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
79 @Override
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
80 public boolean canHandle(String facetType) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
81 if (facetType == null) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
82 return false;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
83 }
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 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
86 || facetType.equals(FacetTypes.LONGITUDINAL_Q)
35ecfd1a861a Let QOutProcessor also handle Discharge/Q-data.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 6927
diff changeset
87 || facetType.equals(FacetTypes.DISCHARGE_LONGITUDINAL_Q)) {
6927
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
88 return true;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
89 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
90 return false;
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
91 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
92
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
93 /**
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
94 * This method determines - taking JFreeCharts auto x value ordering into
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
95 * account - if the x axis need to be inverted. Waterlines in these charts
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
96 * should decrease.
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 * @param generator the generator to invert the axis or not.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
99 * @param wkms The data object that stores the x and y values used for this
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
100 * chart.
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
101 */
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
102 public void invertAxis(XYChartGenerator generator, WKms wkms) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
103 boolean wsUp = wkms.guessWaterIncreasing();
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
104 boolean kmUp = DataUtil.guessWaterIncreasing(wkms.allKms());
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
105 int size = wkms.size();
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
106 boolean inv = ((wsUp && kmUp) || (!wsUp && !kmUp)) && size > 1;
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 if (logger.isDebugEnabled()) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
109 logger.debug("(Wkms)Values : " + size);
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
110 if (size > 0) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
111 logger.debug("Start km: " + wkms.getKm(0));
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
112 logger.debug("End km: " + wkms.getKm(size-1));
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 logger.debug("wsUp: " + wsUp);
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
115 logger.debug("kmUp: " + kmUp);
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
116 if (size == 1) {
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
117 logger.debug("InvertAxis not inverting because we have just one km");
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
118 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
119 logger.debug("inv: " + inv);
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
120 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
121 generator.setInverted(inv);
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 }
0288db5e90d5 issue1455: Extract QOutProcessor, use it
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
124 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org