changeset 3957:3825aad9fb41

Documentation (d o c u m e n t a t i o n). flys-backend/trunk@5616 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Thu, 27 Sep 2012 12:53:09 +0000
parents 323063c0f7a0
children 64b73dc1571c
files flys-backend/ChangeLog flys-backend/src/main/java/de/intevation/flys/importer/ImportBedHeightEpoch.java
diffstat 2 files changed, 25 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/flys-backend/ChangeLog	Thu Sep 27 11:16:20 2012 +0000
+++ b/flys-backend/ChangeLog	Thu Sep 27 12:53:09 2012 +0000
@@ -1,3 +1,13 @@
+2012-09-27  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/importer/ImportBedHeightEpoch.java:
+	  Doc.
+
+2012-09-27  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/importer/parsers/BedHeightSingleParser.java:
+	  Removed debug output.
+
 2012-09-27  Felix Wolfsteller <felix.wolfsteller@intevation.de>
 
 	* src/main/java/de/intevation/flys/importer/parsers/BedHeightSingleParser.java:
--- a/flys-backend/src/main/java/de/intevation/flys/importer/ImportBedHeightEpoch.java	Thu Sep 27 11:16:20 2012 +0000
+++ b/flys-backend/src/main/java/de/intevation/flys/importer/ImportBedHeightEpoch.java	Thu Sep 27 12:53:09 2012 +0000
@@ -16,11 +16,15 @@
 import de.intevation.flys.model.TimeInterval;
 
 
+/** Import Bed Height Data, 'epoch' type from csv file. */
 public class ImportBedHeightEpoch implements ImportBedHeight {
 
+    /** Private logger. */
     private static Logger log = Logger.getLogger(ImportBedHeightEpoch.class);
 
     protected String evaluationBy;
+
+    /** De facto the file name. */
     protected String description;
 
     protected ImportTimeInterval timeInterval;
@@ -69,18 +73,24 @@
         this.oldElevationModel = oldElevationModel;
     }
 
+    /** Does nothing. */
     public void setYear(int year) {
         // do nothing
     }
 
+    /** Does nothing. */
     public void setSoundingWidth(int soundingWidth) {
         // do nothing
     }
 
+
+    /** Does nothing. */
     public void setLocationSystem(ImportLocationSystem locationSystem) {
         // do nothing
     }
 
+
+    /** Does nothing. */
     public void setType(ImportBedHeightType type) {
         // do nothing
     }
@@ -117,6 +127,11 @@
         session.flush();
     }
 
+    /**
+     * Asserts all dependent entities (ElevationModel, TimeInterval, Range,
+     * BedHeighEpoch) are in db and returns bound (either newly created or
+     * freshly fetched) BedHeightEpoch.
+     */
     @Override
     public BedHeightEpoch getPeer(River river) {
         if (peer == null) {

http://dive4elements.wald.intevation.org