changeset 3346:f2039d030b5e

Cosmetics, docs. flys-client/trunk@5016 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Mon, 16 Jul 2012 08:37:24 +0000
parents e7d820bb053c
children 6d749af6a9c2
files flys-client/ChangeLog flys-client/src/main/java/de/intevation/flys/client/client/ui/ParameterList.java flys-client/src/main/java/de/intevation/flys/client/server/AdvanceServiceImpl.java flys-client/src/main/java/de/intevation/flys/client/server/MetaDataServiceImpl.java
diffstat 4 files changed, 28 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/flys-client/ChangeLog	Mon Jul 16 06:39:44 2012 +0000
+++ b/flys-client/ChangeLog	Mon Jul 16 08:37:24 2012 +0000
@@ -1,3 +1,10 @@
+2012-07-13	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	* src/main/java/de/intevation/flys/client/server/MetaDataServiceImpl.java,
+	  src/main/java/de/intevation/flys/client/server/AdvanceServiceImpl.java,
+	  src/main/java/de/intevation/flys/client/client/ui/ParameterList.java:
+	  Cosmetics, docs.
+
 2012-07-16  Ingo Weinzierl <ingo@intevation.de>
 
 	* Tagged module as '2.8'.
--- a/flys-client/src/main/java/de/intevation/flys/client/client/ui/ParameterList.java	Mon Jul 16 06:39:44 2012 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/client/ui/ParameterList.java	Mon Jul 16 08:37:24 2012 +0000
@@ -207,7 +207,7 @@
         stack.setCanResizeSections(true);
         stack.setVisibilityMode(VisibilityMode.MULTIPLE);
 
-        // This canvas is used to render helper widgets
+        // This canvas is used to render helper widgets.
         final SectionStackSection helperSection = new SectionStackSection();
         helperSection.setExpanded(false);
         helperSection.setTitle(MSG.helperPanelTitle());
@@ -226,7 +226,7 @@
         helperPanel.setHeight100();
         helperSection.setItems(helperPanel);
 
-        // This canvas is used to render calculation results
+        // This canvas is used to render calculation results.
         final SectionStackSection tableSection = new SectionStackSection();
         tableSection.setExpanded(false);
         tableSection.setTitle(MSG.calcTableTitle());
@@ -251,6 +251,7 @@
     }
 
 
+    /** Sets and forwards artifact. */
     protected void setArtifact(Artifact artifact) {
         setArtifact(artifact, true);
     }
@@ -322,7 +323,7 @@
             null,
             items);
 
-        LinkSelection widget         = new LinkSelection();
+        LinkSelection widget           = new LinkSelection();
         HasStepForwardHandlers handler = (HasStepForwardHandlers) widget;
 
         widget.setContainer(helperPanel);
@@ -348,7 +349,7 @@
                 Config config       = Config.getInstance();
                 final String locale = config.getLocale();
 
-                final Data[] feedData  = new Data[] { data[1] };
+                final Data[] feedData = new Data[] { data[1] };
 
                 artifactService.create(
                     locale, module.toLowerCase(), null,
@@ -582,8 +583,8 @@
     public void onStepForward(StepForwardEvent event) {
         GWT.log("CollectionView - onStepForward()");
 
-        Config config    = Config.getInstance();
-        String locale    = config.getLocale();
+        Config config = Config.getInstance();
+        String locale = config.getLocale();
 
         forwardService.go(locale, artifact, event.getData(),
             new AsyncCallback<Artifact>() {
--- a/flys-client/src/main/java/de/intevation/flys/client/server/AdvanceServiceImpl.java	Mon Jul 16 06:39:44 2012 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/server/AdvanceServiceImpl.java	Mon Jul 16 08:37:24 2012 +0000
@@ -31,7 +31,6 @@
 {
     private static final Logger logger = Logger.getLogger(AdvanceService.class);
 
-
     public static final String XPATH_RESULT = "/art:result/text()";
 
     public static final String OPERATION_FAILURE = "FAILED";
@@ -47,7 +46,7 @@
     {
         logger.info("AdvanceServiceImpl.advance");
 
-        String url  = getServletContext().getInitParameter("server-url");
+        String url = getServletContext().getInitParameter("server-url");
 
         Document advance = ClientProtocolUtils.newAdvanceDocument(
             artifact.getUuid(),
--- a/flys-client/src/main/java/de/intevation/flys/client/server/MetaDataServiceImpl.java	Mon Jul 16 06:39:44 2012 +0000
+++ b/flys-client/src/main/java/de/intevation/flys/client/server/MetaDataServiceImpl.java	Mon Jul 16 08:37:24 2012 +0000
@@ -24,17 +24,29 @@
 
 import de.intevation.flys.client.server.meta.Converter;
 
+/**
+ * Service that returns certain meta-data from the backends data, polished to
+ * inclusion into current project.
+ */
 public class MetaDataServiceImpl
 extends      RemoteServiceServlet
 implements   MetaDataService
 {
+    /** Our very own logger. */
     private static final Logger logger =
         Logger.getLogger(MetaDataServiceImpl.class);
 
-
     public static final String ERROR_NO_META_DATA_FOUND =
         "error_no_meta_data_found";
 
+
+    /**
+     * @param locale needed for i18n.
+     * @param artifactId ID of masterartifact (can be null)
+     * @param userId can be null
+     * @param outs can be null
+     * @param parameters can be null
+     */
     @Override
     public DataCageTree getMetaData(
         String locale,

http://dive4elements.wald.intevation.org