annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/FloodDurationProcessor.java @ 9203:9831f6c60473

AbstractSInfoLineProcessor refactoring
author gernotbelger
date Mon, 02 Jul 2018 13:00:59 +0200
parents b4402594213b
children 3dae6b78e1da
rev   line source
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
2 * Software engineering by
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
5 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
9 */
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
10
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.common;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
12
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
13 import java.util.HashSet;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
14 import java.util.Set;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
15
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
16 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
17 import org.dive4elements.artifactdatabase.state.Facet;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
18 import org.dive4elements.artifacts.CallContext;
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
19 import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
20 import org.dive4elements.river.artifacts.resources.Resources;
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
21 import org.dive4elements.river.artifacts.sinfo.flood_duration.FloodDurationCalculationResult;
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
22 import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
23 import org.dive4elements.river.exports.DiagramGenerator;
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
24 import org.dive4elements.river.themes.ThemeDocument;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
25
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
26 /**
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
27 * Processor to generate the facet and data series of infrastructure flood durations
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
28 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
29 * @author Matthias Schäfer
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
30 *
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
31 */
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
32 public final class FloodDurationProcessor extends AbstractSInfoProcessor {
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
33
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
34 public static final String FACET_FLOOD_DURATION = "sinfo_facet_flood_duration";
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
35
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
36 public static final String FACET_FLOOD_DURATION_DESCRIPTION = "sinfo_facet_flood_duration.description";
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
37
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
38 public static final String FACET_MAIN_VALUE_1_DURATION = "mainvalue.1.duration";
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
39
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
40 public static final String FACET_MAIN_VALUE_2_DURATION = "mainvalue.2.duration";
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
41
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
42 public static final String FACET_MAIN_VALUE_3_DURATION = "mainvalue.3.duration";
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
43
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
44 public static final String FACET_MAIN_VALUE_DURATION_DESCRIPTION = "mainvalue.duration.description";
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
45
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
46 private static final String I18N_AXIS_LABEL = "sinfo.chart.flood_duration.section.yaxis.label";
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
47
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
48 private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
49
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
50 static {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
51 HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
52 HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_1_DURATION);
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
53 HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_2_DURATION);
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
54 HANDLED_FACET_TYPES.add(FACET_MAIN_VALUE_3_DURATION);
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
55 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
56
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
57 public FloodDurationProcessor() {
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
58 super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
59 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
60
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
61 // @Override TODO: REMOVE (has been replaced by doGetType
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
62 // protected double[][] doGetPoints(final AbstractCalculationResult data, final String facetName) {
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
63 //
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
64 // if (FACET_FLOOD_DURATION.contentEquals(facetName))
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
65 // return ((FloodDurationCalculationResult) data).fetchInfrastructurePoints(SInfoResultType.floodDuration);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
66 //
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
67 // if (FACET_MAIN_VALUE_1_DURATION.contentEquals(facetName))
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
68 // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue1Duration);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
69 //
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
70 // if (FACET_MAIN_VALUE_2_DURATION.contentEquals(facetName))
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
71 // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue2Duration);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
72 //
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
73 // if (FACET_MAIN_VALUE_3_DURATION.contentEquals(facetName))
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
74 // return ((FloodDurationCalculationResult) data).fetchMainValuePoints(SInfoResultType.mainValue3Duration);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
75 //
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
76 // final String error = String.format("Unknown facet name: %s", facetName);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
77 // throw new UnsupportedOperationException(error);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
78 // }
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
79
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
80 public static Facet createFloodDurationFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
81 final int index) {
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
82
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
83 return AbstractSInfoProcessor.createFacet(context, hash, id, result, index, I18N_AXIS_LABEL, FACET_FLOOD_DURATION, FACET_FLOOD_DURATION_DESCRIPTION);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
84 }
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
85
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
86 private SInfoResultType doGetType(final String facetName) {
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
87
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
88 if (FACET_FLOOD_DURATION.contentEquals(facetName))
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
89 return SInfoResultType.floodDuration;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
90
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
91 if (FACET_MAIN_VALUE_1_DURATION.contentEquals(facetName))
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
92 return SInfoResultType.mainValue1Duration;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
93
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
94 if (FACET_MAIN_VALUE_2_DURATION.contentEquals(facetName))
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
95 return SInfoResultType.mainValue2Duration;
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
96
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
97 if (FACET_MAIN_VALUE_3_DURATION.contentEquals(facetName))
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
98 return SInfoResultType.mainValue3Duration;
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
99
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
100 final String error = String.format("Unknown facet name: %s", facetName);
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
101 throw new UnsupportedOperationException(error);
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
102
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
103 }
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
104
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
105 public static Facet createMainValueDurationFacet(final CallContext context, final String hash, final String id, final FloodDurationCalculationResult result,
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
106 final int index) {
9202
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
107
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
108 final String description = Resources.getMsg(context.getMeta(), FACET_MAIN_VALUE_DURATION_DESCRIPTION, FACET_MAIN_VALUE_DURATION_DESCRIPTION,
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
109 result.getMainValueLabel(index));
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
110 assert ((index >= 0) && (index <= 2));
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
111 final String facetName = new String[] { FACET_MAIN_VALUE_1_DURATION, FACET_MAIN_VALUE_2_DURATION, FACET_MAIN_VALUE_3_DURATION }[index];
b4402594213b More work on calculations and output for S-Info flood duration workflow (chart types 1 and 2)
mschaefer
parents: 9176
diff changeset
112 return new SInfoResultFacet(0, facetName, description, I18N_AXIS_LABEL, ComputeType.ADVANCE, id, hash);
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
113 }
9203
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
114
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
115 @Override
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
116 protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
117
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
118 return buildSeriesForType(generator, bundle, theme, visible, doGetType(bundle.getFacetName()), GAP_DISTANCE);
9831f6c60473 AbstractSInfoLineProcessor refactoring
gernotbelger
parents: 9202
diff changeset
119 }
9176
1614cb14308f Work on calculations for S-Info flood duration workflow
mschaefer
parents:
diff changeset
120 }

http://dive4elements.wald.intevation.org