diff gnv-artifacts/src/main/java/de/intevation/gnv/state/ExtendedInputData.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 c907636c0288
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/ExtendedInputData.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/ExtendedInputData.java	Thu Apr 01 09:15:36 2010 +0000
@@ -1,14 +1,32 @@
 package de.intevation.gnv.state;
 
 /**
+ * This class is used to save the relation between two attributes. Mainly used
+ * to save the relation between a measurement and the parameter it belongs to.
+ * 
+ * @see MeasurementState
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class ExtendedInputData extends DefaultInputData {
 
+    /**
+     * The separater used to separate measurement ids and parameter ids.
+     */
     public static final String SEPARATOR = ";";
 
+    /**
+     * The parameter this object belongs to.
+     */
     protected String parameterid;
 
+    /**
+     * Constructcor.
+     *
+     * @param name
+     * @param value
+     * @param object
+     * @param parameterid
+     */
     public ExtendedInputData(
         String name,
         String value,
@@ -19,14 +37,29 @@
         this.parameterid = parameterid;
     }
 
+    /**
+     * Return the parameter ids this object belongs to.
+     *
+     * @return the parameter id.
+     */
     public String getParameterID() {
         return parameterid;
     }
 
+    /**
+     * Set the parameter ids.
+     *
+     * @param parameterid Parameter ids.
+     */
     public void setParameter(String parameterid) {
         this.parameterid = parameterid;
     }
 
+    /**
+     * Return all parameter ids as array.
+     *
+     * @return Array of parameter ids.
+     */
     public String[] splitParameter() {
         if (parameterid != null)
             return parameterid.split(SEPARATOR);

http://dive4elements.wald.intevation.org