changeset 963:0441e78cd900

Add more Javadocs gnv/trunk@1107 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 18 May 2010 11:09:33 +0000 (2010-05-18)
parents e7fda0ae8b92
children 3549253ecd7b
files gnv/ChangeLog gnv/src/main/java/de/intevation/gnv/action/ArtifactDatabaseActionBase.java gnv/src/main/java/de/intevation/gnv/action/CreateChartAction.java gnv/src/main/java/de/intevation/gnv/action/CreateHistogramAction.java gnv/src/main/java/de/intevation/gnv/action/DescribeUIAction.java gnv/src/main/java/de/intevation/gnv/action/FetchArtifactFactoriesAction.java gnv/src/main/java/de/intevation/gnv/action/LoadAction.java gnv/src/main/java/de/intevation/gnv/action/NextArtifactStepAction.java gnv/src/main/java/de/intevation/gnv/action/PreviousArtifactStepAction.java gnv/src/main/java/de/intevation/gnv/action/SelectArtifactFactoryAction.java gnv/src/main/java/de/intevation/gnv/action/SelectFisAction.java gnv/src/main/java/de/intevation/gnv/action/ShowStatisticAction.java gnv/src/main/java/de/intevation/gnv/action/StoreAction.java
diffstat 13 files changed, 175 insertions(+), 127 deletions(-) [+]
line wrap: on
line diff
--- a/gnv/ChangeLog	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/ChangeLog	Tue May 18 11:09:33 2010 +0000
@@ -1,3 +1,19 @@
+2010-05-18  Tim Englich  <tim.englich@intevation.de>
+
+	* src/main/java/de/intevation/gnv/action/StoreAction.java, 
+	  src/main/java/de/intevation/gnv/action/ShowStatisticAction.java, 
+	  src/main/java/de/intevation/gnv/action/SelectFisAction.java, 
+	  src/main/java/de/intevation/gnv/action/SelectArtifactFactoryAction.java,
+	  src/main/java/de/intevation/gnv/action/PreviousArtifactStepAction.java, 
+	  src/main/java/de/intevation/gnv/action/NextArtifactStepAction.java, 
+	  src/main/java/de/intevation/gnv/action/LoadAction.java, 
+	  src/main/java/de/intevation/gnv/action/FetchArtifactFactoriesAction.java, 
+	  src/main/java/de/intevation/gnv/action/DescribeUIAction.java, 
+	  src/main/java/de/intevation/gnv/action/CreateHistogramAction.java, 
+	  src/main/java/de/intevation/gnv/action/CreateChartAction.java, 
+	  src/main/java/de/intevation/gnv/action/ArtifactDatabaseActionBase.java:
+	  Added more Javadocs. Did some Codeformatting.
+
 2010-05-18  Tim Englich  <tim.englich@intevation.de>
 
 	* src/main/java/de/intevation/gnv/util/XSLTransformer.java: 
--- a/gnv/src/main/java/de/intevation/gnv/action/ArtifactDatabaseActionBase.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/ArtifactDatabaseActionBase.java	Tue May 18 11:09:33 2010 +0000
@@ -4,19 +4,29 @@
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.Action;
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
 /**
+ * Basicimplemantation for all Actions which should serv request for
+ * the GNV.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
 public class ArtifactDatabaseActionBase extends Action {
 
+    /**
+     * The id of the action which should used if the execution
+     * of the action was successful.
+     */
     protected final static String SUCCSESS_FORWARD_ID = "success";
+    
+    /**
+     * The id of the action which should be used if an exception has occurred
+     * during the execution. 
+     */
     protected final static String EXCEPTION_FORWARD_ID = "success";
 
     /**
@@ -32,25 +42,31 @@
         super();
     }
 
-
     @Override
     public ActionForward execute(ActionMapping mapping, ActionForm form,
                                  HttpServletRequest request,
                                  HttpServletResponse response) throws Exception {
         log.debug("ArtifactDatabaseActionBase.execute");
-
         ActionForward forward = mapping.findForward(SUCCSESS_FORWARD_ID);
         return forward;
     }
 
-
+    /**
+     * Returns the Action that should be used if an exception has occurred.
+     * @param mapping the mapping which holds all available Actions
+     * @return the Action that should be used.
+     */
     protected ActionForward getExceptionForward(ActionMapping mapping) {
         log.debug("ArtifactDatabaseActionBase.getExceptionForward");
         ActionForward lForward = mapping.findForward(EXCEPTION_FORWARD_ID);
         return lForward;
     }
 
-
+    /**
+     * Encodes the <code>String</code> to prevent cross-site-scripting
+     * @param s the string that should be encoded
+     * @return the encoded string
+     */
     protected String encode(String s) {
         log.debug("String to encode: " + s);
         s = s.replaceAll("<", "&lt;");
@@ -62,7 +78,11 @@
         return s;
     }
 
