annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/PredefinedChannelDepthProcessor.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 189cc8ededbd
children a4121ec450d6
rev   line source
9112
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
1 /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
2 * Software engineering by
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
5 *
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
9 */
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
10
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.common;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
12
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
13 import java.util.HashSet;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
14 import java.util.Map;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
15 import java.util.Set;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
16
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
17 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
18 import org.dive4elements.artifactdatabase.state.Facet;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
19 import org.dive4elements.artifacts.Artifact;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
20 import org.dive4elements.artifacts.CallContext;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
21 import org.dive4elements.artifacts.CallMeta;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
22 import org.dive4elements.river.artifacts.resources.Resources;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
23 import org.dive4elements.river.artifacts.sinfo.predefinedchannel.PredefinedChannelFacet;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.predefinedchannel.PredefinedChannelQueryCalculationResult;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
25 import org.dive4elements.river.exports.DiagramGenerator;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
26 import org.dive4elements.river.exports.StyledSeriesBuilder;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
27 import org.dive4elements.river.jfree.StyledXYSeries;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
28 import org.dive4elements.river.themes.ThemeDocument;
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
29
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
30 /**
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
31 * Processor to generate a data series for river channel depth data loaded from the database
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
32 *
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
33 * @author Matthias Schäfer
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
34 *
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
35 */
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
36 public class PredefinedChannelDepthProcessor extends AbstractSInfoProcessor {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
37
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
38 // private final static Logger log = Logger.getLogger(PredefinedChannelDepthProcessor.class);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
39
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
40 public static final String FACET_PREDEFINED_CHANNEL_DEPTH = "sinfo_facet_predefined_channel_depth";
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
41
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
42 private static final String I18N_AXIS_LABEL = "sinfo.chart.flow_depth.section.yaxis.label";
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
43
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
44 private static final String I18N_SERIES_NAME_PATTERN = "predefinedchannel.depth.title";
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
45
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
46 private static final Set<String> HANDLED_FACET_TYPES = new HashSet<>();
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
47
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
48 static {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
49 HANDLED_FACET_TYPES.add(FACET_PREDEFINED_CHANNEL_DEPTH);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
50 }
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
51
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
52 public PredefinedChannelDepthProcessor() {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
53 super(I18N_AXIS_LABEL, HANDLED_FACET_TYPES);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
54 }
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
55
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
56 @Override
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
57 protected String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
58
9123
1cc7653ca84f Cleanup of ChartGenerator and ChartGenerator2 code. Put some of the copy/pasted code into a common abstraction.
gernotbelger
parents: 9112
diff changeset
59 final CallContext context = generator.getContext();
9112
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
60 final Map<String, String> metaData = bundle.getFacet().getMetaData();
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
61
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
62 final Artifact artifact = bundle.getArtifact();
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
63
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
64 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
65 series.putMetaData(metaData, artifact, context);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
66
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
67 final String facetName = bundle.getFacetName();
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
68 final PredefinedChannelQueryCalculationResult data = (PredefinedChannelQueryCalculationResult) bundle.getData(context);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
69 if (data == null) {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
70 // Check has been here before so we keep it for security reasons
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
71 // this should never happen though.
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
72 throw new IllegalStateException("Data is null for facet: " + facetName);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
73 }
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
74
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
75 final double[][] points = data.getStationPoints(SInfoResultType.channelDepth);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
76
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
77 StyledSeriesBuilder.addPoints(series, points, true);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
78 generator.addAxisSeries(series, getAxisName(), visible);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
79
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
80 return metaData.get("Y");
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
81 }
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
82
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
83 public static Facet createFacet(final CallMeta callMeta, final String seriesName) {
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
84 return new PredefinedChannelFacet(FACET_PREDEFINED_CHANNEL_DEPTH,
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
85 Resources.getMsg(callMeta, I18N_SERIES_NAME_PATTERN, I18N_SERIES_NAME_PATTERN, seriesName), I18N_AXIS_LABEL);
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
86 }
189cc8ededbd Added datacage select and chart display for river channel sizes loaded from database
mschaefer
parents:
diff changeset
87 }

http://dive4elements.wald.intevation.org