diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java @ 958:d5d4dbda17cc

Add more Javadocs gnv/trunk@1102 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 18 May 2010 09:51:41 +0000
parents 89ade245ca7a
children 28a0628b11b0
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java	Tue May 18 09:26:11 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/Artifact.java	Tue May 18 09:51:41 2010 +0000
@@ -19,18 +19,63 @@
      */
     private static final long serialVersionUID = 8606869493141810364L;
 
+    /**
+     * The uuid of this Artifact which must be used to identify 
+     * the artifact at the <code>ArtifactDatabase</code>.
+     */
     private String id = null;
+
+    /**
+     * The hash of the artifact which was send be the <code>ArtifactDatabase</code>.
+     */
     private String hash = null;
+
+    /**
+     * Flag which marks if the Artifact is currently selected or not. 
+     */
     private boolean selected = false;
 
+    /**
+     * The XML-Node of the current User-Interface
+     */
     private Node currentUI = null;
+    
+    /**
+     * The XML-Nodes of the OutputModes.
+     */
     private Node currentOut = null;
 
+    /**
+     * The ids of the states which could be reached.
+     */
     private Collection<String> reachableStates;
+
+    /**
+     * The parameters whcih could be feed to the artifact at the current state.
+     */
     private Collection<String> inputParameter;
+
+    /**
+     * The <code>OutputModes</code> that could be reached at the current state.
+     */
     private Map<String, OutputMode> outputModes;
+
+    /**
+     * The id of the state which is currently used.
+     */
     private String currentState = null;
 
+    /**
+     * Constructor
+     * @param uuid the uuid of this Artifact which must be used to identify 
+     *             the artifact at the <code>ArtifactDatabase</code>
+     * @param hash the hash of the artifact which was send be the 
+     *             <code>ArtifactDatabase</code>
+     */
+    public Artifact(String uuid, String hash) {
+        this.id = uuid;
+        this.hash = hash;
+    }
 
     public Node getCurrentUI() {
         return currentUI;
@@ -71,16 +116,6 @@
         this.currentState = currentState;
     }
 
-    /**
-     * Constructor
-     */
-    public Artifact(String uuid, String hash) {
-
-        this.id = uuid;
-        this.hash = hash;
-    }
-
-
     public String getHash() {
         return this.hash;
     }

http://dive4elements.wald.intevation.org