Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/common/AbstractProcessor.java @ 9496:d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
author | gernotbelger |
---|---|
date | Wed, 26 Sep 2018 15:48:05 +0200 |
parents | 08f46ccd37ba |
children | 853f2dafc16e |
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 | |
9347 | 11 package org.dive4elements.river.artifacts.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.context.RiverContext; | |
24 import org.dive4elements.river.artifacts.math.MovingAverage; | |
9229
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
25 import org.dive4elements.river.artifacts.model.WQKms; |
9200 | 26 import org.dive4elements.river.artifacts.model.ZoomScale; |
9203 | 27 import org.dive4elements.river.artifacts.resources.Resources; |
9347 | 28 import org.dive4elements.river.artifacts.sinfo.common.AbstractTkhCalculationResult; |
9203 | 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; |
9496
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
33 import org.dive4elements.river.jfree.StripedAreaDataset; |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
34 import org.dive4elements.river.jfree.StripedAreaDataset.Stripe; |
9200 | 35 import org.dive4elements.river.jfree.StyledAreaSeriesCollection; |
36 import org.dive4elements.river.jfree.StyledXYSeries; | |
8884 | 37 import org.dive4elements.river.themes.ThemeDocument; |
38 | |
39 /** | |
40 * Abstraction for some processor implementation within S-INFO. Probably this abstraction could also be used for other | |
41 * cases as well. | |
42 * | |
43 * @author Gernot Belger | |
44 * | |
45 */ | |
9347 | 46 |
47 public abstract class AbstractProcessor extends DefaultProcessor { | |
8884 | 48 |
9200 | 49 protected static final double GAP_DISTANCE = 0.101; |
50 | |
9347 | 51 private final static Logger log = Logger.getLogger(AbstractProcessor.class); |
8884 | 52 |
53 private String yAxisLabel; | |
54 | |
55 private final Set<String> handled_facet_types; | |
56 | |
57 private final String i18n_axis_label; | |
58 | |
9347 | 59 public AbstractProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) { |
8884 | 60 this.i18n_axis_label = i18n_axis_label; |
61 this.handled_facet_types = handled_facet_types; | |
62 } | |
63 | |
64 @Override | |
65 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) { | |
8886 | 66 try { |
67 this.yAxisLabel = generateSeries(generator, bundle, theme, visible); | |
8884 | 68 } |
8886 | 69 catch (final Exception e) { |
70 log.error(e.getMessage(), e); | |
71 } | |
8884 | 72 } |
73 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
74 protected static final AbstractCalculationResult getResult(final DiagramGenerator generator, final ArtifactAndFacet bundle) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
75 final CallContext context = generator.getContext(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
76 final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
77 if (data == null) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
78 // Check has been here before so we keep it for security reasons |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
79 // this should never happen though. |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
80 final String facetName = bundle.getFacetName(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
81 throw new IllegalStateException("Data is null for facet: " + facetName); |
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 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
84 return data; |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
85 } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
86 |
8884 | 87 /** |
8886 | 88 * @return The axis label |
8884 | 89 */ |
8886 | 90 protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible); |
8884 | 91 |
9200 | 92 protected final String buildSeriesForType(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible, |
93 final IResultType resultType, final Double gapDistance) { | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
94 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
95 final AbstractCalculationResult data = getResult(generator, bundle); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
96 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
97 final double[][] points = data.getStationPoints(resultType); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
98 |
9347 | 99 return buildSeriesForPoints(points, generator, bundle, theme, visible, gapDistance); |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
100 } |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
101 |
9347 | 102 protected final String buildSeriesForPoints(final double[][] points, final DiagramGenerator generator, final ArtifactAndFacet bundle, |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
103 final ThemeDocument theme, final boolean visible, final Double gapDistance) { |
9200 | 104 final CallContext context = generator.getContext(); |
105 final Map<String, String> metaData = bundle.getFacet().getMetaData(); | |
106 | |
107 final Artifact artifact = bundle.getArtifact(); | |
108 | |
109 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme); | |
110 series.putMetaData(metaData, artifact, context); | |
111 | |
112 final String facetName = bundle.getFacetName(); | |
113 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
114 final double[][] filteredPoints = filterPoints(points, context, artifact, facetName); |
9200 | 115 |
116 if (gapDistance == null) | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
117 StyledSeriesBuilder.addPoints(series, filteredPoints, true); |
9200 | 118 else |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
119 StyledSeriesBuilder.addPoints(series, filteredPoints, true, gapDistance); |
9200 | 120 |
121 generator.addAxisSeries(series, getAxisName(), visible); | |
122 | |
123 return metaData.get("Y"); | |
124 } | |
125 | |
9229
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
126 protected final String buildStepLineSeriesForType(final double[][] points, final DiagramGenerator generator, final ArtifactAndFacet bundle, |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
127 final ThemeDocument theme, final boolean visible) { |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
128 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
129 final CallContext context = generator.getContext(); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
130 final Map<String, String> metaData = bundle.getFacet().getMetaData(); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
131 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
132 final Artifact artifact = bundle.getArtifact(); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
133 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
134 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
135 series.putMetaData(metaData, artifact, context); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
136 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
137 final String facetName = bundle.getFacetName(); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
138 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
139 // Create WQKms to use the step points method |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
140 // REMARK: must have any values in w array; not sure whether the name is needed |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
141 final WQKms wqkms = new WQKms(points[0], points[1], points[1], facetName); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
142 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
143 StyledSeriesBuilder.addStepPointsKmQ(series, wqkms); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
144 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
145 generator.addAxisSeries(series, getAxisName(), visible); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
146 |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
147 return metaData.get("Y"); |
0dcd1cd41915
Different themes/facets for left bank and right bank infrastructures in S-Info flood durations, some fixmes done
mschaefer
parents:
9215
diff
changeset
|
148 } |
9204
4f411c6ee3ae
Individual facets/themes for single years i the S-Info collisions output
mschaefer
parents:
9203
diff
changeset
|
149 |
9200 | 150 protected final String buildSeriesForTkh(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, |
151 final boolean visible) { | |
152 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
153 final AbstractTkhCalculationResult data = (AbstractTkhCalculationResult) getResult(generator, bundle); |
9200 | 154 |
155 final StyledXYSeries seriesUp = new StyledXYSeries(bundle.getFacetDescription(), theme); | |
156 final double[][] pointsUp = data.getTkhUpPoints(); | |
157 StyledSeriesBuilder.addPoints(seriesUp, pointsUp, true); | |
158 | |
159 // REMARK: we add " " because the description is misused as id, which must be unique. | |
160 final StyledXYSeries seriesDown = new StyledXYSeries(bundle.getFacetDescription() + " ", theme); | |
161 final double[][] pointsDown = data.getTkhDownPoints(); | |
162 StyledSeriesBuilder.addPoints(seriesDown, pointsDown, true); | |
163 | |
164 final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(theme); | |
165 area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN); | |
166 area.addSeries(seriesUp); | |
167 area.addSeries(seriesDown); | |
168 | |
9496
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
169 generator.addAxisDataset(area, getAxisName(), visible); |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
170 |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
171 return null; |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
172 } |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
173 |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
174 protected final String buildStripedAreaSeries(final Stripe[] stripes, final DiagramGenerator generator, final ArtifactAndFacet bundle, |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
175 final ThemeDocument theme, final boolean visible) { |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
176 |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
177 final StripedAreaDataset dataset = new StripedAreaDataset(theme); |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
178 |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
179 for (final Stripe stripe : stripes) |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
180 dataset.addStripe(stripe); |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
181 |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
182 generator.addAxisDataset(dataset, getAxisName(), visible); |
9200 | 183 |
184 return null; | |
185 } | |
186 | |
187 private Double findRadius(final CallContext context, final Artifact artifact) { | |
188 final Double start = (Double) context.getContextValue("startkm"); | |
189 final Double end = (Double) context.getContextValue("endkm"); | |
190 | |
191 if (start == null || end == null) | |
192 return null; | |
193 | |
194 final RiverContext fc = (RiverContext) context.globalContext(); | |
195 final ZoomScale scales = (ZoomScale) fc.get("zoomscale"); | |
196 final RiverAccess access = new RiverAccess((D4EArtifact) artifact); | |
197 final String river = access.getRiverName(); | |
198 | |
199 return scales.getRadius(river, start, end); | |
200 } | |
201 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
202 private double[][] filterPoints(final double[][] points, final CallContext context, final Artifact artifact, final String facetName) { |
9200 | 203 |
204 if (facetName.endsWith(".filtered")) { | |
205 final Double radius = findRadius(context, artifact); | |
206 return movingAverage(radius, points); | |
207 } | |
208 | |
209 return points; | |
210 } | |
211 | |
212 private double[][] movingAverage(final Double radius, final double[][] points) { | |
213 | |
214 if (radius == null) | |
215 return points; | |
216 | |
217 return MovingAverage.weighted(points, radius); | |
218 } | |
219 | |
8884 | 220 @Override |
221 public final boolean canHandle(final String facettype) { | |
222 return this.handled_facet_types.contains(facettype); | |
223 } | |
224 | |
225 @Override | |
226 public final String getAxisLabel(final DiagramGenerator generator) { | |
227 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) { | |
228 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata), | |
229 // and cannot be resolved, so we need to give the resolved value as default | |
9040 | 230 // TODO: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here, |
8884 | 231 // probably the English version will also show German (CHECK) |
232 return generator.msg(this.yAxisLabel, this.yAxisLabel); | |
233 } | |
234 return generator.msg(this.i18n_axis_label, "MISSING"); | |
235 } | |
9203 | 236 |
237 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
|
238 final int resultIndex, final String axisLabel, final String facetId, final String description) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
239 final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel()); |
9347 | 240 return new ResultFacet(resultIndex, facetId, facetFlowDepthFilteredDescription, axisLabel, ComputeType.ADVANCE, id, hash); |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
241 } |
8884 | 242 } |