Mercurial > dive4elements > river

annotate artifacts/src/main/java/org/dive4elements/river/artifacts/states/DurationCurveState.java @ 5863:4897a58c8746

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
River artifacts: Added new copyright headers.
author Sascha L. Teichmann <teichmann@intevation.de>
date Sun, 28 Apr 2013 14:40:59 +0200
parents 5aa05a7a34b7
children 73da40528cf2
rev   line source
5863
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
2 * Software engineering by Intevation GmbH
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
3 *
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
6 * documentation coming with Dive4Elements River for details.
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
7 */
4897a58c8746 River artifacts: Added new copyright headers.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 5838
diff changeset
8
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
9 package org.dive4elements.river.artifacts.states;
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
10
687
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
11 import java.util.List;
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
12
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
13 import org.apache.log4j.Logger;
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
14
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
15 import org.dive4elements.artifacts.CallContext;
709
3b7e9ddf6bb1 New model to transport data and error reports of calculations.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 705
diff changeset
16
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
17 import org.dive4elements.artifactdatabase.state.Facet;
687
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
18
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
19 import org.dive4elements.river.artifacts.access.RangeAccess;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
20 import org.dive4elements.river.artifacts.FLYSArtifact;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
21 import org.dive4elements.river.artifacts.WINFOArtifact;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
22 import org.dive4elements.river.artifacts.ChartArtifact;
709
3b7e9ddf6bb1 New model to transport data and error reports of calculations.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 705
diff changeset
23
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
24 import org.dive4elements.river.artifacts.model.DurationCurveFacet;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
25 import org.dive4elements.river.artifacts.model.FacetTypes;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
26 import org.dive4elements.river.artifacts.model.WQDay;
703
af3b5d9e91a4 Generate data facets for the computed states.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 697
diff changeset
27
5831
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
28 import org.dive4elements.river.artifacts.model.DataFacet;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
29 import org.dive4elements.river.artifacts.model.ReportFacet;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
30 import org.dive4elements.river.artifacts.model.EmptyFacet;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
31 import org.dive4elements.river.artifacts.model.CalculationResult;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
32
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
33 import org.dive4elements.river.artifacts.resources.Resources;
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
34
bd047b71ab37 Repaired internal references
Sascha L. Teichmann <teichmann@intevation.de>
parents: 4848
diff changeset
35 import org.dive4elements.river.utils.FLYSUtils;
1103
e0243627ba62 Use FLYSUtils.getRiver instead of WINFOArtifact.getRiver.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 1029
diff changeset
36
703
af3b5d9e91a4 Generate data facets for the computed states.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 697
diff changeset
37
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
38 /**
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
39 * The final state that will be reached after the duration curve calculation
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
40 * mode has been chosen.
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
41 *
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
42 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
43 */
692
22e4bffbe240 Generated facets for each output aspect.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 689
diff changeset
44 public class DurationCurveState
22e4bffbe240 Generated facets for each output aspect.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 689
diff changeset
45 extends DefaultState
22e4bffbe240 Generated facets for each output aspect.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 689
diff changeset
46 implements FacetTypes
22e4bffbe240 Generated facets for each output aspect.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 689
diff changeset
47 {
1029
3f3988bb6284 Picky Cosmetics.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 742
diff changeset
48 /** The logger that is used in this state. */
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
49 private static Logger logger = Logger.getLogger(DurationCurveState.class);
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
50
660
627be3ca1ab6 code clean up in states
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 383
diff changeset
51 public DurationCurveState() {
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
52 }
687
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
53
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
54
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
55 @Override
697
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
56 public Object computeAdvance(
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
57 FLYSArtifact artifact,
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
58 String hash,
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
59 CallContext context,
742
c09c9e05ecfa Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 711
diff changeset
60 List<Facet> facets,
697
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
61 Object old
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
62 ) {
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
63 if (artifact instanceof WINFOArtifact) {
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
64 WINFOArtifact winfo = (WINFOArtifact)artifact;
692
22e4bffbe240 Generated facets for each output aspect.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 689
diff changeset
65
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
66 CalculationResult res;
697
b972eba2ed8a Removed ComputeCallback because this was thought too complicated. Fixed issue with facets not be re-generated if same state is entered again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 696
diff changeset
67
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
68 if (old instanceof CalculationResult) {
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
69 res = (CalculationResult)old;
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
70 }
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
71 else {
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
72 res = winfo.getDurationCurveData();
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
73 }
705
853dceead0f4 Only generate facets when needed.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 703
diff changeset
74
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
75 WQDay wqday = (WQDay)res.getData();
711
69c8541edcc7 Generate report facets if there are problems with the calculations.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 709
diff changeset
76
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
77 if (wqday != null && facets != null) {
4848
7887112c37cc DurationCurveState: Use RangeAccess.getLocations instead of FLYSUtils.getLocations.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 2718
diff changeset
78 RangeAccess rangeAccess = new RangeAccess(winfo, context);
2718
9ea3ac23bd9d Include km in duration curve facets names.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 2178
diff changeset
79 // Create an i18ed name for a (w or q) duration curve facet.
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
80 Object[] args = new Object[] {
2718
9ea3ac23bd9d Include km in duration curve facets names.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 2178
diff changeset
81 FLYSUtils.getRiver(winfo).getName(),
4848
7887112c37cc DurationCurveState: Use RangeAccess.getLocations instead of FLYSUtils.getLocations.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 2718
diff changeset
82 rangeAccess.getLocations()[0]
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
83 };
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
84
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
85 String nameW = Resources.getMsg(
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
86 context.getMeta(),
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
87 "chart.duration.curve.curve.w",
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
88 "",
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
89 args);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
90
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
91 String nameQ = Resources.getMsg(
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
92 context.getMeta(),
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
93 "chart.duration.curve.curve.q",
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
94 "",
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
95 args);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
96
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
97 Facet w = new DurationCurveFacet(DURATION_W, nameW);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
98 Facet q = new DurationCurveFacet(DURATION_Q, nameQ);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
99
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
100 facets.add(w);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
101 facets.add(q);
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
102
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
103 facets.add(new DataFacet(CSV, "CSV data"));
2178
1d7fb2cabfc7 Issue 138.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 2134
diff changeset
104 facets.add(new DataFacet(PDF, "PDF data"));
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
105
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
106 if (res.getReport().hasProblems()) {
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
107 facets.add(new ReportFacet());
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
108 }
711
69c8541edcc7 Generate report facets if there are problems with the calculations.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 709
diff changeset
109 }
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
110
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
111 return res;
705
853dceead0f4 Only generate facets when needed.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 703
diff changeset
112 }
2134
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
113 else if (artifact instanceof ChartArtifact) {
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
114 ChartArtifact chart = (ChartArtifact)artifact;
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
115 facets.add(new EmptyFacet());
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
116 return null;
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
117 }
024d986b4f5b 'New Chart' for duration curve.
Raimund Renkert <raimund.renkert@intevation.de>
parents: 1103
diff changeset
118 return null;
687
06689035024c Added a compute() method to WINFOArtifact which acts as a dispatcher for different computations. It triggers a calculation based on ComputeCallbacks that are generated by the current states.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 661
diff changeset
119 }
383
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
120 }
dcc3cd962c0e Enhanced the transition model to reach a state that creates duration curves.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
diff changeset
121 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
http://dive4elements.wald.intevation.org