annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/AbstractSInfoProcessor.java @ 9040:5294114b1df4

Fixed/changed some FIXMEs/TODOs
author gernotbelger
date Wed, 02 May 2018 12:19:31 +0200
parents 5d5d0051723f
children 6393e05a9610
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
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8886
diff changeset
11 package org.dive4elements.river.artifacts.sinfo.common;
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
12
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
13 import java.util.Set;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
14
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
15 import org.apache.log4j.Logger;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
16 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.exports.DiagramGenerator;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.exports.process.DefaultProcessor;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
19 import org.dive4elements.river.themes.ThemeDocument;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
20
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
21 /**
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
22 * 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
23 * cases as well.
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
24 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
25 * @author Gernot Belger
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
26 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
27 */
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8886
diff changeset
28 public abstract class AbstractSInfoProcessor extends DefaultProcessor {
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
29
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
30 private final static Logger log = Logger.getLogger(AbstractSInfoProcessor.class);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
31
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
32 private String yAxisLabel;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
33
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
34 private final Set<String> handled_facet_types;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
35
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
36 private final String i18n_axis_label;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
37
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
38 public AbstractSInfoProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
39 this.i18n_axis_label = i18n_axis_label;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
40 this.handled_facet_types = handled_facet_types;
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
41 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
42
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
43 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
44 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) {
8886
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
45 try {
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
46 this.yAxisLabel = generateSeries(generator, bundle, theme, visible);
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
47 }
8886
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
48 catch (final Exception e) {
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
49 log.error(e.getMessage(), e);
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
50 }
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
51 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
52
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
53 /**
8886
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
54 * @return The axis label
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
55 */
8886
cc86b0f9b3c3 SINFO-FlowDepth - work on tkh themes
gernotbelger
parents: 8884
diff changeset
56 protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible);
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
57
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
58 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
59 public final boolean canHandle(final String facettype) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
60 return this.handled_facet_types.contains(facettype);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
61 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
62
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
63 @Override
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
64 public final String getAxisLabel(final DiagramGenerator generator) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
65 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
66 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata),
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
67 // and cannot be resolved, so we need to give the resolved value as default
9040
5294114b1df4 Fixed/changed some FIXMEs/TODOs
gernotbelger
parents: 8916
diff changeset
68 // TODO: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here,
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
69 // probably the English version will also show German (CHECK)
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
70 return generator.msg(this.yAxisLabel, this.yAxisLabel);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
71 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
72 return generator.msg(this.i18n_axis_label, "MISSING");
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
73 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents:
diff changeset
74 }

http://dive4elements.wald.intevation.org