Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/HorizontalProfileMeshCrossOutputState.java @ 811:df6d980c5418
Added more Javadoc in state.profile.horizontal package.
gnv-artifacts/trunk@895 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Fri, 09 Apr 2010 10:46:31 +0000 |
| parents | c4156275c1e1 |
| children | 2423cefe7d39 |
comparison
equal
deleted
inserted
replaced
| 810:991e13c3d504 | 811:df6d980c5418 |
|---|---|
| 45 import org.jfree.chart.ChartTheme; | 45 import org.jfree.chart.ChartTheme; |
| 46 | 46 |
| 47 import org.w3c.dom.Node; | 47 import org.w3c.dom.Node; |
| 48 | 48 |
| 49 /** | 49 /** |
| 50 * This <code>OutputState</code> is used for 'Horizontalschnitt' products. | |
| 51 * | |
| 50 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 52 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 51 * @author <a href="mailto:iweinzierl@intevation.de">Ingo Weinzierl</a> | 53 * @author <a href="mailto:iweinzierl@intevation.de">Ingo Weinzierl</a> |
| 52 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> | 54 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> |
| 53 */ | 55 */ |
| 54 public class HorizontalProfileMeshCrossOutputState | 56 public class HorizontalProfileMeshCrossOutputState |
| 73 */ | 75 */ |
| 74 public HorizontalProfileMeshCrossOutputState() { | 76 public HorizontalProfileMeshCrossOutputState() { |
| 75 super(); | 77 super(); |
| 76 } | 78 } |
| 77 | 79 |
| 78 /** | 80 |
| 79 * @see de.intevation.gnv.state.timeseries.TimeSeriesOutputState#setup(org.w3c.dom.Node) | |
| 80 */ | |
| 81 @Override | 81 @Override |
| 82 public void setup(Node configuration) { | 82 public void setup(Node configuration) { |
| 83 super.setup(configuration); | 83 super.setup(configuration); |
| 84 this.ijkQueryID = Config.getStringXPath(configuration,"queryID-ijk"); | 84 this.ijkQueryID = Config.getStringXPath(configuration,"queryID-ijk"); |
| 85 | 85 |
| 86 } | 86 } |
| 87 | 87 |
| 88 | 88 |
| 89 /** | |
| 90 * This method creates a chart and returns it. | |
| 91 * | |
| 92 * @param chartLables Labels used to decorate the chart. | |
| 93 * @param theme The theme used to adjust the look of the chart. | |
| 94 * @param parameters A collection with parameters this chart contains. | |
| 95 * @param measurements A collection with measurement this chart contains. | |
| 96 * @param dates A collection with dates this chart contains. | |
| 97 * @param result The data collection used to be displayed in this chart. | |
| 98 * @param locale The Locale used to determine the language. | |
| 99 * @param uuid The uuid of the current artifact. | |
| 100 * @param linesVisible A boolean property to determine the visibility of | |
| 101 * lines connecting two points in a chart (not used in this chart type). | |
| 102 * @param shapesVisible A boolean property to determine the visiblity of | |
| 103 * datapoints in this chart (not used in this chart type). | |
| 104 * @param callContext The CallContext object. | |
| 105 * @return a <code>HorizontalCrossProfileChart</code>. | |
| 106 */ | |
| 89 @Override | 107 @Override |
| 90 protected Chart getChart( | 108 protected Chart getChart( |
| 91 ChartLabels chartLables, | 109 ChartLabels chartLables, |
| 92 ChartTheme theme, | 110 ChartTheme theme, |
| 93 Collection parameters, | 111 Collection parameters, |
| 210 } | 228 } |
| 211 return result; | 229 return result; |
| 212 } | 230 } |
| 213 | 231 |
| 214 | 232 |
| 233 /** | |
| 234 * The chart subtitle created by this method is build up of the timeperiod. | |
| 235 * | |
| 236 * @param locale The Locale used to adjust the language of the subtitle. | |
| 237 * @param uuid The UUID of the current artifact. | |
| 238 * @return a timeperiod as string. | |
| 239 */ | |
| 215 @Override | 240 @Override |
| 216 protected String createChartSubtitle(Locale locale, String uuid) { | 241 protected String createChartSubtitle(Locale locale, String uuid) { |
| 217 log.debug("create chart subtitle for horizontal crossprofile charts."); | 242 log.debug("create chart subtitle for horizontal crossprofile charts."); |
| 218 String subtitle = createTimePeriod(locale, uuid); | 243 String subtitle = createTimePeriod(locale, uuid); |
| 219 | 244 |
| 220 return subtitle; | 245 return subtitle; |
| 221 } | 246 } |
| 222 | 247 |
| 223 | 248 |
| 249 /** | |
| 250 * Prepares the input data for chart creation. | |
| 251 * | |
| 252 * @param path The coordinates describing the path the data is processed | |
| 253 * for. | |
| 254 * @param numSamples Number of samples. | |
| 255 * @param input The input data. | |
| 256 * @return finalized data ready for chart creation. | |
| 257 */ | |
| 224 public static Collection<Result> process( | 258 public static Collection<Result> process( |
| 225 List<Coordinate> path, | 259 List<Coordinate> path, |
| 226 int numSamples, | 260 int numSamples, |
| 227 Collection<Result> input | 261 Collection<Result> input |
| 228 ) { | 262 ) { |
| 407 output.add(result); | 441 output.add(result); |
| 408 lastWasSuccess = success; | 442 lastWasSuccess = success; |
| 409 } | 443 } |
| 410 } | 444 } |
| 411 } | 445 } |
| 446 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |