comparison flys-artifacts/src/main/java/de/intevation/flys/artifacts/services/DischargeTablesOverview.java @ 4213:0674d89210f5

Added a new service to query a diagram with discharge tables. This service takes a gauge (required) and a timerange (optional) as input parameters.
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Tue, 23 Oct 2012 07:39:09 +0200
parents
children 08b6458909a9
comparison
equal deleted inserted replaced
4212:fbaba8e1a3a2 4213:0674d89210f5
1 package de.intevation.flys.artifacts.services;
2
3 import java.awt.Color;
4 import java.text.DateFormat;
5 import java.text.ParseException;
6 import java.util.ArrayList;
7 import java.util.Collections;
8 import java.util.Date;
9 import java.util.List;
10 import java.util.Locale;
11
12 import org.apache.log4j.Logger;
13 import org.hibernate.Session;
14 import org.jfree.chart.ChartFactory;
15 import org.jfree.chart.JFreeChart;
16 import org.jfree.chart.plot.PlotOrientation;
17 import org.jfree.chart.plot.XYPlot;
18 import org.jfree.data.xy.XYSeries;
19 import org.jfree.data.xy.XYSeriesCollection;
20 import org.w3c.dom.Document;
21 import org.w3c.dom.Element;
22 import org.w3c.dom.NodeList;
23
24 import de.intevation.artifacts.CallMeta;
25 import de.intevation.artifacts.GlobalContext;
26 import de.intevation.flys.artifacts.model.DischargeTables;
27 import de.intevation.flys.artifacts.model.GaugesFactory;
28 import de.intevation.flys.artifacts.resources.Resources;
29 import de.intevation.flys.backend.SessionHolder;
30 import de.intevation.flys.model.DischargeTable;
31 import de.intevation.flys.model.Gauge;
32 import de.intevation.flys.model.TimeInterval;
33
34
35 public class DischargeTablesOverview extends AbstractChartService {
36
37 private static final Logger log = Logger
38 .getLogger(DischargeTablesOverview.class);
39
40 private static final long serialVersionUID = 1L;
41
42 public static final String I18N_CHART_TITLE = "gauge.discharge.service.chart.title";
43 public static final String DEFAULT_CHART_TITLE = "Pegel: XXX";
44
45 public static final String I18N_CHART_X_AXIS_TITLE = "gauge.discharge.service.chart.x.title";
46 public static final String DEFAULT_X_AXIS_TITLE = "Q [m^3/s]";
47
48 public static final String I18N_CHART_Y_AXIS_TITLE = "gauge.discharge.service.chart.y.title";
49 public static final String DEFAULT_Y_AXIS_TITLE = "W [cm]";
50
51 public static final String I18N_CHART_SERIES_TITLE = "gauge.discharge.service.chart.series.title";
52 public static final String DEFAULT_CHART_SERIES_TITLE = "Abflusskurve";
53
54 public static final String I18N_CHART_SERIES_TITLE_MASTER = "gauge.discharge.service.chart.series.title.master";
55 public static final String DEFAULT_CHART_SERIES_TITLE_MASTER = "Aktuelle Abflusskurve";
56
57 public static final DateFormat DATE_FORMAT = DateFormat.getDateInstance(
58 DateFormat.SHORT, Locale.GERMANY);
59
60 private Session session;
61
62 @Override
63 protected void init() {
64 session = SessionHolder.acquire();
65 }
66
67 @Override
68 protected void finish() {
69 if (session != null) {
70 session.close();
71 SessionHolder.release();
72 }
73 }
74
75 protected JFreeChart createChart(Document data,
76 GlobalContext globalContext, CallMeta callMeta) {
77
78 Gauge gauge = extractGauge(data);
79
80 if (gauge == null) {
81 log.warn("Could not determine Gauge from request!");
82 return null;
83 }
84
85 log.info("create discharge chart for gauge '" + gauge.getName() + "'");
86 TimeInterval timerange = extractTimeInterval(data);
87
88 List<DischargeTable> dts = getDischargeTables(gauge, timerange);
89 XYSeriesCollection dataset = new XYSeriesCollection();
90
91 for (DischargeTable dt : dts) {
92 try {
93 XYSeries series = createSeries(callMeta, dt);
94 if (series != null) {
95 dataset.addSeries(series);
96 }
97 }
98 catch (IllegalArgumentException iae) {
99 log.warn("unable to create discharge curve: "
100 + iae.getMessage());
101 }
102 }
103
104 String title = Resources.format(callMeta, I18N_CHART_TITLE,
105 DEFAULT_CHART_TITLE, gauge.getName());
106
107 String xAxis = Resources.getMsg(callMeta, I18N_CHART_X_AXIS_TITLE,
108 DEFAULT_X_AXIS_TITLE);
109
110 String yAxis = Resources.format(callMeta, I18N_CHART_Y_AXIS_TITLE,
111 DEFAULT_Y_AXIS_TITLE);
112
113 JFreeChart chart = ChartFactory.createXYLineChart(title, xAxis, yAxis,
114 null, PlotOrientation.VERTICAL, true, true, false);
115
116 chart.setBackgroundPaint(Color.white);
117
118 XYPlot plot = (XYPlot) chart.getPlot();
119 plot.setDataset(0, dataset);
120 plot.setBackgroundPaint(Color.white);
121 plot.setDomainGridlinePaint(Color.gray);
122 plot.setRangeGridlinePaint(Color.gray);
123 plot.setDomainGridlinesVisible(true);
124 plot.setRangeGridlinesVisible(true);
125
126 return chart;
127 }
128
129 protected XYSeries createSeries(CallMeta callMeta, DischargeTable dt)
130 throws IllegalArgumentException {
131
132 double[][] xy = null;
133
134 if (dt.getKind() == DischargeTables.MASTER) {
135 xy = DischargeTables.loadDischargeTableValues(dt,
136 DischargeTables.MASTER_SCALE);
137 }
138 else {
139 xy = DischargeTables.loadDischargeTableValues(dt,
140 DischargeTables.HISTORICAL_SCALE);
141 }
142
143 XYSeries series = new XYSeries(createSeriesTitle(callMeta, dt), false);
144 for (int i = 0, n = xy[0].length; i < n; i++) {
145 series.add(xy[0][i], xy[1][i]);
146 }
147
148 return series;
149 }
150
151 protected String createSeriesTitle(CallMeta callMeta, DischargeTable dt)
152 throws IllegalArgumentException {
153 TimeInterval timeInterval = dt.getTimeInterval();
154 Date start = timeInterval.getStartTime();
155 Date end = timeInterval.getStopTime();
156
157 if (start != null && end != null) {
158 return Resources.format(callMeta, I18N_CHART_SERIES_TITLE,
159 DEFAULT_CHART_SERIES_TITLE, start, end);
160 }
161 else if (start != null) {
162 return Resources.format(callMeta, I18N_CHART_SERIES_TITLE_MASTER,
163 DEFAULT_CHART_SERIES_TITLE, start);
164 }
165 else {
166 throw new IllegalArgumentException(
167 "Missing start date of DischargeTable " + dt.getId());
168 }
169 }
170
171 protected Gauge extractGauge(Document data) {
172 NodeList gauges = data.getElementsByTagName("gauge");
173
174 if (gauges.getLength() > 0) {
175 String name = ((Element) gauges.item(0)).getAttribute("name");
176 if (name != null && name.length() > 0) {
177 return GaugesFactory.getGauge(name);
178 }
179 }
180
181 return null;
182 }
183
184 protected TimeInterval extractTimeInterval(Document data) {
185 NodeList timeranges = data.getElementsByTagName("timerange");
186
187 if (timeranges != null && timeranges.getLength() > 0) {
188 Element timerange = (Element) timeranges.item(0);
189
190 String lower = timerange.getAttribute("lower");
191 String upper = timerange.getAttribute("upper");
192
193 if (lower != null && upper != null) {
194 try {
195 Date d1 = DATE_FORMAT.parse(lower);
196 Date d2 = DATE_FORMAT.parse(upper);
197
198 return new TimeInterval(d1, d2);
199 }
200 catch (ParseException pe) {
201 log.warn("Wrong time format: " + pe.getMessage());
202 }
203 }
204 }
205
206 return null;
207 }
208
209 protected List<DischargeTable> getDischargeTables(Gauge gauge,
210 TimeInterval timerange) {
211 List<DischargeTable> all = gauge.getDischargeTables();
212 Collections.sort(all);
213
214 if (timerange == null) {
215 return all;
216 }
217
218 List<DischargeTable> dts = new ArrayList<DischargeTable>(all.size());
219 long startDate = timerange.getStartTime().getTime();
220 long stopDate = timerange.getStopTime().getTime();
221
222 for (DischargeTable dt : all) {
223 TimeInterval tmp = dt.getTimeInterval();
224 Date start = tmp.getStartTime();
225 Date stop = tmp.getStartTime();
226
227 if (start.getTime() > startDate && start.getTime() < stopDate) {
228 dts.add(dt);
229 continue;
230 }
231 else if (stop != null && stop.getTime() < stopDate
232 && stop.getTime() > startDate) {
233 dts.add(dt);
234 continue;
235 }
236 }
237
238 return dts;
239 }
240 }

http://dive4elements.wald.intevation.org