Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/wms/LayerInfo.java @ 768:1d23ab77fb72

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added javadoc in de.intevation.gnv.wms package. gnv-artifacts/trunk@824 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Wed, 24 Mar 2010 15:09:11 +0000
parents 452fad121560
children 9a828e5a2390
comparison
equal deleted inserted replaced
767:79401c871da4 768:1d23ab77fb72
1 package de.intevation.gnv.wms; 1 package de.intevation.gnv.wms;
2 2
3 /** 3 /**
4 * @author Ingo Weinzierl (ingo.weinzierl@intevation.de) 4 * This class is used to store some meta information about a layer (e.g. a WMS
5 * layers).
6 *
7 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
5 */ 8 */
6 public class LayerInfo { 9 public class LayerInfo {
7 10
11 /**
12 * Constant field <code>LAYER</code>
13 */
8 public static final String LAYER = "layer"; 14 public static final String LAYER = "layer";
15
16 /**
17 * Constant field <code>LAYER_MODEL</code>
18 */
9 public static final String LAYER_MODEL = "model"; 19 public static final String LAYER_MODEL = "model";
20
21 /**
22 * Constant field <code>LAYER_NAME</code>
23 */
10 public static final String LAYER_NAME = "name"; 24 public static final String LAYER_NAME = "name";
25
26 /**
27 * Constant field <code>LAYER_TYPE</code>
28 */
11 public static final String LAYER_TYPE = "type"; 29 public static final String LAYER_TYPE = "type";
30
31 /**
32 * Constant field <code>LAYER_DATA</code>
33 */
12 public static final String LAYER_DATA = "data"; 34 public static final String LAYER_DATA = "data";
35
36 /**
37 * Constant field <code>LAYER_STATUS</code>
38 */
13 public static final String LAYER_STATUS = "status"; 39 public static final String LAYER_STATUS = "status";
40
41 /**
42 * Constant field <code>LAYER_TITLE</code>
43 */
14 public static final String LAYER_TITLE = "title"; 44 public static final String LAYER_TITLE = "title";
15 45
46 /**
47 * Field storing the layer name.
48 */
16 private String name; 49 private String name;
50
51 /**
52 * Field storing the layer title.
53 */
17 private String title; 54 private String title;
55
56 /**
57 * Field storing the layer type.
58 */
18 private String type; 59 private String type;
60
61 /**
62 * Field storing the layer data.
63 */
19 private String data; 64 private String data;
65
66 /**
67 * Field storing the layer status.
68 */
20 private String status; 69 private String status;
70
71 /**
72 * Field storing the layer model.
73 */
21 private String model; 74 private String model;
22 75
23 76
77 /**
78 * Constructs an empty object. All parameters should be set via setter
79 * methods.
80 */
24 public LayerInfo() { 81 public LayerInfo() {
25 } 82 }
26 83
27 84
85 /**
86 * Set {@link #data} to data.
87 *
88 * @param data
89 */
28 public void setData(String data) { 90 public void setData(String data) {
29 this.data = data; 91 this.data = data;
30 } 92 }
31 93
94 /**
95 * Get {@link #data}
96 *
97 * @return data
98 */
32 public String getData() { 99 public String getData() {
33 return data; 100 return data;
34 } 101 }
35 102
103 /**
104 * Set {@link #name} to name.
105 *
106 * @param name
107 */
36 public void setName(String name) { 108 public void setName(String name) {
37 this.name = name; 109 this.name = name;
38 } 110 }
39 111
112 /**
113 * Get {@link #name}
114 *
115 * @return name
116 */
40 public String getName() { 117 public String getName() {
41 return name; 118 return name;
42 } 119 }
43 120
121 /**
122 * Set {@link #title} to title.
123 *
124 * @param title
125 */
44 public void setTitle(String title) { 126 public void setTitle(String title) {
45 this.title = title; 127 this.title = title;
46 } 128 }
47 129
130 /**
131 * Get {@link #title}
132 *
133 * @return title
134 */
48 public String getTitle() { 135 public String getTitle() {
49 return title; 136 return title;
50 } 137 }
51 138
139 /**
140 * Set {@link #model} to model.
141 *
142 * @param model
143 */
52 public void setModel(String model) { 144 public void setModel(String model) {
53 this.model = model; 145 this.model = model;
54 } 146 }
55 147
148 /**
149 * Get {@link #model}
150 *
151 * @return model
152 */
56 public String getModel() { 153 public String getModel() {
57 return model; 154 return model;
58 } 155 }
59 156
157 /**
158 * Set {@link #type} to type.
159 *
160 * @param type
161 */
60 public void setType(String type) { 162 public void setType(String type) {
61 this.type = type; 163 this.type = type;
62 } 164 }
63 165
166 /**
167 * Get {@link #type}
168 *
169 * @return type
170 */
64 public String getType() { 171 public String getType() {
65 return type; 172 return type;
66 } 173 }
67 174
175 /**
176 * Set {@link #status} to status.
177 *
178 * @param status
179 */
68 public void setStatus(String status) { 180 public void setStatus(String status) {
69 this.status = status; 181 this.status = status;
70 } 182 }
71 183
184 /**
185 * Get {@link #status}
186 *
187 * @return status
188 */
72 public String getStatus() { 189 public String getStatus() {
73 return status; 190 return status;
74 } 191 }
75 192
193 /**
194 * A <code>LayerInfo</code> object is emtpy if name, data, type and status
195 * are null.
196 *
197 * @return True, if this object is empty - otherwise false.
198 */
76 public boolean isEmpty() { 199 public boolean isEmpty() {
77 if (name == null && data == null && type == null && status == null) 200 if (name == null && data == null && type == null && status == null)
78 return true; 201 return true;
79 202
80 return false; 203 return false;
81 } 204 }
82 205
206 /**
207 * A <code>LayerInfo</code> object is broken if name, data or type are null.
208 *
209 * @return True, if this object is broken - otherwise false.
210 */
83 public boolean isBroken() { 211 public boolean isBroken() {
84 if (name == null || data == null || type == null) 212 if (name == null || data == null || type == null)
85 return true; 213 return true;
86 214
87 return false; 215 return false;
88 } 216 }
89 } 217 }
218 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org