-
+    /**
+     * Encodes the <code>StringArray</code> to prevent cross-site-scripting
+     * @param s the stringarray that should be encoded
+     * @return the encoded stringarray
+     */
     protected String[] encode(String[] s) {
         if (s == null)
             return null;
--- a/gnv/src/main/java/de/intevation/gnv/action/CreateChartAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/CreateChartAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,17 +1,16 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+
 /**
  * This controller is called to display charts.<br>
  * An attribute 'chart' on the request object is activated which inserts an
@@ -21,9 +20,15 @@
  */
 public class CreateChartAction extends DescribeUIAction {
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(CreateChartAction.class);
 
 
+    /**
+     * Constructor
+     */
     public CreateChartAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/CreateHistogramAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/CreateHistogramAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,17 +1,16 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+
 /**
  * This controller is called to display histograms.<br>
  * An attribute 'histogram' on the request object is activated which inserts an
@@ -21,9 +20,15 @@
  */
 public class CreateHistogramAction extends DescribeUIAction {
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(CreateHistogramAction.class);
 
 
+    /**
+     * Constructor
+     */
     public CreateHistogramAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/DescribeUIAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/DescribeUIAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,35 +1,28 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
-import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
-
-import de.intevation.gnv.util.ArtifactNamespaceContext;
-import de.intevation.gnv.util.XMLUtils;
-import de.intevation.gnv.util.XSLTransformer;
-
 import java.util.Locale;
 import java.util.ResourceBundle;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
-
 import javax.xml.xpath.XPathConstants;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.Globals;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
+import org.w3c.dom.Node;
 
-import org.w3c.dom.Node;
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
+import de.intevation.gnv.util.ArtifactNamespaceContext;
+import de.intevation.gnv.util.XMLUtils;
+import de.intevation.gnv.util.XSLTransformer;
 
 /**
  * This controller is called to fetch the current artifact description using the
@@ -51,9 +44,15 @@
     public static final String XSL_SHEET_STATIC =
         "WEB-INF/config/templates/describe-ui-static.xsl";
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(DescribeUIAction.class);
 
 
+    /**
+     * Constructor
+     */
     public DescribeUIAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/FetchArtifactFactoriesAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/FetchArtifactFactoriesAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,25 +1,21 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseClientException;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
-
 import java.util.Collection;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseClientException;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
+
 /**
  * This controller fetches artifact factories from artifact server and stores
  * them on a <code>SessionModel</code> object.
@@ -28,12 +24,16 @@
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class FetchArtifactFactoriesAction extends ArtifactDatabaseActionBase {
+
     /**
      * the logger, used to log exceptions and additonaly information
      */
     private static Logger log = Logger
             .getLogger(FetchArtifactFactoriesAction.class);
 
+    /**
+     * Constructor
+     */
     public FetchArtifactFactoriesAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/LoadAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/LoadAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,22 +1,7 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseClientException;
-
-import de.intevation.gnv.artifactdatabase.objects.Artifact;
-import de.intevation.gnv.artifactdatabase.objects.ArtifactFactory;
-
-import de.intevation.gnv.util.ArtifactNamespaceContext;
-import de.intevation.gnv.util.XMLUtils;
-
 import java.io.IOException;
 import java.io.InputStream;
-
 import java.util.List;
 
 import javax.servlet.http.HttpServletRequest;
@@ -24,16 +9,22 @@
 
 import org.apache.commons.fileupload.FileItemIterator;
 import org.apache.commons.fileupload.FileItemStream;
-
 import org.apache.commons.fileupload.servlet.ServletFileUpload;
-
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
+import org.w3c.dom.Document;
 
-import org.w3c.dom.Document;
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseClientException;
+import de.intevation.gnv.artifactdatabase.objects.Artifact;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactFactory;
+import de.intevation.gnv.util.ArtifactNamespaceContext;
+import de.intevation.gnv.util.XMLUtils;
 
 /**
  * This controller is called for reloading projects from xml files. It waits for
@@ -48,12 +39,19 @@
     public static final String RESOURCE_UPLOAD_FAILURE   = "upload.failure";
     public static final String RESOURCE_INVALID_ARTIFACT = "invalid.artifact";
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(LoadAction.class);
 
+    /**
+     * Constructor
+     */
     public LoadAction() {
         super();
     }
 
+    @Override
     public ActionForward execute(
         ActionMapping       mapping,
         ActionForm          form,
--- a/gnv/src/main/java/de/intevation/gnv/action/NextArtifactStepAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/NextArtifactStepAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,17 +1,5 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseInputException;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
-import de.intevation.gnv.artifactdatabase.objects.DefaultInputParameter;
-import de.intevation.gnv.artifactdatabase.objects.InputParameter;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
@@ -22,11 +10,19 @@
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseInputException;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
+import de.intevation.gnv.artifactdatabase.objects.DefaultInputParameter;
+import de.intevation.gnv.artifactdatabase.objects.InputParameter;
+
 /**
  * This controller feeds the artifact server with the current input data and
  * refreshes the gui with the current artifact description after the next state
@@ -50,12 +46,6 @@
         super();
     }
 
-    /**
-     * @see de.intevation.gnv.action.ArtifactDatabaseActionBase#execute(org.apache.struts.action.ActionMapping,
-     *      org.apache.struts.action.ActionForm,
-     *      javax.servlet.http.HttpServletRequest,
-     *      javax.servlet.http.HttpServletResponse)
-     */
     @Override
     public ActionForward execute(ActionMapping mapping, ActionForm form,
                                  HttpServletRequest request,
--- a/gnv/src/main/java/de/intevation/gnv/action/PreviousArtifactStepAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/PreviousArtifactStepAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,23 +1,20 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
-import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
+
 /**
  * This controller is used to step back to a previous state of the current
  * artifact. After calling the advance operation of the artifact server have
@@ -31,10 +28,16 @@
 
     public static final String URL_STATE_KEY = "target";
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger =
         Logger.getLogger(PreviousArtifactStepAction.class);
 
 
+    /**
+     * Constructor
+     */
     public PreviousArtifactStepAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/SelectArtifactFactoryAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/SelectArtifactFactoryAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,36 +1,40 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
-
 import java.util.Collection;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
+
 /**
  * This controller is called to select a specific fis.
  *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  */
 public class SelectArtifactFactoryAction extends DescribeUIAction {
+
     /**
      * the logger, used to log exceptions and additonaly information
      */
     private static Logger log = Logger
             .getLogger(SelectArtifactFactoryAction.class);
 
+    /**
+     * Constructor
+     */
+    public SelectArtifactFactoryAction() {
+        super();
+    }
 
     @Override
     public ActionForward execute(ActionMapping mapping, ActionForm form,
@@ -72,11 +76,5 @@
             return super.getExceptionForward(mapping);
         }
     }
-
-    /**
-     * Constructor
-     */
-    public SelectArtifactFactoryAction() {
-    }
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
--- a/gnv/src/main/java/de/intevation/gnv/action/SelectFisAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/SelectFisAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,17 +1,16 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+
 /**
  * This controller is used to step back to the fis selection. It is called when
  * pushing the step-back button besides the currently selected fis.
@@ -20,6 +19,9 @@
  */
 public class SelectFisAction extends ArtifactDatabaseActionBase {
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(SelectFisAction.class);
 
     @Override
--- a/gnv/src/main/java/de/intevation/gnv/action/ShowStatisticAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/ShowStatisticAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,24 +1,21 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet;
-
 import java.util.Collection;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet;
+
 /**
  * This controller is used to display to statistic of the current
  * parameterization.
@@ -27,9 +24,15 @@
  */
 public class ShowStatisticAction extends DescribeUIAction {
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(ShowStatisticAction.class);
 
 
+    /**
+     * Constructor
+     */
     public ShowStatisticAction() {
         super();
     }
--- a/gnv/src/main/java/de/intevation/gnv/action/StoreAction.java	Tue May 18 10:52:12 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/action/StoreAction.java	Tue May 18 11:09:33 2010 +0000
@@ -1,24 +1,21 @@
 package de.intevation.gnv.action;
 
-import de.intevation.gnv.action.sessionmodel.SessionModel;
-import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
-
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
-import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
-
-import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
-
 import java.io.OutputStream;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.log4j.Logger;
-
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 
+import de.intevation.gnv.action.sessionmodel.SessionModel;
+import de.intevation.gnv.action.sessionmodel.SessionModelFactory;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClient;
+import de.intevation.gnv.artifactdatabase.client.ArtifactDatabaseClientFactory;
+import de.intevation.gnv.artifactdatabase.objects.ArtifactObject;
+
 /**
  * This controller is used to save the current artifact to an xml file. A file
  * dialog is opened to save the file to the local disk.
@@ -29,12 +26,19 @@
 
     public static final String RESOURCE_DOWNLOAD_FAILURE = "no.artifact.chosen";
 
+    /**
+     * the logger, used to log exceptions and additonaly information
+     */
     private static Logger logger = Logger.getLogger(StoreAction.class);
 
+    /**
+     * Constructor
+     */
     public StoreAction() {
         super();
     }
 
+    @Override
     public ActionForward execute(
         ActionMapping       mapping,
         ActionForm          form,
@@ -77,7 +81,12 @@
 
         return null;
     }
-
+    
+    /**
+     * Sets the header of the response.
+     * @param response the response
+     * @param uuid the uuid of the artifact
+     */
     protected void setHeaders(HttpServletResponse response, String uuid) {
         String filename = "GNVArtefakt_" + uuid + ".xml";
 

http://dive4elements.wald.intevation.org