annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/flowdepth/FlowDepthState.java @ 8914:e3519c3e7a0a

Workflow for SINFO-Transport bodies heights inclduing winfo calculation
author gernotbelger
date Tue, 27 Feb 2018 18:06:52 +0100
parents 7a8c12706834
children 5d5d0051723f
rev   line source
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
2 * Software engineering by Intevation GmbH
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
3 *
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
7 */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
8
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
9 package org.dive4elements.river.artifacts.sinfo.flowdepth;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
10
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
11 import java.util.List;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
12
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
13 import org.dive4elements.artifactdatabase.state.Facet;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
14 import org.dive4elements.artifacts.CallContext;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
15 import org.dive4elements.river.artifacts.ChartArtifact;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
16 import org.dive4elements.river.artifacts.D4EArtifact;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
17 import org.dive4elements.river.artifacts.model.Calculation;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
18 import org.dive4elements.river.artifacts.model.CalculationResult;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
19 import org.dive4elements.river.artifacts.model.DataFacet;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
20 import org.dive4elements.river.artifacts.model.EmptyFacet;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
21 import org.dive4elements.river.artifacts.model.FacetTypes;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
22 import org.dive4elements.river.artifacts.model.ReportFacet;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
23 import org.dive4elements.river.artifacts.resources.Resources;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
24 import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
25 import org.dive4elements.river.artifacts.states.DefaultState;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
26
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
27 /** State in which a waterlevel has been calculated. */
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
28 public class FlowDepthState extends DefaultState {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
29
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
30 /// ** The log that is used in this state. */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
31 // private static Logger log = Logger.getLogger(FlowDepthState.class);
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
32
8877
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
33 private static final long serialVersionUID = 1L;
9f7a285b0ee3 Some work on SINFO FlowDepth
gernotbelger
parents: 8854
diff changeset
34
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
35 private static final String I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth.filtered.description";
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
36
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
37 private static final String I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION = "sinfo.facet.flow_depth.tkh.filtered.description";
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
38
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
39 private static final String I18N_FACET_TKH_DESCRIPTION = "sinfo.facet.tkh.description";
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
40
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
41 private static final String SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL = "sinfo.chart.flow_depth.yaxis.label";
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
42
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
43 private static final String SINFO_CHART_TKX_YAXIS_LABEL = "sinfo.chart.tkh.yaxis.label";
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
44
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
45 /**
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
46 * From this state can only be continued trivially.
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
47 */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
48 @Override
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
49 protected String getUIProvider() {
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
50 return "continue";
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
51 }
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
52
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
53 @Override
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
54 public Object computeFeed(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
55 // FIXME: why is this necessary?
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
56 if (artifact instanceof ChartArtifact) {
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
57 facets.add(new EmptyFacet());
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
58 return null;
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
59 }
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
60
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
61 return compute((SINFOArtifact) artifact, context, hash, facets, old);
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
62 }
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
63
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
64 @Override
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
65 public Object computeAdvance(final D4EArtifact artifact, final String hash, final CallContext context, final List<Facet> facets, final Object old) {
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
66 if (artifact instanceof ChartArtifact) {
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
67 facets.add(new EmptyFacet());
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
68 return null;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
69 }
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
70 return compute((SINFOArtifact) artifact, context, hash, facets, old);
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
71 }
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
72
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
73 /**
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
74 * Compute result or returned object from cache, create facets.
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
75 *
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
76 * @param old
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
77 * Object that was cached.
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
78 */
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
79 private Object compute(final SINFOArtifact sinfo, final CallContext context, final String hash, final List<Facet> facets, final Object old) {
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
80
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
81 final CalculationResult res = doCompute(sinfo, context, old);
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
82
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
83 if (facets == null)
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
84 return res;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
85
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
86 final FlowDepthCalculationResults results = (FlowDepthCalculationResults) res.getData();
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
87
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
88 /* add themes for chart, for each result */
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
89 final List<FlowDepthCalculationResult> resultList = results.getResults();
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
90 for (int index = 0; index < resultList.size(); index++) {
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
91
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
92 final FlowDepthCalculationResult result = resultList.get(index);
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
93
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
94 /* filtered (zoom dependent mean) flow depth */
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
95 final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
96 I18N_FACET_FLOW_DEPTH_FILTERED_DESCRIPTION, result.getLabel());
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
97 facets.add(new FlowDepthFacet(index, FlowDepthProcessor.FACET_FLOW_DEPTH_FILTERED, facetFlowDepthFilteredDescription,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
98 SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL, ComputeType.ADVANCE, this.id, hash));
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
99
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
100 if (results.isUseTkh()) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
101 /* filtered (zoom dependent mean) flow depth including tkh */
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
102 final String facetFlowDepthTkhFilteredDescription = Resources.getMsg(context.getMeta(), I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
103 I18N_FACET_FLOW_DEPTH_TKH_FILTERED_DESCRIPTION, result.getLabel());
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
104 facets.add(new FlowDepthFacet(index, FlowDepthProcessor.FACET_FLOW_DEPTH_TKH_FILTERED, facetFlowDepthTkhFilteredDescription,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
105 SINFO_CHART_FLOW_DEPTH_YAXIS_LABEL, ComputeType.ADVANCE, this.id, hash));
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
106
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
107 // FIXME: add other themes
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
108 // - Streckenfavoriten
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
109
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
110 // FIXME:
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
111 // - Gemittelte Linie der Fließtiefe mitsamt TKH
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
112 // - Transportkörperhöhen (oben/unten/schraffur)
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
113 final String facetTkhDescription = Resources.getMsg(context.getMeta(), I18N_FACET_TKH_DESCRIPTION, I18N_FACET_TKH_DESCRIPTION,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
114 result.getLabel());
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
115 facets.add(new FlowDepthFacet(index, TkhProcessor.FACET_TKH, facetTkhDescription, SINFO_CHART_TKX_YAXIS_LABEL, ComputeType.ADVANCE, this.id,
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
116 hash));
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
117 }
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
118
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
119 // FIXME: Datenkorbkonfiguration
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
120 }
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
121
8884
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
122 if (!resultList.isEmpty()) {
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
123 final Facet csv = new DataFacet(FacetTypes.CSV, "CSV data", ComputeType.ADVANCE, hash, this.id);
7a8c12706834 Work on SINFO-FlowDepth
gernotbelger
parents: 8879
diff changeset
124 final Facet pdf = new DataFacet(FacetTypes.PDF, "PDF data", ComputeType.ADVANCE, hash, this.id);
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
125
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
126 facets.add(csv);
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
127 facets.add(pdf);
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
128 }
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
129
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
130 final Calculation report = res.getReport();
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
131
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
132 if (report.hasProblems()) {
8879
64ca63f79f6f Further work on SINFO-FlowDepth
gernotbelger
parents: 8877
diff changeset
133 facets.add(new ReportFacet(ComputeType.ADVANCE, hash, this.id));
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
134 }
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
135
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
136 return res;
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
137 }
8914
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
138
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
139 private CalculationResult doCompute(final SINFOArtifact sinfo, final CallContext context, final Object old) {
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
140 if (old instanceof CalculationResult)
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
141 return (CalculationResult) old;
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
142
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
143 return new FlowDepthCalculation(context).calculate(sinfo);
e3519c3e7a0a Workflow for SINFO-Transport bodies heights inclduing winfo calculation
gernotbelger
parents: 8884
diff changeset
144 }
8854
7bbfb24e6eec SINFO - first prototype of BArt Fließtiefen
gernotbelger
parents:
diff changeset
145 }

http://dive4elements.wald.intevation.org