annotate artifacts/src/main/java/org/dive4elements/river/artifacts/uinfo/UINFOArtifact.java @ 9036:c265c9fc915c

work on u-info/s-info states
author gernotbelger
date Mon, 30 Apr 2018 18:03:02 +0200
parents fb9430250899
children 13b5b515c61f
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.FacetActivity;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
14 import org.dive4elements.river.artifacts.D4EArtifact;
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
15
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
16 /**
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
17 * The default UINFO artifact.
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
18 *
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
19 * @author Gernot Belger
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
20 */
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
21 public class UINFOArtifact extends D4EArtifact {
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
22
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
23 private static final long serialVersionUID = 1L;
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
24
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
25 /** Error message that is thrown if no mode has been chosen. */
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
26 private static final String ERROR_NO_CALCULATION_MODE = "error_feed_no_calculation_mode";
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
27
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
28 /**
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
29 * Error message that is thrown if an invalid calculation mode has been chosen.
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
30 */
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
31 private static final String ERROR_INVALID_CALCULATION_MODE = "error_feed_invalid_calculation_mode";
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
32
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
33 /** The name of the artifact. */
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
34 private static final String ARTIFACT_NAME = "uinfo";
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
35
9036
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
36 private static final String FIELD_RIVER = "river";
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
37
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
38 private static final String FIELD_MODE = "calculation_mode";
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
39
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
40 static {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
41 // Active/deactivate facets.
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
42 // BEWARE: we can only define one activity for "sinfo", so we use the artifact
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
43 // as place for this
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
44 FacetActivity.Registry.getInstance().register(ARTIFACT_NAME, (artifact, facet, output) -> null);
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
45 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
46
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
47 /**
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
48 * Default constructor, because it's serializable.
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
49 */
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
50 public UINFOArtifact() {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
51 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
52
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
53 /**
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
54 * Returns the name of the concrete artifact.
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
55 *
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
56 * @return the name of the concrete artifact.
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
57 */
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
58 @Override
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
59 public String getName() {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
60 return ARTIFACT_NAME;
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
61 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
62
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
63 public UinfoCalcMode getCalculationMode() {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
64
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
65 final String calc = getDataAsString(FIELD_MODE);
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
66 if (calc == null) {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
67 throw new IllegalArgumentException(ERROR_NO_CALCULATION_MODE);
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
68 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
69
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
70 try {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
71 return UinfoCalcMode.valueOf(StringUtils.trimToEmpty(calc).toLowerCase());
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
72 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
73 catch (final Exception e) {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
74 throw new IllegalArgumentException(ERROR_INVALID_CALCULATION_MODE, e);
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
75 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
76 }
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
77
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
78 public String getRiver() {
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
79 return getDataAsString(FIELD_RIVER);
c265c9fc915c work on u-info/s-info states
gernotbelger
parents: 8996
diff changeset
80 }
8996
fb9430250899 Work on uinfo
gernotbelger
parents:
diff changeset
81 }

http://dive4elements.wald.intevation.org