Mercurial > dive4elements > river
annotate artifacts/src/main/java/org/dive4elements/river/artifacts/common/AbstractProcessor.java @ 9556:9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
author | gernotbelger |
---|---|
date | Tue, 23 Oct 2018 16:26:58 +0200 |
parents | 853f2dafc16e |
children | 1d4262a68f1f |
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; |
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 */ | |
9347 | 44 |
45 public abstract class AbstractProcessor extends DefaultProcessor { | |
8884 | 46 |
9200 | 47 protected static final double GAP_DISTANCE = 0.101; |
48 | |
9347 | 49 private final static Logger log = Logger.getLogger(AbstractProcessor.class); |
8884 | 50 |
51 private String yAxisLabel; | |
52 | |
53 private final Set<String> handled_facet_types; | |
54 | |
55 private final String i18n_axis_label; | |
56 | |
9347 | 57 public AbstractProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) { |
8884 | 58 this.i18n_axis_label = i18n_axis_label; |
59 this.handled_facet_types = handled_facet_types; | |
60 } | |
61 | |
62 @Override | |
63 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) { | |
8886 | 64 try { |
65 this.yAxisLabel = generateSeries(generator, bundle, theme, visible); | |
8884 | 66 } |
8886 | 67 catch (final Exception e) { |
68 log.error(e.getMessage(), e); | |
69 } | |
8884 | 70 } |
71 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
72 protected static final AbstractCalculationResult getResult(final DiagramGenerator generator, final ArtifactAndFacet bundle) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
73 final CallContext context = generator.getContext(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
74 final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
75 if (data == null) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
76 // Check has been here before so we keep it for security reasons |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
77 // this should never happen though. |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
78 final String facetName = bundle.getFacetName(); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
79 throw new IllegalStateException("Data is null for facet: " + facetName); |
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 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
82 return data; |
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 |
8884 | 85 /** |
8886 | 86 * @return The axis label |
8884 | 87 */ |
8886 | 88 protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible); |
8884 | 89 |
9200 | 90 protected final String buildSeriesForType(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible, |
91 final IResultType resultType, final Double gapDistance) { | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
92 |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
93 final AbstractCalculationResult data = getResult(generator, bundle); |
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 double[][] points = data.getStationPoints(resultType); |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
96 |
9347 | 97 return buildSeriesForPoints(points, generator, bundle, theme, visible, gapDistance); |
9205
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 |
9347 | 100 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
|
101 final ThemeDocument theme, final boolean visible, final Double gapDistance) { |
9200 | 102 final CallContext context = generator.getContext(); |
103 final Map<String, String> metaData = bundle.getFacet().getMetaData(); | |
104 | |
105 final Artifact artifact = bundle.getArtifact(); | |
106 | |
9556
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
107 final String facetDescription = bundle.getFacetDescription(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
108 final String facetName = bundle.getFacetName(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
109 |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
110 final StyledXYSeries series = new StyledXYSeries(facetName, facetDescription, theme); |
9200 | 111 series.putMetaData(metaData, artifact, context); |
112 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
113 final double[][] filteredPoints = filterPoints(points, context, artifact, facetName); |
9200 | 114 |
115 if (gapDistance == null) | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
116 StyledSeriesBuilder.addPoints(series, filteredPoints, true); |
9200 | 117 else |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
118 StyledSeriesBuilder.addPoints(series, filteredPoints, true, gapDistance); |
9200 | 119 |
120 generator.addAxisSeries(series, getAxisName(), visible); | |
121 | |
122 return metaData.get("Y"); | |
123 } | |
124 | |
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
|
125 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
|
126 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
|
127 |
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 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
|
129 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
|
130 |
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 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
|
132 |
9556
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
133 final String facetName = bundle.getFacetName(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
134 final String facetDescription = bundle.getFacetDescription(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
135 |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
136 final StyledXYSeries series = new StyledXYSeries(facetName, facetDescription, theme); |
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
|
137 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
|
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 |
9556
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
155 final String facetName = bundle.getFacetName(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
156 final String facetDescription = bundle.getFacetDescription(); |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
157 |
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
158 final StyledXYSeries seriesUp = new StyledXYSeries(facetName, facetDescription, theme); |
9200 | 159 final double[][] pointsUp = data.getTkhUpPoints(); |
160 StyledSeriesBuilder.addPoints(seriesUp, pointsUp, true); | |
161 | |
162 // REMARK: we add " " because the description is misused as id, which must be unique. | |
9556
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
163 final StyledXYSeries seriesDown = new StyledXYSeries(facetName, facetDescription + " ", theme); |
9200 | 164 final double[][] pointsDown = data.getTkhDownPoints(); |
165 StyledSeriesBuilder.addPoints(seriesDown, pointsDown, true); | |
166 | |
9556
9b8e8fc1f408
Use facetName in all processors as themeType for legend aggregation.
gernotbelger
parents:
9499
diff
changeset
|
167 final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(facetName, theme); |
9200 | 168 area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN); |
169 area.addSeries(seriesUp); | |
170 area.addSeries(seriesDown); | |
171 | |
9496
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
172 generator.addAxisDataset(area, getAxisName(), visible); |
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 return null; |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
175 } |
d8e753d0fdb9
stripedArea introduced for Assessment Scheme/Bewertungsschema
gernotbelger
parents:
9347
diff
changeset
|
176 |
9200 | 177 private Double findRadius(final CallContext context, final Artifact artifact) { |
178 final Double start = (Double) context.getContextValue("startkm"); | |
179 final Double end = (Double) context.getContextValue("endkm"); | |
180 | |
181 if (start == null || end == null) | |
182 return null; | |
183 | |
184 final RiverContext fc = (RiverContext) context.globalContext(); | |
185 final ZoomScale scales = (ZoomScale) fc.get("zoomscale"); | |
186 final RiverAccess access = new RiverAccess((D4EArtifact) artifact); | |
187 final String river = access.getRiverName(); | |
188 | |
189 return scales.getRadius(river, start, end); | |
190 } | |
191 | |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
192 private double[][] filterPoints(final double[][] points, final CallContext context, final Artifact artifact, final String facetName) { |
9200 | 193 |
194 if (facetName.endsWith(".filtered")) { | |
195 final Double radius = findRadius(context, artifact); | |
196 return movingAverage(radius, points); | |
197 } | |
198 | |
199 return points; | |
200 } | |
201 | |
202 private double[][] movingAverage(final Double radius, final double[][] points) { | |
203 | |
204 if (radius == null) | |
205 return points; | |
206 | |
207 return MovingAverage.weighted(points, radius); | |
208 } | |
209 | |
8884 | 210 @Override |
211 public final boolean canHandle(final String facettype) { | |
212 return this.handled_facet_types.contains(facettype); | |
213 } | |
214 | |
215 @Override | |
216 public final String getAxisLabel(final DiagramGenerator generator) { | |
217 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) { | |
218 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata), | |
219 // and cannot be resolved, so we need to give the resolved value as default | |
9040 | 220 // TODO: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here, |
8884 | 221 // probably the English version will also show German (CHECK) |
222 return generator.msg(this.yAxisLabel, this.yAxisLabel); | |
223 } | |
224 return generator.msg(this.i18n_axis_label, "MISSING"); | |
225 } | |
9203 | 226 |
227 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
|
228 final int resultIndex, final String axisLabel, final String facetId, final String description) { |
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
229 final String facetFlowDepthFilteredDescription = Resources.getMsg(context.getMeta(), description, description, result.getLabel()); |
9347 | 230 return new ResultFacet(resultIndex, facetId, facetFlowDepthFilteredDescription, axisLabel, ComputeType.ADVANCE, id, hash); |
9205
3dae6b78e1da
inundationDuration/floodDuration multiple columns+chartLines refactoring
gernotbelger
parents:
9204
diff
changeset
|
231 } |
8884 | 232 } |