annotate artifacts/src/main/java/org/dive4elements/river/artifacts/SedimentYieldArtifact.java @ 7196:e6f9c831a75f

SedimentYieldArtifact: Removed unneeded documentation, removed but added one TODO.
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Mon, 30 Sep 2013 06:58:09 +0200
parents 644b2f461272
children 63fd11f57379
rev   line source
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
3 *
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
7 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
8
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
9 package org.dive4elements.river.artifacts;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
10
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
11 import java.util.ArrayList;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
12 import java.util.List;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14 import org.apache.log4j.Logger;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15 import org.w3c.dom.Document;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
16
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
17 import org.dive4elements.artifactdatabase.state.DefaultOutput;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
18 import org.dive4elements.artifactdatabase.state.Facet;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
19 import org.dive4elements.artifactdatabase.state.FacetActivity;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
20 import org.dive4elements.artifactdatabase.state.State;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
21 import org.dive4elements.artifacts.Artifact;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
22 import org.dive4elements.artifacts.ArtifactFactory;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
23 import org.dive4elements.artifacts.CallMeta;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
24 import org.dive4elements.artifacts.common.utils.XMLUtils;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
25 import org.dive4elements.river.artifacts.states.DefaultState.ComputeType;
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
26 import org.dive4elements.river.artifacts.model.Calculation;
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
27 import org.dive4elements.river.artifacts.model.CalculationResult;
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
28 import org.dive4elements.river.artifacts.model.minfo.SedimentLoad;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
29 import org.dive4elements.river.artifacts.model.minfo.SedimentLoadFacet;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
30 import org.dive4elements.river.artifacts.model.minfo.SedimentLoadFactory;
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
31 import org.dive4elements.river.artifacts.model.minfo.SedimentLoadResult;
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
32 import org.dive4elements.river.artifacts.states.StaticState;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
33
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
34 import org.dive4elements.river.artifacts.model.FacetTypes;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
35
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
36 import org.dive4elements.river.utils.Formatter;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
37
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
38
7196
e6f9c831a75f SedimentYieldArtifact: Removed unneeded documentation, removed but added one TODO.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7186
diff changeset
39 /** Artifact to access sediment yield measurements. */
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
40 public class SedimentYieldArtifact
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
41 extends StaticD4EArtifact
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
42 implements FacetTypes
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
43 {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
44 /** The logger for this class. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
45 private static Logger logger =
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
46 Logger.getLogger(SedimentYieldArtifact.class);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
47
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
48 /** Artifact key name. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
49 private static final String NAME = "sedimentyield";
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
50
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
51 /** Spawn only inactive facets. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
52 static {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
53 // TODO: Move to configuration.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
54 FacetActivity.Registry.getInstance()
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
55 .register(NAME, FacetActivity.INACTIVE);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
56 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
57
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
58 /** Need to give the state an id. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
59 public static final String STATIC_STATE_NAME =
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
60 "state.sedimentyield.static";
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
61
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
62 /** One and only state to be in. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
63 protected transient State state = null;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
64
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
65 protected String DATA_NAME = "ID";
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
66
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
67 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
68 * Trivial Constructor.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
69 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
70 public SedimentYieldArtifact() {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
71 logger.debug("SedimentYieldArtifact.SedimentYieldArtifact");
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
72 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
73
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
74
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
75 /** Get artifact key name. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
76 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
77 public String getName() {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
78 return NAME;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
79 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
80
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
81
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
82 private Object getSedimentLoad() {
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
83 logger.debug("SedimentYieldArtifact.getSedimentLoad");
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
84 String id = getDataAsString(DATA_NAME);
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
85 String river = getDataAsString("river");
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
86
7196
e6f9c831a75f SedimentYieldArtifact: Removed unneeded documentation, removed but added one TODO.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7186
diff changeset
87 // TODO use cache if possible
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
88 SedimentLoad myLoad = SedimentLoadFactory.getSedimentLoadWithDataUncached(id, river);
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
89 return new CalculationResult(
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
90 new SedimentLoadResult[] {
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
91 new SedimentLoadResult(1983,2042,myLoad)
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
92 }, new Calculation());
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
93 }
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
94
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
95
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
96 /** Create a new state with bogus output. */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
97 protected State spawnState() {
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
98 state = new StaticState(STATIC_STATE_NAME) {
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
99
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
100 public Object staticCompute(List<Facet> facets) {
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
101 return getSedimentLoad();
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
102 }
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
103 };
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
104 List<Facet> fs = getFacets(STATIC_STATE_NAME);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
105 DefaultOutput output = new DefaultOutput(
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
106 "general",
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
107 "general",
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
108 "image/png",
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
109 fs,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
110 "chart");
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
111
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
112 state.getOutputs().add(output);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
113
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
114 return state;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
115 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
116
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
117
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
118 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
119 * Gets called from factory, to set things up.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
120 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
121 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
122 public void setup(
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
123 String identifier,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
124 ArtifactFactory factory,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
125 Object context,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
126 CallMeta callMeta,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
127 Document data)
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
128 {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
129 logger.debug("SedimentYieldArtifact.setup");
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
130
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
131 // Refactor? this happens at another place, too
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
132 // Store id, yield yields.
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
133 state = new StaticState(STATIC_STATE_NAME) {
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
134
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
135 public Object staticCompute(List<Facet> facets) {
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
136 return getSedimentLoad();
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
137 }
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
138 };
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
139 if (logger.isDebugEnabled()) {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
140 logger.debug(XMLUtils.toString(data));
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
141 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
142
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
143 List<Facet> fs = new ArrayList<Facet>();
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
144 String code = getDatacageIDValue(data);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
145
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
146 if (code != null) {
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
147 String name = SedimentLoadFactory.getSedimentYieldDescription(Integer.valueOf(code));
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
148
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
149 Facet facet = new SedimentLoadFacet(
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
150 0,
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
151 SEDIMENT_LOAD_COARSE,
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
152 name,
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
153 //????
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
154 ComputeType.ADVANCE, state.getID(), "hash"
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
155 );
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
156 fs.add(facet);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
157 addFacets(state.getID(), fs);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
158 addStringData(DATA_NAME, code);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
159 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
160
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
161 spawnState();
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
162 super.setup(identifier, factory, context, callMeta, data);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
163 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
164
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
165
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
166 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
167 * Get a list containing the one and only State.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
168 * @param context ignored.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
169 * @return list with one and only state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
170 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
171 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
172 protected List<State> getStates(Object context) {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
173 ArrayList<State> states = new ArrayList<State>();
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
174 states.add(getState());
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
175 return states;
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
176 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
177
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
178
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
179 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
180 * Get the "current" state (there is but one).
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
181 * @param cc ignored.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
182 * @return the "current" (only possible) state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
183 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
184 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
185 public State getCurrentState(Object cc) {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
186 return getState();
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
187 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
188
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
189
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
190 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
191 * Get the only possible state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
192 * @return the state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
193 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
194 protected State getState() {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
195 return getState(null, null);
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
196 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
197
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
198
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
199 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
200 * Get the state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
201 * @param context ignored.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
202 * @param stateID ignored.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
203 * @return the state.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
204 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
205 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
206 protected State getState(Object context, String stateID) {
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
207 return (state != null)
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
208 ? state
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
209 : spawnState();
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
210 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
211
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
212
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
213 /**
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
214 * Called via setup. Overridden to avoid cloning all data.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
215 *
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
216 * @param artifact The master-artifact.
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
217 */
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
218 @Override
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
219 protected void initialize(
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
220 Artifact artifact,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
221 Object context,
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
222 CallMeta meta)
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
223 {
7186
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
224 logger.debug("SedimentYieldArtifact.initialize");
644b2f461272 issue1435: SedimentYieldArtifact: Add functionality.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7182
diff changeset
225 importData((D4EArtifact) artifact, "river");
7182
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
226 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
227 }
87c32adb7088 Initial commit for untested standalone sediment yield artifact.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
228 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

http://dive4elements.wald.intevation.org