annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/tkhstate/TkhState.java @ 8941:a9950a3a71e5

SINFO - tkh, configured result facets and themes Configured datacages
author gernotbelger
date Wed, 07 Mar 2018 17:36:04 +0100
parents 82998242ba84
children ee5ce13016ed
rev   line source
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
2 * Software engineering by Intevation GmbH
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
3 *
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
7 */
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
8
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents: 8914
diff changeset
9 package org.dive4elements.river.artifacts.sinfo.tkhstate;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
10
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
11 import java.util.List;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
12
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
13 import org.dive4elements.artifactdatabase.state.Facet;
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
14 import org.dive4elements.artifactdatabase.state.FacetActivity;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
15 import org.dive4elements.artifacts.Artifact;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
16 import org.dive4elements.artifacts.CallContext;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.ChartArtifact;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.artifacts.D4EArtifact;
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
19 import org.dive4elements.river.artifacts.model.Calculation;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.model.CalculationResult;
8938
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
21 import org.dive4elements.river.artifacts.model.DataFacet;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.model.EmptyFacet;
8938
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
23 import org.dive4elements.river.artifacts.model.FacetTypes;
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
24 import org.dive4elements.river.artifacts.model.ReportFacet;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
25 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
8941
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
26 import org.dive4elements.river.artifacts.sinfo.common.D50Processor;
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
27 import org.dive4elements.river.artifacts.sinfo.common.FlowDepthProcessor;
8941
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
28 import org.dive4elements.river.artifacts.sinfo.common.TauProcessor;
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
29 import org.dive4elements.river.artifacts.sinfo.common.TkhProcessor;
8941
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
30 import org.dive4elements.river.artifacts.sinfo.common.VelocityProcessor;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
31 import org.dive4elements.river.artifacts.states.DefaultState;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
32
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
33 /** State in which a waterlevel has been calculated. */
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
34 public class TkhState extends DefaultState {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
35
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
36 /// ** The log that is used in this state. */
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
37 // private static Logger log = Logger.getLogger(FlowDepthState.class);
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
38
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
39 private static final long serialVersionUID = 1L;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
40
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
41 static {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
42 // Active/deactivate facets.
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
43 // BEWARE: we can only define one activity for "sinfo", so this is not the right place....
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
44 FacetActivity.Registry.getInstance().register("sinfo", new FacetActivity() {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
45 @Override
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
46 public Boolean isInitialActive(final Artifact artifact, final Facet facet, final String output) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
47
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
48 /* only */
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
49 if ("sinfo_tkk".equals(output)) {
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
50 final String name = facet.getName();
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
51 if (FlowDepthProcessor.FACET_FLOW_DEPTH_FILTERED.equals(name))
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
52 return Boolean.FALSE;
8941
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
53 if (VelocityProcessor.FACET_TKH_VELOCITY_FILTERED.equals(name))
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
54 return Boolean.FALSE;
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
55 if (TauProcessor.FACET_TKH_TAU_FILTERED.equals(name))
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
56 return Boolean.FALSE;
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
57 if (D50Processor.FACET_TKH_D50_FILTERED.equals(name))
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
58 return Boolean.FALSE;
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
59 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
60
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
61 return null;
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
62 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
63 });
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
64 }
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
65
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
66 /**
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
67 * From this state can only be continued trivially.
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
68 */
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
69 @Override
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
70 protected String getUIProvider() {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
71 return "continue";
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
72 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
73
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
74 @Override
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
75 public Object computeFeed(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
76 // FIXME: why is this necessary?
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
77 if (artifact instanceof ChartArtifact) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
78 facets.add(new EmptyFacet());
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
79 return null;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
80 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
81
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
82 return compute((SINFOArtifact) artifact, context, hash, facets, old);
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
83 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
84
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
85 @Override
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
86 public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
87 if (artifact instanceof ChartArtifact) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
88 facets.add(new EmptyFacet());
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
89 return null;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
90 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
91 return compute((SINFOArtifact) artifact, context, hash, facets, old);
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
92 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
93
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
94 /**
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
95 * Compute result or returned object from cache, create facets.
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
96 *
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
97 * @param old
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
98 * Object that was cached.
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
99 */
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
100 private Object compute(final SINFOArtifact sinfo, final CallContext context, final String hash, final List<Facet> facets, final Object old) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
101
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
102 final CalculationResult res = doCompute(sinfo, context, old);
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
103
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
104 if (facets == null)
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
105 return res;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
106
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
107 final TkhCalculationResults results = (TkhCalculationResults) res.getData();
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
108
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
109 /* add themes for chart, for each result */
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
110 final List<TkhCalculationResult> resultList = results.getResults();
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
111 for (int index = 0; index < resultList.size(); index++) {
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
112
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
113 final TkhCalculationResult result = resultList.get(index);
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
114
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
115 facets.add(TkhProcessor.createTkhFacet(context, hash, this.id, result, index));
8940
82998242ba84 Preparing for additional outputs of SINFO-Tkh
gernotbelger
parents: 8938
diff changeset
116
8941
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
117 facets.add(FlowDepthProcessor.createFlowDepthFacet(context, hash, this.id, result, index));
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
118 facets.add(VelocityProcessor.createVelocityFacet(context, hash, this.id, result, index));
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
119 facets.add(D50Processor.createD50Facet(context, hash, this.id, result, index));
a9950a3a71e5 SINFO - tkh, configured result facets and themes
gernotbelger
parents: 8940
diff changeset
120 facets.add(TauProcessor.createTauFacet(context, hash, this.id, result, index));
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
121 }
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
122
8938
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
123 if (!resultList.isEmpty()) {
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
124 facets.add(new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, this.id));
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
125 facets.add(new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, this.id));
9c02733a1b3c Work on Sinfo-tkh - exports; using same logic for wst-description as winfo
gernotbelger
parents: 8916
diff changeset
126 }
8916
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
127
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
128 final Calculation report = res.getReport();
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
129
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
130 if (report.hasProblems())
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
131 facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
132
5d5d0051723f Working on outputmodes of tkh calculation
gernotbelger
parents: 8915
diff changeset
133 return res;
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
134 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
135
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
136 private CalculationResult doCompute(final SINFOArtifact sinfo, final CallContext context, final Object old) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
137 if (old instanceof CalculationResult)
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
138 return (CalculationResult) old;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
139
8915
d9dbf0b74bc2 Refaktoring of flow depth calculation, extracting tkh part. First implementation of tkh calculation.
gernotbelger
parents: 8914
diff changeset
140 return new TkhCalculation(context).calculate(sinfo);
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
141 }
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents:
diff changeset
142 }

http://dive4elements.wald.intevation.org