diff gnv-artifacts/src/main/java/de/intevation/gnv/state/MinMaxDateState.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents 7b81d563c8c0
children 499cfbbb61bc
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/MinMaxDateState.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/MinMaxDateState.java	Thu Apr 01 09:15:36 2010 +0000
@@ -25,36 +25,58 @@
 import org.w3c.dom.Document;
 
 /**
+ * This state handles date input. The resulting describe document of this state
+ * contains two fields in the user interface description to define a time range.
+ *
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class MinMaxDateState extends MinMaxState {
 
 
+    /**
+     *
+     */
     public static final String EXCEPTION_DATE_REQUIRED =
         "input.is.not.valid.date.required";
 
+    /**
+     *
+     */
     public static final String EXCEPTION_START_AFTER_END =
         "start.date.after.end.date";
 
+    /**
+     *
+     */
     public static final String EXCEPTION_DATE_OUT_OF_RANGE =
         "date.out.of.range";
 
+    /**
+     *
+     */
     public static final String EXCEPTION_MISSING_DATE =
         "missing.data.field";
 
     private static Logger logger = Logger.getLogger(MinMaxDateState.class);
 
 
+    /**
+     *
+     */
     public MinMaxDateState() {
         super();
     }
 
 
     /**
-     * @see de.intevation.gnv.state.StateBase#feed(java.util.Collection,
-     *      java.lang.String)
+     * This feed method needs a collection of two InputData objects. These
+     * objects' values need to be a datetime string which is turned into a Date
+     * object. Afterwards, the given dates are validated. Min and max date need
+     * to be in range of the min and max date retrieved by
+     * {@link #getDescibeData(java.lang.String)}.
      */
     @Override
+    @SuppressWarnings({"static-access", "static-access", "static-access"})
     public Document feed(
         CallContext           context,
         Collection<InputData> inputData,
@@ -71,7 +93,6 @@
             return feedFailure(msg);
         }
 
-        InputValidator iv = new InputValidator();
         Iterator iter     = inputData.iterator();
 
         MinMaxDescribeData data =
@@ -95,7 +116,7 @@
                 return feedFailure(msg);
             }
 
-            if (!iv.isInputValid(value, type)) {
+            if (!InputValidator.isInputValid(value, type)) {
                 String msg = resFactory.getRessource(
                     locale, EXCEPTION_DATE_REQUIRED, EXCEPTION_DATE_REQUIRED);
                 logger.error(msg);
@@ -134,7 +155,7 @@
                     logger.debug("Upper date bound: " + upper.toString());
                 }
 
-                if (!iv.isDateValid(d, lower, upper)) {
+                if (!InputValidator.isDateValid(d, lower, upper)) {
                     String msg = resFactory.getRessource(
                         locale,
                         EXCEPTION_DATE_OUT_OF_RANGE,
@@ -153,7 +174,7 @@
             }
 
             if (tmpMin != null && tmpMax != null) {
-                if (!iv.isInputValid((String) tmpMin, (String) tmpMax, type)) {
+                if (!InputValidator.isInputValid((String) tmpMin, (String) tmpMax, type)) {
                     String msg = resFactory.getRessource(
                         locale,
                         EXCEPTION_START_AFTER_END,
@@ -172,4 +193,4 @@
         return feedSuccess();
     }
 }
-// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8:
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org