annotate artifacts/src/main/java/org/dive4elements/river/artifacts/bundu/BUNDUArtifact.java @ 9432:d194c5b24bf8

Added bundu bzws w calculation and longitudinal sections of wspl and depth
author mschaefer
date Mon, 20 Aug 2018 09:46:02 +0200
parents 02739b8c010d
children ecadc9ed0ba0
rev   line source
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
2 * Software engineering by
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
3 * Björnsen Beratende Ingenieure GmbH
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
5 *
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
6 * This file is Free Software under the GNU AGPL (>=v3)
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
8 * documentation coming with Dive4Elements River for details.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
9 */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
10 package org.dive4elements.river.artifacts.bundu;
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
11
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
12 import org.apache.commons.lang.StringUtils;
9072
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
13 import org.dive4elements.artifactdatabase.state.Facet;
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
14 import org.dive4elements.artifactdatabase.state.FacetActivity;
9072
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
15 import org.dive4elements.artifacts.Artifact;
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
16 import org.dive4elements.river.artifacts.D4EArtifact;
9432
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
17 import org.dive4elements.river.artifacts.model.FacetTypes;
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
18
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
19 /**
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
20 * The default BUNDU artifact.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
21 *
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
22 * @author Gernot Belger
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
23 */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
24 public class BUNDUArtifact extends D4EArtifact {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
25
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
26 private static final long serialVersionUID = 1L;
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
27
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
28 /** Error message that is thrown if no mode has been chosen. */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
29 private static final String ERROR_NO_CALCULATION_MODE = "error_feed_no_calculation_mode";
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
30
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
31 /**
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
32 * Error message that is thrown if an invalid calculation mode has been chosen.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
33 */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
34 private static final String ERROR_INVALID_CALCULATION_MODE = "error_feed_invalid_calculation_mode";
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
35
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
36 /** The name of the artifact. */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
37 private static final String ARTIFACT_NAME = "bundu";
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
38
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
39 private static final String FIELD_RIVER = "river";
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
40
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
41 private static final String FIELD_MODE = "calculation_mode";
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
42
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
43 static {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
44 // Active/deactivate facets.
9432
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
45 // BEWARE: we can only define one activity for "bundu", so we use the artifact
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
46 // as place for this
9072
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
47 FacetActivity.Registry.getInstance().register(ARTIFACT_NAME, new FacetActivity() {
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
48 @Override
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
49 public Boolean isInitialActive(final Artifact artifact, final Facet facet, final String output) {
9432
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
50
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
51 final String name = facet.getName();
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
52
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
53 if (FacetTypes.LONGITUDINAL_Q.equals(name))
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
54 return Boolean.FALSE;
d194c5b24bf8 Added bundu bzws w calculation and longitudinal sections of wspl and depth
mschaefer
parents: 9072
diff changeset
55
9072
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
56 return null;
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
57 }
02739b8c010d bundu progress (Klon FixationAnalysis +Vollmer funktioniert; Verzweigung neue Berechnungsart Bezugswst)
gernotbelger
parents: 9071
diff changeset
58 });
9071
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
59 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
60
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
61 /**
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
62 * Default constructor, because it's serializable.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
63 */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
64 public BUNDUArtifact() {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
65 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
66
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
67 /**
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
68 * Returns the name of the concrete artifact.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
69 *
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
70 * @return the name of the concrete artifact.
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
71 */
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
72 @Override
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
73 public String getName() {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
74 return ARTIFACT_NAME;
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
75 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
76
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
77 public BunduCalcMode getCalculationMode() {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
78
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
79 final String calc = getDataAsString(FIELD_MODE);
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
80 if (calc == null) {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
81 throw new IllegalArgumentException(ERROR_NO_CALCULATION_MODE);
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
82 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
83
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
84 try {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
85 return BunduCalcMode.valueOf(StringUtils.trimToEmpty(calc).toLowerCase());
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
86 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
87 catch (final Exception e) {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
88 throw new IllegalArgumentException(ERROR_INVALID_CALCULATION_MODE, e);
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
89 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
90 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
91
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
92 public String getRiver() {
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
93 return getDataAsString(FIELD_RIVER);
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
94 }
a561b882436d create module bundu (Betrieb & Unterhaltung)
gernotbelger
parents:
diff changeset
95 }

http://dive4elements.wald.intevation.org