annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flood_duration/FloodDurationCurveProcessor.java @ 9252:c2a0028bfa9f

Work on S-Info flood duration curve chart
author mschaefer
date Thu, 12 Jul 2018 18:09:48 +0200
parents
children ef7b65576d4b
rev   line source
9252
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
2 * Software engineering by
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
5 *
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
9 */
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
10
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.flood_duration;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
12
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
13 import java.util.HashSet;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
14 import java.util.Set;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
15
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
16 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
17 import org.dive4elements.artifactdatabase.state.Facet;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
18 import org.dive4elements.artifacts.CallContext;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
19 import org.dive4elements.river.artifacts.common.AbstractCalculationResult;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
20 import org.dive4elements.river.exports.DiagramGenerator;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
21 import org.dive4elements.river.exports.DurationCurveGenerator;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
22 import org.dive4elements.river.exports.XYChartGenerator;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
23 import org.dive4elements.river.exports.process.DefaultProcessor;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
24 import org.dive4elements.river.themes.ThemeDocument;
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
25
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
26 /**
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
27 * Processor to generate the facet and data series of a flood duration curve
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
28 *
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
29 * @author Matthias Schäfer
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
30 *
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
31 */
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
32 public final class FloodDurationCurveProcessor extends DefaultProcessor {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
33
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
34 private static final String FACET_FLOOD_DURATION_W = "duration_curve.w";
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
35
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
36 private static final String FACET_FLOOD_DURATION_Q = "duration_curve.q";
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
37
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
38 private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
39
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
40 static {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
41 HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_W);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
42 HANDLED_FACET_TYPES.add(FACET_FLOOD_DURATION_Q);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
43 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
44
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
45 public static Facet createFloodDurationWCurveFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
46 final int facetIndex, final int resultIndex, final String description) {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
47
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
48 return new FloodDurationCurveFacet(FACET_FLOOD_DURATION_W, description);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
49 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
50
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
51 public static Facet createFloodDurationQCurveFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result,
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
52 final int facetIndex, final int resultIndex, final String description) {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
53
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
54 return new FloodDurationCurveFacet(FACET_FLOOD_DURATION_Q, description);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
55 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
56
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
57 /**
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
58 * Processes data to generate a chart.
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
59 */
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
60 @Override
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
61 public void doOut(final XYChartGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible, final int index) {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
62
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
63 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
64
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
65 @Override
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
66 public final String getAxisLabel(final DiagramGenerator generator) {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
67 return generator.msg(DurationCurveGenerator.I18N_YAXIS_LABEL_W);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
68 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
69
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
70 @Override
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
71 public final boolean canHandle(final String facettype) {
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
72 return HANDLED_FACET_TYPES.contains(facettype);
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
73 }
c2a0028bfa9f Work on S-Info flood duration curve chart
mschaefer
parents:
diff changeset
74 }

http://dive4elements.wald.intevation.org