annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/AbstractSInfoLineProcessor.java @ 9123:1cc7653ca84f

Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
author gernotbelger
date Tue, 05 Jun 2018 19:21:16 +0200
parents ee5ce13016ed
children 23945061daec
rev   line source
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
2 * Software engineering by
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
5 *
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
9 */
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
10
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.common;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
12
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
13 import java.util.Map;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
14 import java.util.Set;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
15
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
16 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
8956
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
17 import org.dive4elements.artifactdatabase.state.Facet;
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
18 import org.dive4elements.artifacts.Artifact;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
19 import org.dive4elements.artifacts.CallContext;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.D4EArtifact;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.access.RiverAccess;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.context.RiverContext;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.math.MovingAverage;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
24 import org.dive4elements.river.artifacts.model.ZoomScale;
8956
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
25 import org.dive4elements.river.artifacts.resources.Resources;
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
26 import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
27 import org.dive4elements.river.exports.DiagramGenerator;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
28 import org.dive4elements.river.exports.StyledSeriesBuilder;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
29 import org.dive4elements.river.jfree.StyledXYSeries;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
30 import org.dive4elements.river.themes.ThemeDocument;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
31
8948
a4f1ac81f26d Work on SINFO-FlowDepthMinMax.
gernotbelger
parents: 8946
diff changeset
32 abstract class AbstractSInfoLineProcessor<RESULT extends AbstractSInfoCalculationResult> extends AbstractSInfoProcessor {
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
33
9123
1cc7653ca84f Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
gernotbelger
parents: 8956
diff changeset
34 private static final double GAP_DISTANCE = 0.101;
1cc7653ca84f Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
gernotbelger
parents: 8956
diff changeset
35
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
36 public AbstractSInfoLineProcessor(final String i18nAxisLabel, final Set<String> handledFacetType) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
37 super(i18nAxisLabel, handledFacetType);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
38 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
39
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
40 @Override
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
41 protected final String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
42
9123
1cc7653ca84f Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
gernotbelger
parents: 8956
diff changeset
43 final CallContext context = generator.getContext();
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
44 final Map<String, String> metaData = bundle.getFacet().getMetaData();
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
45
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
46 final Artifact artifact = bundle.getArtifact();
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
47
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
48 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
49 series.putMetaData(metaData, artifact, context);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
50
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
51 final String facetName = bundle.getFacetName();
8946
5d5d482da3e9 Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents: 8940
diff changeset
52 @SuppressWarnings("unchecked")
5d5d482da3e9 Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents: 8940
diff changeset
53 final RESULT data = (RESULT) bundle.getData(context);
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
54 if (data == null) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
55 // Check has been here before so we keep it for security reasons
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
56 // this should never happen though.
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
57 throw new IllegalStateException("Data is null for facet: " + facetName);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
58 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
59
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
60 final double[][] points = generatePoints(context, artifact, data, facetName);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
61
9123
1cc7653ca84f Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
gernotbelger
parents: 8956
diff changeset
62 StyledSeriesBuilder.addPoints(series, points, true, GAP_DISTANCE);
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
63 generator.addAxisSeries(series, getAxisName(), visible);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
64
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
65 return metaData.get("Y");
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
66 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
67
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
68 private Double findRadius(final CallContext context, final Artifact artifact) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
69 final Double start = (Double) context.getContextValue("startkm");
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
70 final Double end = (Double) context.getContextValue("endkm");
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
71
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
72 if (start == null || end == null)
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
73 return null;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
74
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
75 final RiverContext fc = (RiverContext) context.globalContext();
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
76 final ZoomScale scales = (ZoomScale) fc.get("zoomscale");
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
77 final RiverAccess access = new RiverAccess((D4EArtifact) artifact);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
78 final String river = access.getRiverName();
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
79
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
80 return scales.getRadius(river, start, end);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
81 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
82
8956
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
83 private double[][] generatePoints(final CallContext context, final Artifact artifact, final RESULT data, final String facetName) {
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
84
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
85 final double[][] points = doGetPoints(data, facetName);
8956
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
86 if (facetName.endsWith(".filtered")) {
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
87 final Double radius = findRadius(context, artifact);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
88 return movingAverage(radius, points);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
89 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
90
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
91 return points;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
92 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
93
8946
5d5d482da3e9 Implementing SINFO - FlowDepthMinMax calculation
gernotbelger
parents: 8940
diff changeset
94 protected abstract double[][] doGetPoints(RESULT data, String facetName);
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
95
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
96 private double[][] movingAverage(final Double radius, final double[][] points) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
97
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
98 if (radius == null)
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
99 return points;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
100
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
101 return MovingAverage.weighted(points, radius);
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
102 }
8956
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
103
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
104 protected static final Facet createFacet(final CallContext context, final String hash, final String id, final AbstractSInfoCalculationResult result,
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
105 final int index, final String axisLabel, final String facetId, final String description) {
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
106 final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel());
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
107 return new SInfoResultFacet(index, facetId, facetFlowDepthFilteredDescription, axisLabel, ComputeType.ADVANCE, id, hash);
ee5ce13016ed Work on SINFO-Fließtiefenentwicklung
gernotbelger
parents: 8948
diff changeset
108 }
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents:
diff changeset
109 }

http://dive4elements.wald.intevation.org