annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/UINFOArtifact.java @ 8996:fb9430250899

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

http://dive4elements.wald.intevation.org