diff gnv-artifacts/src/main/java/de/intevation/gnv/transition/ValueCompareTransition.java @ 824:7e5995c47125

Added more Javadoc. gnv-artifacts/trunk@913 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 08:49:42 +0000
parents 79c1db3ca7cc
children 2423cefe7d39
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/transition/ValueCompareTransition.java	Tue Apr 13 08:25:34 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/transition/ValueCompareTransition.java	Tue Apr 13 08:49:42 2010 +0000
@@ -1,19 +1,20 @@
 package de.intevation.gnv.transition;
 
-import de.intevation.artifactdatabase.Config;
-
-import de.intevation.gnv.state.InputData;
-import de.intevation.gnv.state.State;
-
-import de.intevation.gnv.state.exception.StateException;
-
 import java.util.Iterator;
 
 import org.apache.log4j.Logger;
-
 import org.w3c.dom.Node;
 
+import de.intevation.artifactdatabase.Config;
+import de.intevation.gnv.state.InputData;
+import de.intevation.gnv.state.State;
+import de.intevation.gnv.state.exception.StateException;
+
 /**
+ * Class which supports the possibility to validate if a
+ * Transition could be done using simple Valuecompare Operations.
+ * At this Time equal and notequal-operations are supported.
+ * The Comparation is casesensitive.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -23,24 +24,38 @@
      * the logger, used to log exceptions and additonaly information
      */
     private static Logger log = Logger.getLogger(ValueCompareTransition.class);
-
-    private String dataName = null;
-    private String dataValue = null;
-    private String operator = null;
-
     /**
      * The UID of this Class.
      */
     private static final long serialVersionUID = -7846722158776823205L;
 
     /**
+     * The Name of the Datafield the Value  that should be compared 
+     * should be fetched from.
+     */
+    private String dataName = null;
+    /**
+     * The Value that should be set to the State.
+     */
+    private String dataValue = null;
+    /**
+     * The Operation that should be used (equal notequal)
+     */
+    private String operator = null;
+
+
+    /**
      * Constructor
      */
     public ValueCompareTransition() {
         super();
     }
 
-
+    /**
+     * validates if a Transition is valid and could be used using simple
+     * Comparevalue-Operations.
+     * @see de.intevation.gnv.transition.Transition#isValid(de.intevation.gnv.state.State)
+     */
     public boolean isValid(State state) {
 
         try {

http://dive4elements.wald.intevation.org