annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flood_duration/FloodDurationState.java @ 9259:66b003701546

Added infrastructure height and Q annotation to S-Info flood duration curve chart
author mschaefer
date Mon, 16 Jul 2018 08:43:07 +0200
parents ef7b65576d4b
children e5367900dd6d
rev   line source
9259
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
2 * Software engineering by
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
5 *
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
9 */
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
10
9054
95643dffd006 rename grounding->collision; inundation_duration->flood_duration
gernotbelger
parents: 9050
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.flood_duration;
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
12
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
13 import java.util.List;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
14
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
15 import org.dive4elements.artifactdatabase.state.Facet;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
16 import org.dive4elements.artifacts.CallContext;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.ChartArtifact;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.artifacts.D4EArtifact;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
19 import org.dive4elements.river.artifacts.model.Calculation;
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.model.CalculationResult;
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
21 import org.dive4elements.river.artifacts.model.DataFacet;
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.model.EmptyFacet;
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
23 import org.dive4elements.river.artifacts.model.FacetTypes;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
24 import org.dive4elements.river.artifacts.model.ReportFacet;
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
25 import org.dive4elements.river.artifacts.resources.Resources;
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
26 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
9229
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
27 import org.dive4elements.river.artifacts.sinfo.flood_duration.RiversideRadioChoice.RiversideChoiceKey;
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
28 import org.dive4elements.river.artifacts.states.DefaultState;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
29
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
30 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
31 * Last state of the S-Info flood duration workflow that calculates and outputs the result
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
32 */
9054
95643dffd006 rename grounding->collision; inundation_duration->flood_duration
gernotbelger
parents: 9050
diff changeset
33 public class FloodDurationState extends DefaultState {
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
34
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
35 /// ** The log that is used in this state. */
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
36 // private static Logger log = Logger.getLogger(FloodDurationState.class);
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
37
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
38 private static final long serialVersionUID = 1L;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
39
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
40 /**
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
41 * From this state can only be continued trivially.
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
42 */
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
43 @Override
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
44 protected String getUIProvider() {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
45 return "continue";
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
46 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
47
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
48 @Override
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
49 public Object computeFeed(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
50 if (artifact instanceof ChartArtifact) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
51 facets.add(new EmptyFacet());
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
52 return null;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
53 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
54 return compute((SINFOArtifact) artifact, context, hash, facets, old);
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
55 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
56
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
57 @Override
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
58 public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
59 if (artifact instanceof ChartArtifact) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
60 facets.add(new EmptyFacet());
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
61 return null;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
62 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
63 return compute((SINFOArtifact) artifact, context, hash, facets, old);
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
64 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
65
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
66 /**
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
67 * Compute result or returned object from cache, create facets.
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
68 *
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
69 * @param old
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
70 * Object that was cached.
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
71 */
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
72 private Object compute(final SINFOArtifact sinfo, final CallContext context, final String hash, final List<Facet> facets, final Object old) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
73
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
74 final CalculationResult res = doCompute(sinfo, context, old);
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
75
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
76 if (facets == null)
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
77 return res;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
78
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
79 final FloodDurationCalculationResults results = (FloodDurationCalculationResults) res.getData();
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9176
diff changeset
80 final List<FloodDurationCalculationResult> resultList = results.getResults();
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
81 int resultIndex = 0;
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
82 int themeCount = 0;
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9176
diff changeset
83 for (final FloodDurationCalculationResult result : resultList) {
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
84
9229
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
85 final FloodDurationAccess access = new FloodDurationAccess(sinfo);
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
86 if ((access.getRiverside() == RiversideChoiceKey.LEFT) || (access.getRiverside() == RiversideChoiceKey.BOTH))
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
87 facets.add(FloodDurationProcessor.createFloodDurationFacet(context, hash, this.id, result, 0, resultIndex));
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
88 if ((access.getRiverside() == RiversideChoiceKey.RIGHT) || (access.getRiverside() == RiversideChoiceKey.BOTH))
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
89 facets.add(FloodDurationProcessor.createFloodDurationFacet(context, hash, this.id, result, 1, resultIndex));
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
90
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
91 final int waterlevelCount = result.getWaterlevelCount();
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
92
9229
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
93 if ((access.getRiverside() == RiversideChoiceKey.LEFT) || (access.getRiverside() == RiversideChoiceKey.BOTH))
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
94 facets.add(FloodHeightProcessor.createFloodHeightFacet(context, hash, this.id, result, 0, resultIndex));
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
95 if ((access.getRiverside() == RiversideChoiceKey.RIGHT) || (access.getRiverside() == RiversideChoiceKey.BOTH))
0dcd1cd41915 Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents: 9215
diff changeset
96 facets.add(FloodHeightProcessor.createFloodHeightFacet(context, hash, this.id, result, 1, resultIndex));
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
97
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
98 for (int j = 0; j < waterlevelCount; j++) {
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
99
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
100 // final String waterlevelLabel = result.getMainValueLabel(j);
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
101 // FIXME: use label as label for theme
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
102
9215
0fc9c82e744e work on collison, flood_duration
gernotbelger
parents: 9205
diff changeset
103 // final int facetIndex, final int resultIndex, final int dataIndex
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
104 facets.add(FloodDurationProcessor.createMainValueDurationFacet(context, hash, this.id, result, themeCount, resultIndex, j));
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
105 facets.add(FloodHeightProcessor.createMainValueHeightFacet(context, hash, this.id, result, themeCount, resultIndex, j));
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
106
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
107 themeCount++;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9195
diff changeset
108 }
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
109
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
110 final String nameW = Resources.getMsg(context.getMeta(), "sinfo.chart.flood_duration.curve.w");
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
111 final String nameQ = Resources.getMsg(context.getMeta(), "sinfo.chart.flood_duration.curve.q");
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
112 facets.add(FloodDurationCurveProcessor.createFloodDurationWCurveFacet(context, hash, this.id, result, 0, resultIndex, nameW));
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
113 facets.add(FloodDurationCurveProcessor.createFloodDurationQCurveFacet(context, hash, this.id, result, 1, resultIndex, nameQ));
9257
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
114 if (waterlevelCount >= 1) {
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
115 facets.add(FloodDurationCurveProcessor.createMainValuesWFacet(context, hash, this.id, result, 0, resultIndex,
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
116 Resources.getMsg(context.getMeta(), "sinfo.chart.flood_duration.curve.mainw")));
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
117 facets.add(FloodDurationCurveProcessor.createMainValuesQFacet(context, hash, this.id, result, 1, resultIndex,
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
118 Resources.getMsg(context.getMeta(), "sinfo.chart.flood_duration.curve.mainq")));
ef7b65576d4b Added W and Q main values to S-Info flood duration curve chart
mschaefer
parents: 9252
diff changeset
119 }
9259
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
120 facets.add(FloodDurationCurveProcessor.createInfrastructureWFacet(context, hash, this.id, result, 0, resultIndex,
66b003701546 Added infrastructure height and Q annotation to S-Info flood duration curve chart
mschaefer
parents: 9257
diff changeset
121 Resources.getMsg(context.getMeta(), "sinfo.chart.flood_duration.curve.facet.infrastructure")));
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents: 9229
diff changeset
122
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
123 facets.add(new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, this.id));
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
124 facets.add(new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, this.id));
9195
a4121ec450d6 'ca.'-issue
gernotbelger
parents: 9176
diff changeset
125
9205
3dae6b78e1da inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents: 9202
diff changeset
126 resultIndex++;
9145
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
127 }
e6b63b2b41b9 sinfo.flood_duration pdf, csv, ui
gernotbelger
parents: 9067
diff changeset
128
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
129 final Calculation report = res.getReport();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
130 if (report.hasProblems())
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents: 9150
diff changeset
131 facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
132
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
133 return res;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
134 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
135
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
136 private CalculationResult doCompute(final SINFOArtifact sinfo, final CallContext context, final Object old) {
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
137 if (old instanceof CalculationResult)
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
138 return (CalculationResult) old;
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
139
9067
2ed3824a3d53 sinfo access collision, floodDuration
gernotbelger
parents: 9054
diff changeset
140 return new FloodDurationCalculation(context).calculate(sinfo);
9050
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
141 }
f4b66f6692e3 sinfo.xml definition states+transitions
gernotbelger
parents:
diff changeset
142 }

http://dive4elements.wald.intevation.org