annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/AbstractSInfoProcessor.java @ 8884:7a8c12706834

Work on SINFO-FlowDepth
author gernotbelger
date Tue, 13 Feb 2018 14:53:23 +0100
parents
children cc86b0f9b3c3
rev   line source
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
2 * Software engineering by
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
5 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
9 */
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
10
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.flowdepth;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
12
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
13 import java.util.Map;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
14 import java.util.Set;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
15
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
16 import org.apache.log4j.Logger;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
17 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
18 import org.dive4elements.artifacts.CallContext;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
19 import org.dive4elements.river.exports.DiagramGenerator;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.exports.StyledSeriesBuilder;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.exports.process.DefaultProcessor;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.jfree.StyledXYSeries;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.themes.ThemeDocument;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
24
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
25 /**
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
26 * Abstraction for some processor implementation within S-INFO. Probably this abstraction could also be used for other
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
27 * cases as well.
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
28 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
29 * @author Gernot Belger
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
30 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
31 */
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
32 abstract class AbstractSInfoProcessor extends DefaultProcessor {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
33
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
34 private final static Logger log = Logger.getLogger(AbstractSInfoProcessor.class);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
35
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
36 private String yAxisLabel;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
37
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
38 private final Set<String> handled_facet_types;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
39
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
40 private final String i18n_axis_label;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
41
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
42 public AbstractSInfoProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
43 this.i18n_axis_label = i18n_axis_label;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
44 this.handled_facet_types = handled_facet_types;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
45 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
46
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
47 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
48 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
49
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
50 final CallContext context = generator.getCallContext();
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
51 final Map<String, String> metaData = bundle.getFacet().getMetaData();
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
52
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
53 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
54 series.putMetaData(metaData, bundle.getArtifact(), context);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
55
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
56 this.yAxisLabel = metaData.get("Y");
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
57
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
58 final String facetName = bundle.getFacetName();
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
59 final FlowDepthCalculationResult data = (FlowDepthCalculationResult) bundle.getData(context);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
60 if (data == null) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
61 // Check has been here before so we keep it for security reasons
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
62 // this should never happen though.
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
63 log.error("Data is null for facet: " + facetName);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
64 return;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
65 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
66
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
67 final double[][] points = generatePoints(data, facetName);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
68
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
69 StyledSeriesBuilder.addPoints(series, points, true);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
70 generator.addAxisSeries(series, this.axisName, visible);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
71 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
72
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
73 /**
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
74 * Override to implement, call super as last line for default case.
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
75 */
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
76 protected double[][] generatePoints(@SuppressWarnings("unused") final FlowDepthCalculationResult data, final String facetName) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
77 final String error = String.format("Unknown facet name: %s", facetName);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
78 log.error(error);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
79 throw new UnsupportedOperationException(error);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
80 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
81
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
82 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
83 public final boolean canHandle(final String facettype) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
84 return this.handled_facet_types.contains(facettype);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
85 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
86
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
87 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
88 public final String getAxisLabel(final DiagramGenerator generator) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
89 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
90 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata),
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
91 // and cannot be resolved, so we need to give the resolved value as default
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
92 // FIXME: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
93 // probably the English version will also show German (CHECK)
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
94 return generator.msg(this.yAxisLabel, this.yAxisLabel);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
95 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
96 return generator.msg(this.i18n_axis_label, "MISSING");
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
97 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
98 }

http://dive4elements.wald.intevation.org