changeset 1160:efe1b8545f5c

Cosmetics flys-artifacts/trunk@2696 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Mon, 12 Sep 2011 09:00:08 +0000
parents fb5a7ff9feb8
children 9bdf738abbad
files flys-artifacts/ChangeLog flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DataFacet.java flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/FloodMapState.java flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java flys-artifacts/src/main/java/de/intevation/flys/exports/DurationCurveExporter.java
diffstat 5 files changed, 37 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/flys-artifacts/ChangeLog	Mon Sep 12 06:23:48 2011 +0000
+++ b/flys-artifacts/ChangeLog	Mon Sep 12 09:00:08 2011 +0000
@@ -1,3 +1,13 @@
+2011-09-12  Felix Wolfsteller <felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/artifacts/model/DataFacet.java:
+	  Cosmetics, docs.
+	
+	* src/main/java/de/intevation/flys/artifacts/states/FloodMapState.java,
+	  src/main/java/de/intevation/flys/exports/AbstractExporter.java,
+	  src/main/java/de/intevation/flys/exports/DurationCurveExporter.java:
+	  Cosmetics.
+
 2011-09-12  Ingo Weinzierl <ingo@intevation.de>
 
 	* src/main/java/de/intevation/flys/artifacts/states/DefaultState.java:
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DataFacet.java	Mon Sep 12 06:23:48 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/DataFacet.java	Mon Sep 12 09:00:08 2011 +0000
@@ -17,9 +17,16 @@
     protected String      hash;
     protected String      stateId;
 
+
+    /** Trivial constructor. */
     public DataFacet() {
     }
 
+    /**
+     * Defaults to ADVANCE Compute type.
+     * @param name Name of the facet.
+     * @param description maybe localized description of the facet.
+     */
     public DataFacet(String name, String description) {
         this(name, description, ComputeType.ADVANCE);
     }
@@ -53,6 +60,10 @@
         this.stateId = stateId;
     }
 
+
+    /**
+     * Return computation result.
+     */
     @Override
     public Object getData(Artifact artifact, CallContext context) {
         FLYSArtifact flys = (FLYSArtifact)artifact;
@@ -63,6 +74,10 @@
             : flys.compute(context, theHash, type, false);
     }
 
+
+    /**
+     * Return a deep copy.
+     */
     @Override
     public Facet deepCopy() {
         DataFacet copy = new DataFacet();
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/FloodMapState.java	Mon Sep 12 06:23:48 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/FloodMapState.java	Mon Sep 12 09:00:08 2011 +0000
@@ -54,7 +54,7 @@
 extends      DefaultState
 implements   FacetTypes
 {
-    /** The logger that is used in this state.*/
+    /** The logger that is used in this state. */
     private static Logger logger = Logger.getLogger(FloodMapState.class);
 
 
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java	Mon Sep 12 06:23:48 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java	Mon Sep 12 09:00:08 2011 +0000
@@ -35,32 +35,32 @@
     private static Logger logger = Logger.getLogger(AbstractExporter.class);
 
 
-    /** The name of the CSV facet which triggers the CSV creation.*/
+    /** The name of the CSV facet which triggers the CSV creation. */
     public static final String FACET_CSV = "csv";
 
-    /** The default charset for the CSV export.*/
+    /** The default charset for the CSV export. */
     public static final String DEFAULT_CSV_CHARSET = "UTF-8";
 
-    /** The default separator for the CSV export.*/
+    /** The default separator for the CSV export. */
     public static final char DEFAULT_CSV_SEPARATOR = ',';
 
-    /** XPath that points to the desired export facet.*/
+    /** XPath that points to the desired export facet. */
     public static final String XPATH_FACET = "/art:action/@art:type";
 
 
-    /** The document of the incoming out() request.*/
+    /** The document of the incoming out() request. */
     protected Document request;
 
-    /** The output stream where the data should be written to.*/
+    /** The output stream where the data should be written to. */
     protected OutputStream out;
 
-    /** The CallContext object.*/
+    /** The CallContext object. */
     protected CallContext context;
 
-    /** The selected facet.*/
+    /** The selected facet. */
     protected String facet;
 
-    /** The master artifact.*/
+    /** The master artifact. */
     protected Artifact master;
 
 
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/DurationCurveExporter.java	Mon Sep 12 06:23:48 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/DurationCurveExporter.java	Mon Sep 12 09:00:08 2011 +0000
@@ -24,7 +24,7 @@
  */
 public class DurationCurveExporter extends AbstractExporter {
 
-    /** The logger used in this exporter.*/
+    /** The logger used in this exporter. */
     private static Logger logger = Logger.getLogger(WaterlevelExporter.class);
 
 
@@ -42,7 +42,7 @@
     public static final String DEFAULT_CSV_Q_HEADER  = "Q [m\u00b3/s]";
 
 
-    /** The storage that contains all WQKms objects for the different facets.*/
+    /** The storage that contains all WQKms objects for the different facets. */
     protected List<WQDay> data;
 
 

http://dive4elements.wald.intevation.org