annotate artifacts/src/main/java/org/dive4elements/river/exports/process/BedDiffYearProcessor.java @ 7892:e844be34a606 facet-metadata

Add metadata to chart series and datasets.
author Raimund Renkert <rrenkert@intevation.de>
date Wed, 21 May 2014 11:40:14 +0200
parents ea6b441b4872
children 10debf4b82be
rev   line source
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
1 /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
2 * Software engineering by Intevation GmbH
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
3 *
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
4 * This file is Free Software under the GNU AGPL (>=v3)
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
5 * and comes with ABSOLUTELY NO WARRANTY! Check out the
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
6 * documentation coming with Dive4Elements River for details.
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
7 */
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
8
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
9 package org.dive4elements.river.exports.process;
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
10
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
11 import java.util.Map;
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
12
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
13 import org.apache.log4j.Logger;
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
14 import org.jfree.data.xy.XYSeries;
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
15
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
16 import org.dive4elements.artifactdatabase.state.ArtifactAndFacet;
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
17 import org.dive4elements.artifacts.CallContext;
7808
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
18 import org.dive4elements.river.artifacts.D4EArtifact;
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
19 import org.dive4elements.river.artifacts.access.RiverAccess;
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
20 import org.dive4elements.river.artifacts.context.RiverContext;
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
21 import org.dive4elements.river.artifacts.model.FacetTypes;
7808
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
22 import org.dive4elements.river.artifacts.model.ZoomScale;
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
23 import org.dive4elements.river.artifacts.model.minfo.BedDiffYearResult;
7808
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
24 import org.dive4elements.river.artifacts.resources.Resources;
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
25 import org.dive4elements.river.exports.StyledSeriesBuilder;
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
26 import org.dive4elements.river.exports.DiagramGenerator;
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
27 import org.dive4elements.river.jfree.StyledXYSeries;
6905
1b35b2ddfc28 Artifacts: Introduce ThemeDocument & make stuff compileable again. THIS BREAKS THE SYSTEM! TODO: Move ThemeUtils into ThemeDocument.
Sascha L. Teichmann <teichmann@intevation.de>
parents: 6863
diff changeset
28 import org.dive4elements.river.themes.ThemeDocument;
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
29
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
30
7058
5c07024cdc24 Fix indention / line length
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
31 public class BedDiffYearProcessor
5c07024cdc24 Fix indention / line length
Andre Heinecke <aheinecke@intevation.de>
parents: 7057
diff changeset
32 extends DefaultProcessor implements FacetTypes {
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
33
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
34 private final static Logger logger =
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
35 Logger.getLogger(BedDiffYearProcessor.class);
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
36
6778
cbe9ac4380a5 issue1439: Show line segments for points that have gaps on both sides. Small refac.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 6771
diff changeset
37 protected static double GAP_TOLERANCE = 0.101d;
cbe9ac4380a5 issue1439: Show line segments for points that have gaps on both sides. Small refac.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 6771
diff changeset
38
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
39 protected String yAxisLabel;
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
40
7146
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
41 public static final String I18N_AXIS_LABEL =
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
42 "chart.beddifference.yaxis.label.diff";
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
43 public static final String I18N_AXIS_LABEL_DEFAULT =
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
44 "delta S [cm]";
7808
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
45 public static final String I18N_SUBTITLE_RADIUS =
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
46 "chart.subtitle.radius";
7146
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
47
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
48 @Override
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
49 public void doOut(
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
50 DiagramGenerator generator,
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
51 ArtifactAndFacet bundle,
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
52 ThemeDocument theme,
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
53 boolean visible) {
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
54 CallContext context = generator.getCallContext();
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
55 Object data = bundle.getData(context);
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
56 Map<String, String> metaData =
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
57 bundle.getFacet().getMetaData(bundle.getArtifact(), context);
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
58 yAxisLabel = metaData.get("Y");
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
59 if (data instanceof BedDiffYearResult) {
7808
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
60 Double start = (Double)context.getContextValue("startkm");
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
61 Double end = (Double)context.getContextValue("endkm");
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
62 if (start != null && end != null) {
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
63 D4EArtifact artifact = (D4EArtifact)bundle.getArtifact();
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
64 RiverContext fc = (RiverContext)context.globalContext();
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
65 // Adaptive smoothing, based on zoom factor/diagram extents.
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
66 ZoomScale scales = (ZoomScale)fc.get("zoomscale");
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
67 RiverAccess access = new RiverAccess((D4EArtifact)artifact);
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
68 String river = access.getRiverName();
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
69
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
70 double radius = scales.getRadius(river, start, end);
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
71 generator.addSubtitle(Resources.getMsg(
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
72 context.getMeta(),
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
73 I18N_SUBTITLE_RADIUS,
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
74 new Object[] { radius }));
ea6b441b4872 Calculate the zoom dependent radius and add the informations to chart subtitle.
Raimund Renkert <rrenkert@intevation.de>
parents: 7727
diff changeset
75 }
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
76 BedDiffYearResult bData = (BedDiffYearResult) data;
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
77
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
78 StyledXYSeries series = new StyledXYSeries(bundle.getFacetDescription(), theme);
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
79 series.putMetaData(metaData, bundle.getArtifact(), context);
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
80 StyledSeriesBuilder.addPointsFactorY(series,
7706
8f1a5d0802b5 (issue1594) Get the correct differences data
Andre Heinecke <aheinecke@intevation.de>
parents: 7705
diff changeset
81 bData.getDifferencesData(),
7092
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
82 false,
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
83 GAP_TOLERANCE,
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
84 100d);
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
85
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
86 generator.addAxisSeries(series, axisName, visible);
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
87
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
88 return;
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
89 }
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
90 logger.error("Can't process " + data.getClass().getName() + " objects");
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
91 }
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
92
6563262052ab Add DiagramGenerator doOut function
Andre Heinecke <aheinecke@intevation.de>
parents: 7075
diff changeset
93 @Override
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
94 public boolean canHandle(String facetType) {
7705
f1257717fa4b (issue1594) Move Bed differences absolute height into the correct processor
Andre Heinecke <aheinecke@intevation.de>
parents: 7683
diff changeset
95 return BED_DIFFERENCE_YEAR.equals(facetType) // from BedDifferencesYear
7683
28758f51f1b2 issue1594/issue1603: Put bed_differences to correct axis.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents: 7146
diff changeset
96 || BED_DIFFERENCE_YEAR_FILTERED.equals(facetType); // from BedDifferencesYear
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
97 }
7146
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
98
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
99 @Override
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
100 public String getAxisLabel(DiagramGenerator generator) {
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
101 if (yAxisLabel != null && !yAxisLabel.isEmpty()) {
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
102 return generator.msg(yAxisLabel, I18N_AXIS_LABEL_DEFAULT);
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
103 }
7146
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
104 return generator.msg(
7892
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
105 I18N_AXIS_LABEL,
e844be34a606 Add metadata to chart series and datasets.
Raimund Renkert <rrenkert@intevation.de>
parents: 7808
diff changeset
106 I18N_AXIS_LABEL_DEFAULT);
7146
414794d0a50d Add label for bed difference axis
Andre Heinecke <aheinecke@intevation.de>
parents: 7092
diff changeset
107 }
6570
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
108 }
6435b3d7fb52 Refactored BedDifferenceYearGenerator to use new BedDiffYearProcessor.
Felix Wolfsteller <felix.wolfsteller@intevation.de>
parents:
diff changeset
109 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org