# HG changeset patch
# User Ingo Weinzierl <ingo.weinzierl@intevation.de>
# Date 1269443351 0
# Node ID 1d23ab77fb725edf8259d390d0ef32b3cc4160d1
# Parent  79401c871da4becd4f4a9d757f541e244cc154ef
Added javadoc in de.intevation.gnv.wms package.

gnv-artifacts/trunk@824 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 79401c871da4 -r 1d23ab77fb72 gnv-artifacts/ChangeLog
--- a/gnv-artifacts/ChangeLog	Wed Mar 24 14:48:55 2010 +0000
+++ b/gnv-artifacts/ChangeLog	Wed Mar 24 15:09:11 2010 +0000
@@ -1,3 +1,8 @@
+2010-03-24  Ingo Weinzierl <ingo.weinzierl@intevation.de>
+
+	* src/main/java/de/intevation/gnv/wms/LayerInfo.java: Added javadoc in wms
+	  package.
+
 2010-03-24  Ingo Weinzierl <ingo.weinzierl@intevation.de>
 
 	* src/main/java/de/intevation/gnv/chart/Chart.java,
diff -r 79401c871da4 -r 1d23ab77fb72 gnv-artifacts/src/main/java/de/intevation/gnv/wms/LayerInfo.java
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/wms/LayerInfo.java	Wed Mar 24 14:48:55 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/wms/LayerInfo.java	Wed Mar 24 15:09:11 2010 +0000
@@ -1,78 +1,201 @@
 package de.intevation.gnv.wms;
 
 /**
- * @author Ingo Weinzierl (ingo.weinzierl@intevation.de)
+ * This class is used to store some meta information about a layer (e.g. a WMS
+ * layers).
+ *
+ * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class LayerInfo {
 
+    /**
+     * Constant field <code>LAYER</code>
+     */
     public static final String LAYER        = "layer";
+
+    /**
+     * Constant field <code>LAYER_MODEL</code>
+     */
     public static final String LAYER_MODEL  = "model";
+
+    /**
+     * Constant field <code>LAYER_NAME</code>
+     */
     public static final String LAYER_NAME   = "name";
+
+    /**
+     * Constant field <code>LAYER_TYPE</code>
+     */
     public static final String LAYER_TYPE   = "type";
+
+    /**
+     * Constant field <code>LAYER_DATA</code>
+     */
     public static final String LAYER_DATA   = "data";
+
+    /**
+     * Constant field <code>LAYER_STATUS</code>
+     */
     public static final String LAYER_STATUS = "status";
+
+    /**
+     * Constant field <code>LAYER_TITLE</code>
+     */
     public static final String LAYER_TITLE  = "title";
 
+    /**
+     * Field storing the layer name.
+     */
     private String name;
+
+    /**
+     * Field storing the layer title.
+     */
     private String title;
+
+    /**
+     * Field storing the layer type.
+     */
     private String type;
+
+    /**
+     * Field storing the layer data.
+     */
     private String data;
+
+    /**
+     * Field storing the layer status.
+     */
     private String status;
+
+    /**
+     * Field storing the layer model.
+     */
     private String model;
 
 
+    /**
+     * Constructs an empty object. All parameters should be set via setter
+     * methods.
+     */
     public LayerInfo() {
     }
 
 
+    /**
+     * Set {@link #data} to data.
+     *
+     * @param data 
+     */
     public void setData(String data) {
         this.data = data;
     }
 
+    /**
+     * Get {@link #data}
+     *
+     * @return data
+     */
     public String getData() {
         return data;
     }
 
+    /**
+     * Set {@link #name} to name.
+     *
+     * @param name
+     */
     public void setName(String name) {
         this.name = name;
     }
 
+    /**
+     * Get {@link #name}
+     *
+     * @return name
+     */
     public String getName() {
         return name;
     }
 
+    /**
+     * Set {@link #title} to title.
+     *
+     * @param title
+     */
     public void setTitle(String title) {
         this.title = title;
     }
 
+    /**
+     * Get {@link #title}
+     *
+     * @return title
+     */
     public String getTitle() {
         return title;
     }
 
+    /**
+     * Set {@link #model} to model.
+     *
+     * @param model
+     */
     public void setModel(String model) {
         this.model = model;
     }
 
+    /**
+     * Get {@link #model}
+     *
+     * @return model
+     */
     public String getModel() {
         return model;
     }
 
+    /**
+     * Set {@link #type} to type.
+     *
+     * @param type
+     */
     public void setType(String type) {
         this.type = type;
     }
 
+    /**
+     * Get {@link #type}
+     *
+     * @return type
+     */
     public String getType() {
         return type;
     }
 
+    /**
+     * Set {@link #status} to status.
+     *
+     * @param status
+     */
     public void setStatus(String status) {
         this.status = status;
     }
 
+    /**
+     * Get {@link #status}
+     *
+     * @return status
+     */
     public String getStatus() {
         return status;
     }
 
+    /**
+     * A <code>LayerInfo</code> object is emtpy if name, data, type and status
+     * are null.
+     *
+     * @return True, if this object is empty - otherwise false.
+     */
     public boolean isEmpty() {
         if (name == null && data == null && type == null && status == null)
             return true;
@@ -80,6 +203,11 @@
         return false;
     }
 
+    /**
+     * A <code>LayerInfo</code> object is broken if name, data or type are null.
+     *
+     * @return True, if this object is broken - otherwise false.
+     */
     public boolean isBroken() {
         if (name == null || data == null || type == null)
             return true;
@@ -87,3 +215,4 @@
         return false;
     }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :