diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.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/ArtifactFactory.java	Tue May 18 09:26:11 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java	Tue May 18 09:51:41 2010 +0000
@@ -1,6 +1,12 @@
 package de.intevation.gnv.artifactdatabase.objects;
 
 /**
+ * Implementation of an <code>ArtifactObject> which represents an
+ * <code>ArtifactFactory</code>
+ * This Class provides the name, the description, the URL where the 
+ * the <code>ArtifactDatabase</code> the factory belongs to could be reached 
+ * and if the <code>ArtifacFactory</code> is currently selected or not.
+ *  
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  */
 public class ArtifactFactory implements ArtifactObject {
@@ -10,12 +16,25 @@
      */
     private static final long serialVersionUID = 5453748230625831527L;
 
+    /**
+     * The name of the factory.
+     */
     private String name = null;
 
+    /**
+     * The description of the Factory.
+     */
     private String description = null;
 
+    /**
+     * Flag which mark the Artifactfactory as selected if value is true
+     * unselected if value is false.
+     */
     private boolean selected = false;
 
+    /**
+     * The URL where the Factory could be reached.
+     */
     private String dataBaseUrl = null;
 
     /**
@@ -33,7 +52,9 @@
      * @param description the description of the Factory
      * @param dataBaseUrl the URL where the Factory could be reached.
      */
-    public ArtifactFactory(String name, String description, String dataBaseUrl) {
+    public ArtifactFactory(String name, 
+                           String description, 
+                           String dataBaseUrl) {
         super();
         this.name = name;
         this.description = description;

http://dive4elements.wald.intevation.org