diff gnv-artifacts/src/main/java/de/intevation/gnv/exports/SimpleOdvDataCollector.java @ 771:a0e63136954e

Added and repaired javadoc in de.intevation.gnv.exports package. gnv-artifacts/trunk@827 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 25 Mar 2010 09:01:14 +0000
parents e964a3d8f7bc
children 9a828e5a2390
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/exports/SimpleOdvDataCollector.java	Wed Mar 24 15:32:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/exports/SimpleOdvDataCollector.java	Thu Mar 25 09:01:14 2010 +0000
@@ -13,23 +13,54 @@
 import de.intevation.gnv.state.exception.StateException;
 
 /**
- * @author Ingo Weinzierl (ingo.weinzierl@intevation.de)
+ * This class is a specialization of {@link ShapeDataCollector} and turns
+ * furthermore a given datetime string into a specific format.
+ *
+ * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class SimpleOdvDataCollector
 extends ShapeDataCollector
 {
+    /**
+     * Logger used for logging with log4j.
+     */
     private static Logger log = Logger.getLogger(SimpleOdvDataCollector.class);
 
+    /**
+     * Constant field which defines the source format of a given datetime.
+     */
     public static final String SRC_FORMAT  = "yyyy.MM.dd HH:mm:ss";
+
+    /**
+     * Constant field which defines the target format of a given datetime.
+     */
     public static final String DEST_FORMAT = "yyyy-MM-dd HH:mm";
 
+    /**
+     * Source format.
+     */
     public static DateFormat srcFormat  = new SimpleDateFormat(SRC_FORMAT);
+
+    /**
+     * Target format.
+     */
     public static DateFormat destFormat = new SimpleDateFormat(DEST_FORMAT);
 
+    /**
+     * Constructor
+     *
+     * @param names See {@link #names}
+     */
     public SimpleOdvDataCollector(String[] names) {
         super(names);
     }
 
+    /**
+     * Given datetime values which corresponds to the attribute key 'TIMEVALUE'
+     * are transformed from {@link #SRC_FORMAT} into {@link #DEST_FORMAT}.
+     *
+     * @see de.intevation.gnv.exports.Export.DataCollector#getData(Result)
+     */
     public String[] getData(Result result)
     throws StateException
     {
@@ -72,3 +103,4 @@
         }
     }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

http://dive4elements.wald.intevation.org