|
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; |
|
9200
|
18 import org.dive4elements.artifacts.Artifact; |
|
|
19 import org.dive4elements.artifacts.CallContext; |
|
|
20 import org.dive4elements.river.artifacts.D4EArtifact; |
|
|
21 import org.dive4elements.river.artifacts.access.RiverAccess; |
|
|
22 import org.dive4elements.river.artifacts.common.AbstractCalculationResult; |
|
|
23 import org.dive4elements.river.artifacts.common.IResultType; |
|
|
24 import org.dive4elements.river.artifacts.context.RiverContext; |
|
|
25 import org.dive4elements.river.artifacts.math.MovingAverage; |
|
|
26 import org.dive4elements.river.artifacts.model.ZoomScale; |
|
8884
|
27 import org.dive4elements.river.exports.DiagramGenerator; |
|
9200
|
28 import org.dive4elements.river.exports.StyledSeriesBuilder; |
|
8884
|
29 import org.dive4elements.river.exports.process.DefaultProcessor; |
|
9200
|
30 import org.dive4elements.river.jfree.StyledAreaSeriesCollection; |
|
|
31 import org.dive4elements.river.jfree.StyledXYSeries; |
|
8884
|
32 import org.dive4elements.river.themes.ThemeDocument; |
|
|
33 |
|
|
34 /** |
|
|
35 * Abstraction for some processor implementation within S-INFO. Probably this abstraction could also be used for other |
|
|
36 * cases as well. |
|
|
37 * |
|
|
38 * @author Gernot Belger |
|
|
39 * |
|
|
40 */ |
|
8916
|
41 public abstract class AbstractSInfoProcessor extends DefaultProcessor { |
|
8884
|
42 |
|
9200
|
43 protected static final double GAP_DISTANCE = 0.101; |
|
|
44 |
|
8884
|
45 private final static Logger log = Logger.getLogger(AbstractSInfoProcessor.class); |
|
|
46 |
|
|
47 private String yAxisLabel; |
|
|
48 |
|
|
49 private final Set<String> handled_facet_types; |
|
|
50 |
|
|
51 private final String i18n_axis_label; |
|
|
52 |
|
|
53 public AbstractSInfoProcessor(final String i18n_axis_label, final Set<String> handled_facet_types) { |
|
|
54 this.i18n_axis_label = i18n_axis_label; |
|
|
55 this.handled_facet_types = handled_facet_types; |
|
|
56 } |
|
|
57 |
|
|
58 @Override |
|
|
59 public final void doOut(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible) { |
|
8886
|
60 try { |
|
|
61 this.yAxisLabel = generateSeries(generator, bundle, theme, visible); |
|
8884
|
62 } |
|
8886
|
63 catch (final Exception e) { |
|
|
64 log.error(e.getMessage(), e); |
|
|
65 } |
|
8884
|
66 } |
|
|
67 |
|
|
68 /** |
|
8886
|
69 * @return The axis label |
|
8884
|
70 */ |
|
8886
|
71 protected abstract String generateSeries(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible); |
|
8884
|
72 |
|
9200
|
73 protected final String buildSeriesForType(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, final boolean visible, |
|
|
74 final IResultType resultType, final Double gapDistance) { |
|
|
75 final CallContext context = generator.getContext(); |
|
|
76 final Map<String, String> metaData = bundle.getFacet().getMetaData(); |
|
|
77 |
|
|
78 final Artifact artifact = bundle.getArtifact(); |
|
|
79 |
|
|
80 final StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme); |
|
|
81 series.putMetaData(metaData, artifact, context); |
|
|
82 |
|
|
83 final String facetName = bundle.getFacetName(); |
|
|
84 |
|
|
85 final AbstractCalculationResult data = (AbstractCalculationResult) bundle.getData(context); |
|
|
86 if (data == null) { |
|
|
87 // Check has been here before so we keep it for security reasons |
|
|
88 // this should never happen though. |
|
|
89 throw new IllegalStateException("Data is null for facet: " + facetName); |
|
|
90 } |
|
|
91 |
|
|
92 final double[][] points = generatePoints(context, artifact, data, facetName, resultType); |
|
|
93 |
|
|
94 if (gapDistance == null) |
|
|
95 StyledSeriesBuilder.addPoints(series, points, true); |
|
|
96 else |
|
|
97 StyledSeriesBuilder.addPoints(series, points, true, gapDistance); |
|
|
98 |
|
|
99 generator.addAxisSeries(series, getAxisName(), visible); |
|
|
100 |
|
|
101 return metaData.get("Y"); |
|
|
102 } |
|
|
103 |
|
|
104 protected final String buildSeriesForTkh(final DiagramGenerator generator, final ArtifactAndFacet bundle, final ThemeDocument theme, |
|
|
105 final boolean visible) { |
|
|
106 final CallContext context = generator.getContext(); |
|
|
107 |
|
|
108 final String facetName = bundle.getFacetName(); |
|
|
109 final AbstractTkhCalculationResult data = (AbstractTkhCalculationResult) bundle.getData(context); |
|
|
110 if (data == null) { |
|
|
111 // Check has been here before so we keep it for security reasons |
|
|
112 // this should never happen though. |
|
|
113 throw new IllegalStateException("Data is null for facet: " + facetName); |
|
|
114 } |
|
|
115 |
|
|
116 final StyledXYSeries seriesUp = new StyledXYSeries(bundle.getFacetDescription(), theme); |
|
|
117 final double[][] pointsUp = data.getTkhUpPoints(); |
|
|
118 StyledSeriesBuilder.addPoints(seriesUp, pointsUp, true); |
|
|
119 |
|
|
120 // REMARK: we add " " because the description is misused as id, which must be unique. |
|
|
121 final StyledXYSeries seriesDown = new StyledXYSeries(bundle.getFacetDescription() + " ", theme); |
|
|
122 final double[][] pointsDown = data.getTkhDownPoints(); |
|
|
123 StyledSeriesBuilder.addPoints(seriesDown, pointsDown, true); |
|
|
124 |
|
|
125 final StyledAreaSeriesCollection area = new StyledAreaSeriesCollection(theme); |
|
|
126 area.setMode(StyledAreaSeriesCollection.FILL_MODE.BETWEEN); |
|
|
127 area.addSeries(seriesUp); |
|
|
128 area.addSeries(seriesDown); |
|
|
129 |
|
|
130 generator.addAreaSeries(area, getAxisName(), visible); |
|
|
131 |
|
|
132 return null; |
|
|
133 } |
|
|
134 |
|
|
135 private Double findRadius(final CallContext context, final Artifact artifact) { |
|
|
136 final Double start = (Double) context.getContextValue("startkm"); |
|
|
137 final Double end = (Double) context.getContextValue("endkm"); |
|
|
138 |
|
|
139 if (start == null || end == null) |
|
|
140 return null; |
|
|
141 |
|
|
142 final RiverContext fc = (RiverContext) context.globalContext(); |
|
|
143 final ZoomScale scales = (ZoomScale) fc.get("zoomscale"); |
|
|
144 final RiverAccess access = new RiverAccess((D4EArtifact) artifact); |
|
|
145 final String river = access.getRiverName(); |
|
|
146 |
|
|
147 return scales.getRadius(river, start, end); |
|
|
148 } |
|
|
149 |
|
|
150 private double[][] generatePoints(final CallContext context, final Artifact artifact, final AbstractCalculationResult data, final String facetName, |
|
|
151 final IResultType resultType) { |
|
|
152 |
|
|
153 final double[][] points = data.getStationPoints(resultType); |
|
|
154 if (facetName.endsWith(".filtered")) { |
|
|
155 final Double radius = findRadius(context, artifact); |
|
|
156 return movingAverage(radius, points); |
|
|
157 } |
|
|
158 |
|
|
159 return points; |
|
|
160 } |
|
|
161 |
|
|
162 private double[][] movingAverage(final Double radius, final double[][] points) { |
|
|
163 |
|
|
164 if (radius == null) |
|
|
165 return points; |
|
|
166 |
|
|
167 return MovingAverage.weighted(points, radius); |
|
|
168 } |
|
|
169 |
|
8884
|
170 @Override |
|
|
171 public final boolean canHandle(final String facettype) { |
|
|
172 return this.handled_facet_types.contains(facettype); |
|
|
173 } |
|
|
174 |
|
|
175 @Override |
|
|
176 public final String getAxisLabel(final DiagramGenerator generator) { |
|
|
177 if (this.yAxisLabel != null && !this.yAxisLabel.isEmpty()) { |
|
|
178 // REMARK/UNINTENDED: yAxisLabel may also be a resolved message (side-effect of StyledXYSeries#putMetadata), |
|
|
179 // and cannot be resolved, so we need to give the resolved value as default |
|
9040
|
180 // TODO: In other implementations (i.e. FlowVelocityProcessor), an explicit (German) default label is given here, |
|
8884
|
181 // probably the English version will also show German (CHECK) |
|
|
182 return generator.msg(this.yAxisLabel, this.yAxisLabel); |
|
|
183 } |
|
|
184 return generator.msg(this.i18n_axis_label, "MISSING"); |
|
|
185 } |
|
|
186 } |
