Mercurial > dive4elements > river

comparison artifacts/src/main/java/org/dive4elements/river/exports/process/FixWQProcessor.java @ 8206:436512d9bd94

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added processor for discharge curve in fixanalysis.
author Raimund Renkert <rrenkert@intevation.de>
date Fri, 05 Sep 2014 15:57:39 +0200
parents
children 9f9857f6c464
comparison
equal deleted inserted replaced
8205:04d1d56d896b 8206:436512d9bd94
1 package org.dive4elements.river.exports.process;
2
3 import java.awt.BasicStroke;
4 import java.awt.Color;
5 import java.text.DateFormat;
6 import java.util.ArrayList;
7 import java.util.List;
8
9 import org.apache.log4j.Logger;
10 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
11 import org.dive4elements.river.artifacts.model.FacetTypes;
12 import org.dive4elements.river.artifacts.model.NamedDouble;
13 import org.dive4elements.river.artifacts.model.QWDDateRange;
14 import org.dive4elements.river.artifacts.model.WQKms;
15 import org.dive4elements.river.artifacts.model.fixings.FixFunction;
16 import org.dive4elements.river.artifacts.model.fixings.FixWQCurveFacet;
17 import org.dive4elements.river.artifacts.model.fixings.QWD;
18 import org.dive4elements.river.artifacts.model.fixings.QWI;
19 import org.dive4elements.river.exports.DiagramGenerator;
20 import org.dive4elements.river.exports.StyledSeriesBuilder;
21 import org.dive4elements.river.exports.fixings.FixChartGenerator;
22 import org.dive4elements.river.exports.fixings.FixWQCurveGenerator;
23 import org.dive4elements.river.java2d.ShapeUtils;
24 import org.dive4elements.river.jfree.CollisionFreeXYTextAnnotation;
25 import org.dive4elements.river.jfree.JFreeUtil;
26 import org.dive4elements.river.jfree.RiverAnnotation;
27 import org.dive4elements.river.jfree.StickyAxisAnnotation;
28 import org.dive4elements.river.jfree.StyledXYSeries;
29 import org.dive4elements.river.themes.ThemeDocument;
30 import org.jfree.chart.annotations.XYTextAnnotation;
31 import org.jfree.chart.plot.Marker;
32 import org.jfree.chart.plot.ValueMarker;
33 import org.jfree.data.xy.XYSeries;
34 import org.jfree.ui.RectangleAnchor;
35 import org.jfree.ui.RectangleInsets;
36 import org.jfree.ui.TextAnchor;
37
38
39 public class FixWQProcessor
40 extends DefaultProcessor
41 implements FacetTypes
42 {
43
44 private static Logger logger = Logger.getLogger(FixWQProcessor.class);
45
46 public FixWQProcessor() {
47 }
48
49 @Override
50 public void doOut(
51 DiagramGenerator generator,
52 ArtifactAndFacet bundle,
53 ThemeDocument theme,
54 boolean visible
55 ) {
56 // TODO: Simplyfy this processor and move general facets/data to
57 // MiscDischargeProcessor or something...
58 String facetType = bundle.getFacetName();
59 logger.debug("facet: " + facetType + " name: " + bundle.getFacetDescription());
60 if(facetType.startsWith(FIX_SECTOR_AVERAGE_WQ)) {
61 doSectorAverageOut(generator, bundle, theme, visible);
62 }
63 else if(FIX_ANALYSIS_EVENTS_WQ.equals(facetType)
64 || FIX_REFERENCE_EVENTS_WQ.equals(facetType)
65 || FIX_EVENTS.equals(facetType)) {
66 doEventsOut(generator, bundle, theme, visible);
67 }
68 else if(FIX_WQ_CURVE.equals(facetType)) {
69 doWQCurveOut(generator, bundle, theme, visible);
70 }
71 else if(FIX_OUTLIER.equals(facetType)) {
72 doOutlierOut(generator, bundle, theme, visible);
73 }
74 else if(QSECTOR.equals(facetType)) {
75 doQSectorOut(generator, bundle, theme, visible);
76 }
77 else if(STATIC_WKMS_MARKS.equals(facetType) ||
78 STATIC_WKMS.equals(facetType) ||
79 HEIGHTMARKS_POINTS.equals(facetType) ) {
80 doWAnnotations(generator, bundle, theme, visible);
81 }
82 else if (LONGITUDINAL_W.equals(facetType)
83 || STATIC_WKMS_INTERPOL.equals(facetType)
84 || FIX_WQ_LS.equals(facetType)) {
85 doWQOut(generator, bundle, theme, visible);
86 }
87 }
88
89 /** Add sector average points to chart. */
90 protected void doSectorAverageOut(
91 DiagramGenerator generator,
92 ArtifactAndFacet bundle,
93 ThemeDocument theme,
94 boolean visible
95 ) {
96 logger.debug("doSectorAverageOut");
97 QWDDateRange qwdd = (QWDDateRange)bundle.getData(generator.getCallContext());
98 QWD qwd = qwdd != null ? qwdd.getQWD() : null;
99
100 if(qwd != null) {
101 XYSeries series = new StyledXYSeries(
102 bundle.getFacetDescription(),
103 false, true,
104 theme);
105 DateFormat dateFormat = DateFormat.getDateInstance(
106 DateFormat.SHORT);
107
108 //TODO: W in cm at Gauge!!!
109 series.add(qwd.getQ(), qwd.getW(), false);
110
111 XYTextAnnotation anno = new CollisionFreeXYTextAnnotation(
112 dateFormat.format(qwd.getDate()),
113 qwd.getQ(),
114 qwd.getW());
115 List<XYTextAnnotation> annos = new ArrayList<XYTextAnnotation>();
116 annos.add(anno);
117 generator.addAxisSeries(series, axisName, visible);
118
119 if (visible && theme != null && theme.parseShowPointLabel()) {
120 RiverAnnotation flysAnno =
121 new RiverAnnotation(null, null, null, theme);
122 flysAnno.setTextAnnotations(annos);
123 generator.addAnnotations(flysAnno);
124 }
125 }
126 else {
127 logger.debug("doSectorAverageOut: qwd == null");
128 }
129 }
130
131
132 /** Add analysis event points to chart. */
133 protected void doEventsOut(
134 DiagramGenerator generator,
135 ArtifactAndFacet bundle,
136 ThemeDocument theme,
137 boolean visible
138 ) {
139 logger.debug("doAnalysisEventsOut");
140
141 QWD qwd = (QWD)bundle.getData(generator.getCallContext());
142
143 if (qwd == null) {
144 logger.debug("doAnalysisEventsOut: qwd == null");
145 return;
146 }
147 // TODO: W in cm at Gauge!!!
148 //double gaugeDatum = getCurrentGaugeDatum();
149 //boolean atGauge = gaugeDatum != 0d;
150
151 //double factor = atGauge ? 100d : 1d;
152
153 //double w = factor*(qwd.getW()-gaugeDatum);
154
155 // Force empty symbol.
156 if (qwd.getInterpolated()) {
157 theme = new ThemeDocument(theme); // prevent potential side effects.
158 theme.setValue(ThemeDocument.USE_FILL_PAINT, "true");
159 }
160
161 XYSeries series = new StyledXYSeries(
162 bundle.getFacetDescription(),
163 theme,
164 qwd.getInterpolated()
165 ? ShapeUtils.INTERPOLATED_SHAPE
166 : ShapeUtils.MEASURED_SHAPE);
167
168 series.add(qwd.getQ(), qwd.getW());
169
170 generator.addAxisSeries(series, axisName, visible);
171
172 if (visible && theme.parseShowPointLabel()) {
173
174 List<XYTextAnnotation> textAnnos = new ArrayList<XYTextAnnotation>();
175
176 DateFormat dateFormat = DateFormat.getDateInstance(
177 DateFormat.SHORT);
178 XYTextAnnotation anno = new CollisionFreeXYTextAnnotation(
179 dateFormat.format(qwd.getDate()),
180 qwd.getQ(),
181 qwd.getW());
182 textAnnos.add(anno);
183
184 RiverAnnotation flysAnno = new RiverAnnotation(null, null, null, theme);
185 flysAnno.setTextAnnotations(textAnnos);
186 generator.addAnnotations(flysAnno);
187 }
188 }
189
190 /** Add reference event points to chart. */
191 protected void doReferenceEventsOut(
192 DiagramGenerator generator,
193 ArtifactAndFacet bundle,
194 ThemeDocument theme,
195 boolean visible) {
196 logger.debug("doReferenceEventsOut");
197
198 QWI qwd = (QWI)bundle.getData(generator.getCallContext());
199 if (qwd == null) {
200 logger.debug("doReferenceEventsOut: qwds == null in " + bundle.getFacetDescription());
201 return;
202 }
203
204 // Force empty symbol.
205 if (qwd.getInterpolated()) {
206 theme = new ThemeDocument(theme); // prevent potential side effects.
207 theme.setValue(ThemeDocument.USE_FILL_PAINT, "true");
208 }
209
210 XYSeries series = new StyledXYSeries(
211 bundle.getFacetDescription(),
212 false, true, theme,
213 qwd.getInterpolated()
214 ? ShapeUtils.INTERPOLATED_SHAPE
215 : ShapeUtils.MEASURED_SHAPE);
216
217 // TODO: W in cm at gauge!!!
218 //double gaugeDatum = getCurrentGaugeDatum();
219 //boolean atGauge = gaugeDatum != 0d;
220
221 //double factor = atGauge ? 100d : 1d;
222 //double w = factor*(qwd.getW()-gaugeDatum);
223
224 series.add(qwd.getQ(), qwd.getW(), false);
225
226 if (visible && theme.parseShowPointLabel()) {
227 DateFormat dateFormat = DateFormat.getDateInstance(
228 DateFormat.SHORT);
229
230 XYTextAnnotation anno = new CollisionFreeXYTextAnnotation(
231 dateFormat.format(qwd.getDate()),
232 qwd.getQ(),
233 qwd.getW());
234
235 List<XYTextAnnotation> textAnnos = new ArrayList<XYTextAnnotation>();
236 textAnnos.add(anno);
237 RiverAnnotation flysAnno = new RiverAnnotation(null, null, null, theme);
238 flysAnno.setTextAnnotations(textAnnos);
239 generator.addAnnotations(flysAnno);
240 }
241
242 generator.addAxisSeries(series, axisName, visible);
243 }
244
245 protected void doWQCurveOut(
246 DiagramGenerator generator,
247 ArtifactAndFacet bundle,
248 ThemeDocument theme,
249 boolean visible
250 ) {
251 logger.debug("doWQCurveOut");
252
253 FixWQCurveFacet facet = (FixWQCurveFacet)bundle.getFacet();
254 FixFunction func = (FixFunction)facet.getData(
255 bundle.getArtifact(), generator.getCallContext());
256
257 if (func == null) {
258 logger.warn("doWQCurveOut: Facet does not contain FixFunction");
259 return;
260 }
261
262 double maxQ = func.getMaxQ();
263
264 if (maxQ > 0) {
265 StyledXYSeries series = JFreeUtil.sampleFunction2D(
266 func.getFunction(),
267 theme,
268 bundle.getFacetDescription(),
269 500, // number of samples
270 0.0 , // start
271 maxQ); // end
272
273 //TODO: W in cm at gauge!!!
274 // double gaugeDatum = getCurrentGaugeDatum();
275
276 // if (gaugeDatum == 0d) {
277 generator.addAxisSeries(series, axisName, visible);
278 // }
279 /* else {
280 StyledXYSeries series2 = JFreeUtil.sampleFunction2D(
281 func.getFunction(),
282 doc,
283 aaf.getFacetDescription(),
284 500, // number of samples
285 0.0 , // start
286 maxQ); // end
287 addAxisSeries(series2, YAXIS.W.idx, false);
288 // Use second axis at cm if at gauge.
289 for (int i = 0, N = series.getItemCount(); i < N; i++) {
290 series.updateByIndex(
291 i, new Double(100d*(series.getY(i).doubleValue()-gaugeDatum)));
292 }
293 addAxisSeries(series, YAXIS.WCm.idx, visible);
294 }*/
295 }
296 else {
297 logger.warn("doWQCurveOut: maxQ <= 0");
298 }
299 }
300
301 protected void doOutlierOut(
302 DiagramGenerator generator,
303 ArtifactAndFacet bundle,
304 ThemeDocument theme,
305 boolean visible
306 ) {
307 logger.debug("doOutlierOut");
308
309 QWI[] qws = (QWI[])bundle.getData(generator.getCallContext());
310 if(qws != null) {
311 XYSeries series = new StyledXYSeries(
312 bundle.getFacetDescription(),
313 false, true,
314 theme);
315 DateFormat dateFormat = DateFormat.getDateInstance(
316 DateFormat.SHORT);
317
318 List<XYTextAnnotation> annos = new ArrayList<XYTextAnnotation>();
319 //TODO: W in cm at Gauge!!!
320 for (QWI qw: qws) {
321 series.add(qw.getQ(), qw.getW(), false);
322
323 XYTextAnnotation anno = new CollisionFreeXYTextAnnotation(
324 dateFormat.format(qw.getDate()),
325 qw.getQ(),
326 qw.getW());
327 annos.add(anno);
328 }
329 generator.addAxisSeries(series, axisName, visible);
330
331 if (visible && theme != null && theme.parseShowPointLabel()) {
332 RiverAnnotation flysAnno =
333 new RiverAnnotation(null, null, null, theme);
334 flysAnno.setTextAnnotations(annos);
335 generator.addAnnotations(flysAnno);
336 }
337 }
338 else {
339 logger.debug("doOutlierOut: qwd == null");
340 }
341 }
342
343 /** Add markers for q sectors. */
344 protected void doQSectorOut(
345 DiagramGenerator generator,
346 ArtifactAndFacet bundle,
347 ThemeDocument theme,
348 boolean visible
349 ) {
350 logger.debug("doQSectorOut");
351 if (!visible) {
352 return;
353 }
354
355 Object qsectorsObj = bundle.getData(generator.getCallContext());
356 if (qsectorsObj == null || !(qsectorsObj instanceof List)) {
357 logger.warn("No QSectors coming from data.");
358 return;
359 }
360
361 List<?> qsectorsList = (List<?>) qsectorsObj;
362 if (qsectorsList.size() == 0 || !(qsectorsList.get(0) instanceof NamedDouble)) {
363 logger.warn("No QSectors coming from data.");
364 return;
365 }
366
367 @SuppressWarnings("unchecked")
368 List<NamedDouble> qsectors = (List<NamedDouble>) qsectorsList;
369
370 for (NamedDouble qsector : qsectors) {
371 if (Double.isNaN(qsector.getValue())) {
372 continue;
373 }
374 Marker m = new ValueMarker(qsector.getValue());
375 m.setPaint(Color.black);
376
377 float[] dashes = theme.parseLineStyle();
378 int size = theme.parseLineWidth();
379 BasicStroke stroke;
380 if (dashes.length <= 1) {
381 stroke = new BasicStroke(size);
382 }
383 else {
384 stroke = new BasicStroke(size,
385 BasicStroke.CAP_BUTT,
386 BasicStroke.JOIN_ROUND,
387 1.0f,
388 dashes,
389 0.0f);
390 }
391 m.setStroke(stroke);
392
393 if (theme.parseShowLineLabel()) {
394 m.setLabel(qsector.getName());
395 m.setPaint(theme.parseTextColor());
396 m.setLabelFont(theme.parseTextFont());
397 }
398 Color paint = theme.parseLineColorField();
399 if (paint != null) {
400 m.setPaint(paint);
401 }
402 m.setLabelAnchor(RectangleAnchor.TOP_LEFT);
403 m.setLabelTextAnchor(TextAnchor.TOP_LEFT);
404 m.setLabelOffset(new RectangleInsets(5, 5, 10, 10));
405 generator.addDomainMarker(m);
406 }
407 }
408
409 /**
410 * Add W-Annotations to plot.
411 * @param wqkms actual data (double[][]).
412 * @param theme theme to use.
413 */
414 protected void doWAnnotations(
415 DiagramGenerator generator,
416 ArtifactAndFacet bundle,
417 ThemeDocument theme,
418 boolean visible
419 ) {
420 Object data = bundle.getData(generator.getCallContext());
421 List<StickyAxisAnnotation> xy = new ArrayList<StickyAxisAnnotation>();
422 if (data instanceof double[][]) {
423 logger.debug("Got double[][]");
424 double [][] values = (double [][]) data;
425 for (int i = 0; i< values[0].length; i++) {
426 xy.add(new StickyAxisAnnotation(bundle.getFacetDescription(),
427 (float) values[1][i], StickyAxisAnnotation.SimpleAxis.Y_AXIS));
428 }
429
430 if (visible) {
431 generator.addAnnotations(
432 new RiverAnnotation(
433 bundle.getFacetDescription(), xy, null, theme));
434 }
435 }
436 else {
437 // Assume its WKms.
438 logger.debug("Got WKms");
439 /* TODO
440 WKms wkms = (WKms) data;
441
442 Double ckm =
443 (Double) generator.getCallContext().getContextValue(FixChartGenerator.CURRENT_KM);
444 double location = (ckm != null)
445 ? ckm.doubleValue()
446 : getRange()[0];
447 double w = StaticWKmsArtifact.getWAtKmLin(data, location);
448 xy.add(new StickyAxisAnnotation(aandf.getFacetDescription(),
449 (float) w, StickyAxisAnnotation.SimpleAxis.Y_AXIS));
450
451 doAnnotations(new RiverAnnotation(facet.getDescription(), xy),
452 aandf, theme, visible);*/
453 }
454 }
455
456 /**
457 * Add WQ Data to plot.
458 * @param wqkms data as double[][]
459 */
460 protected void doWQOut(
461 DiagramGenerator generator,
462 ArtifactAndFacet bundle,
463 ThemeDocument theme,
464 boolean visible
465 ) {
466 logger.debug("FixWQCurveGenerator: doWQOut");
467 Object data = bundle.getData(generator.getCallContext());
468 if (data instanceof WQKms) {
469 WQKms wqkms = (WQKms)data;
470 // TODO As in doEventsOut, the value-searching should
471 // be delivered by the facet already (instead of in the Generator).
472 logger.debug("FixWQCurveGenerator: doWQOut: WQKms");
473 XYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
474 // TODO: Remove dependency to FixChartGenerator.
475 Double ckm = (Double) generator.getCallContext().getContextValue(FixChartGenerator.CURRENT_KM);
476 if (wqkms == null || wqkms.getKms().length == 0 || ckm == null) {
477 logger.info("addPointFromWQKms: No event data to show.");
478 return;
479 }
480 double[] kms = wqkms.getKms();
481 // TODO W in cm at gauge!!!
482 //double gaugeDatum = getCurrentGaugeDatum();
483 //double factor = (gaugeDatum == 0d) ? 1d : 100d;
484 for (int i = 0 ; i< kms.length; i++) {
485 // TODO: Remove dependency to FixWQCurveGenerator.
486 if (Math.abs(kms[i] - ckm) <= FixWQCurveGenerator.EPSILON) {
487 series.add(wqkms.getQ(i), wqkms.getW(i), false);
488 generator.addAxisSeries(series, axisName, visible);
489 if(visible && theme.parseShowPointLabel()) {
490 List<XYTextAnnotation> textAnnos = new ArrayList<XYTextAnnotation>();
491 XYTextAnnotation anno = new CollisionFreeXYTextAnnotation(
492 bundle.getFacetDescription(),
493 wqkms.getQ(i),
494 wqkms.getW(i));
495 textAnnos.add(anno);
496 RiverAnnotation flysAnno = new RiverAnnotation(null, null, null, theme);
497 flysAnno.setTextAnnotations(textAnnos);
498 generator.addAnnotations(flysAnno);
499 }
500 return;
501 }
502 }
503 }
504 else {
505 logger.debug("FixWQCurveGenerator: doWQOut: double[][]");
506 double [][] values = (double [][]) data;
507
508 XYSeries series = new StyledXYSeries(bundle.getFacetDescription(), false, true, theme);
509 StyledSeriesBuilder.addPoints(series, values, true);
510
511 generator.addAxisSeries(series, axisName, visible);
512 }
513 }
514
515 @Override
516 public boolean canHandle(String facettype) {
517 return facettype.startsWith(FIX_SECTOR_AVERAGE_WQ)
518 || FIX_ANALYSIS_EVENTS_WQ.equals(facettype)
519 || FIX_REFERENCE_EVENTS_WQ.equals(facettype)
520 || FIX_EVENTS.equals(facettype)
521 || FIX_WQ_CURVE.equals(facettype)
522 || FIX_OUTLIER.equals(facettype)
523 || QSECTOR.equals(facettype)
524 || STATIC_WKMS_MARKS.equals(facettype)
525 || STATIC_WKMS.equals(facettype)
526 || HEIGHTMARKS_POINTS.equals(facettype)
527 || LONGITUDINAL_W.equals(facettype)
528 || STATIC_WKMS_INTERPOL.equals(facettype)
529 || FIX_WQ_LS.equals(facettype);
530 }
531 }
http://dive4elements.wald.intevation.org