Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/sinfo/common/AbstractSInfoProcessor.java @ 9215:0fc9c82e744e
work on collison, flood_duration
author | gernotbelger |
---|---|
date | Tue, 03 Jul 2018 17:00:48 +0200 |
parents | 3dae6b78e1da |
children | 0dcd1cd41915 |
rev | line source |
---|---|
8884 | 1 /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde |
2 * Software engineering by | |
3 * Björnsen Beratende Ingenieure GmbH | |
4 * Dr. Schumacher Ingenieurbüro für Wasser und Umwelt | |
5 * | |
6 * This file is Free Software under the GNU AGPL (>=v3) | |
7 * and comes with ABSOLUTELY NO WARRANTY! Check out the | |
8 * documentation coming with Dive4Elements River for details. | |
9 */ | |
10 | |
8916 | 11 package org.dive4elements.river.artifacts.sinfo.common; |
8884 | 12 |
9200 | 13 import java.util.Map; |
8884 | 14 import java.util.Set; |
15 | |
16 import org.apache.log4j.Logger; | |
17 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet; | |
9203 | 18 import org.dive4elements.artifactdatabase.state.Facet; |
9200 | 19 import org.dive4elements.artifacts.Artifact; |
20 import org.dive4elements.artifacts.CallContext; | |
21 import org.dive4elements.river.artifacts.D4EArtifact; | |
22 import org.dive4elements.river.artifacts.access.RiverAccess; | |
23 import org.dive4elements.river.artifacts.common.AbstractCalculationResult; | |
24 import org.dive4elements.river.artifacts.common.IResultType; | |
25 import org.dive4elements.river.artifacts.context.RiverContext; | |
26 import org.dive4elements.river.artifacts.math.MovingAverage; | |
27 import org.dive4elements.river.artifacts.model.ZoomScale; | |
9203 | 28 import org.dive4elements.river.artifacts.resources.Resources; |
29 import org.dive4elements.river.artifacts.states.DefaultState.ComputeType; | |
8884 | 30 import org.dive4elements.river.exports.DiagramGenerator; |
9200 | 31 import org.dive4elements.river.exports.StyledSeriesBuilder; |
8884 | 32 import org.dive4elements.river.exports.process.DefaultProcessor; |
9200 | 33 import org.dive4elements.river.jfree.StyledAreaSeriesCollection; |
34 import org.dive4elements.river.jfree.StyledXYSeries; | |
8884 | 35 import org.dive4elements.river.themes.ThemeDocument; |
36 | |
37 /** | |
38 * Abstraction for some processor implementation within S-INFO. Probably this abstraction could also be used for other | |
39 * cases as well. | |
40 * | |
41 * @author Gernot Belger | |
42 * | |
43 */ | |
8916 | 44 public abstract class AbstractSInfoProcessor extends DefaultProcessor { |
8884 | 45 |
9200 | 46 protected static final double GAP_DISTANCE = 0.101; |
47 | |
8884 | 48 private final static Logger log = Logger.getLogger(AbstractSInfoProcessor.class); |
49 | |
50 private String yAxisLabel; | |
51 | |
52 private final Set<String> handled_facet_types; | |
53 | |
54 private final String i18n_axis_label; | |
55 | |
56 public AbstractSInfoProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) { | |
57 this.i18n_axis_label = i18n_axis_label; | |
58 this.handled_facet_types = handled_facet_types; | |
59 } | |
60 | |
61 @Override | |
62 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) { | |
8886 | 63 try { |
64 this.yAxisLabel = generateSeries(generator, bundle, theme, visible); | |
8884 | 65 } |
8886 | 66 catch (final Exception e) { |
67 log.error(e.getMessage(), e); | |
68 } | |
8884 | 69 } |
70 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
71 protected static final AbstractCalculationResult getResult(final DiagramGenerator generator, final ArtifactAndFacet bundle) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
72 final CallContext context = generator.getContext(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
73 final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
74 if (data == null) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
75 // Check has been here before so we keep it for security reasons |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
76 // this should never happen though. |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
77 final String facetName = bundle.getFacetName(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
78 throw new IllegalStateException("Data is null for facet: " + facetName); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
79 } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
80 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
81 return data; |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
82 } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
83 |
8884 | 84 /** |
8886 | 85 * @return The axis label |
8884 | 86 */ |
8886 | 87 protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible); |
8884 | 88 |
9200 | 89 protected final String buildSeriesForType(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible, |
90 final IResultType resultType, final Double gapDistance) { | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
91 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
92 final AbstractCalculationResult data = getResult(generator, bundle); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
93 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
94 final double[][] points = data.getStationPoints(resultType); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
95 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
96 return buildSeriesForType(points, generator, bundle, theme, visible, gapDistance); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
97 } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
98 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
99 protected final String buildSeriesForType(final double[][] points, final DiagramGenerator generator, final ArtifactAndFacet bundle, |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
100 final ThemeDocument theme, final boolean visible, final Double gapDistance) { |
9200 | 101 final CallContext context = generator.getContext(); |
102 final Map<String, String> metaData = bundle.getFacet().getMetaData(); | |
103 | |
104 final Artifact artifact = bundle.getArtifact(); | |
105 | |
106 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme); | |
107 series.putMetaData(metaData, artifact, context); | |
108 | |
109 final String facetName = bundle.getFacetName(); | |
110 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
111 final double[][] filteredPoints = filterPoints(points, context, artifact, facetName); |
9200 | 112 |
113 if (gapDistance == null) | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
114 StyledSeriesBuilder.addPoints(series, filteredPoints, true); |
9200 | 115 else |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
116 StyledSeriesBuilder.addPoints(series, filteredPoints, true, gapDistance); |
9200 | 117 |
118 generator.addAxisSeries(series, getAxisName(), visible); | |
119 | |
120 return metaData.get("Y"); | |
121 } | |
122 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
123 // protected final String buildSeriesForType1(final DiagramGenerator generator, final ArtifactAndFacet bundle, final |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
124 // ThemeDocument theme, |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
125 // final boolean visible, final IResultType resultType, final Double gapDistance) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
126 // final CallContext context = generator.getContext(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
127 // final Map<String, String> metaData = bundle.getFacet().getMetaData(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
128 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
129 // final Artifact artifact = bundle.getArtifact(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
130 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
131 // final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
132 // series.putMetaData(metaData, artifact, context); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
133 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
134 // final String facetName = bundle.getFacetName(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
135 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
136 // final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
137 // if (data == null) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
138 // // Check has been here before so we keep it for security reasons |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
139 // // this should never happen though. |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
140 // throw new IllegalStateException("Data is null for facet: " + facetName); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
141 // } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
142 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
143 // final double[][] points = generatePoints(context, artifact, data, facetName, resultType, |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
144 // bundle.getFacet().getIndex()); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
145 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
146 // if (gapDistance == null) |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
147 // StyledSeriesBuilder.addPoints(series, points, true); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
148 // else |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
149 // StyledSeriesBuilder.addPoints(series, points, true, gapDistance); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
150 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
151 // generator.addAxisSeries(series, getAxisName(), visible); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
152 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
153 // return metaData.get("Y"); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
154 // } |
9204
4f411c6ee3ae
Individual facets/themes for single years i the S-Info collisions output
mschaefer
parents:
9203
diff
changeset
|
155 |
9200 | 156 protected final String buildSeriesForTkh(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, |
157 final boolean visible) { | |
158 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
159 final AbstractTkhCalculationResult data = (AbstractTkhCalculationResult) getResult(generator, bundle); |
9200 | 160 |
161 final StyledXYSeries seriesUp = new StyledXYSeries(bundle.getFacetDescription(), theme); | |
162 final double[][] pointsUp = data.getTkhUpPoints(); | |
163 StyledSeriesBuilder.addPoints(seriesUp, pointsUp, true); | |
164 | |
165 // REMARK: we add " " because the description is misused as id, which must be unique. | |
166 final StyledXYSeries seriesDown = new StyledXYSeries(bundle.getFacetDescription() + " ", theme); | |
167 final double[][] pointsDown = data.getTkhDownPoints(); | |
168 StyledSeriesBuilder.addPoints(seriesDown, pointsDown, true); | |
169 | |
170 final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(theme); | |
171 area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN); | |
172 area.addSeries(seriesUp); | |
173 area.addSeries(seriesDown); | |
174 | |
175 generator.addAreaSeries(area, getAxisName(), visible); | |
176 | |
177 return null; | |
178 } | |
179 | |
180 private Double findRadius(final CallContext context, final Artifact artifact) { | |
181 final Double start = (Double) context.getContextValue("startkm"); | |
182 final Double end = (Double) context.getContextValue("endkm"); | |
183 | |
184 if (start == null || end == null) | |
185 return null; | |
186 | |
187 final RiverContext fc = (RiverContext) context.globalContext(); | |
188 final ZoomScale scales = (ZoomScale) fc.get("zoomscale"); | |
189 final RiverAccess access = new RiverAccess((D4EArtifact) artifact); | |
190 final String river = access.getRiverName(); | |
191 | |
192 return scales.getRadius(river, start, end); | |
193 } | |
194 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
195 private double[][] filterPoints(final double[][] points, final CallContext context, final Artifact artifact, final String facetName) { |
9200 | 196 |
197 if (facetName.endsWith(".filtered")) { | |
198 final Double radius = findRadius(context, artifact); | |
199 return movingAverage(radius, points); | |
200 } | |
201 | |
202 return points; | |
203 } | |
204 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
205 // private double[][] generatePoints(final CallContext context, final Artifact artifact, final AbstractCalculationResult |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
206 // data, final String facetName, |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
207 // final IResultType resultType, final int index) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
208 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
209 // final double[][] points = data.getStationPoints(resultType, index); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
210 // if (facetName.endsWith(".filtered")) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
211 // final Double radius = findRadius(context, artifact); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
212 // return movingAverage(radius, points); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
213 // } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
214 // |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
215 // return points; |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
216 // } |
9204
4f411c6ee3ae
Individual facets/themes for single years i the S-Info collisions output
mschaefer
parents:
9203
diff
changeset
|
217 |
9200 | 218 private double[][] movingAverage(final Double radius, final double[][] points) { |
219 | |
220 if (radius == null) | |
221 return points; | |
222 | |
223 return MovingAverage.weighted(points, radius); | |
224 } | |
225 | |
8884 | 226 @Override |
227 public final boolean canHandle(final String facettype) { | |
228 return this.handled_facet_types.contains(facettype); | |
229 } | |
230 | |
231 @Override | |
232 public final String getAxisLabel(final DiagramGenerator generator) { | |
233 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) { | |
234 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata), | |
235 // and cannot be resolved, so we need to give the resolved value as default | |
9040 | 236 // TODO: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here, |
8884 | 237 // probably the English version will also show German (CHECK) |
238 return generator.msg(this.yAxisLabel, this.yAxisLabel); | |
239 } | |
240 return generator.msg(this.i18n_axis_label, "MISSING"); | |
241 } | |
9203 | 242 |
243 protected static final Facet createFacet(final CallContext context, final String hash, final String id, final AbstractCalculationResult result, | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
244 final int resultIndex, final String axisLabel, final String facetId, final String description) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
245 final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel()); |
9215 | 246 return new SInfoResultFacet(resultIndex, facetId, facetFlowDepthFilteredDescription, axisLabel, ComputeType.ADVANCE, id, hash); |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
247 } |
8884 | 248 } |