comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultInputValue.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
comparison
equal deleted inserted replaced
795:cdade5005cba 796:a5526908f92f
1 package de.intevation.gnv.state; 1 package de.intevation.gnv.state;
2 2
3 /** 3 /**
4 * The default implementation of <code>InputValue</code>. InputValue objects are
5 * used to store meta information about <code>InputData</code> objects.
6 *
4 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> 7 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
5 *
6 */ 8 */
7 public class DefaultInputValue implements InputValue { 9 public class DefaultInputValue implements InputValue {
8 10
9 /** 11 /**
10 * The UID of this Class. 12 * The UID of this Class.
14 private String type = null; 16 private String type = null;
15 private boolean multiselect = false; 17 private boolean multiselect = false;
16 private int usedInQueries = 1; 18 private int usedInQueries = 1;
17 private String defaultValue = "N/N"; 19 private String defaultValue = "N/N";
18 20
21 /**
22 *
23 * @param name
24 * @param type
25 * @param defaultValue
26 * @param multiselect
27 */
19 public DefaultInputValue(String name, String type, String defaultValue, 28 public DefaultInputValue(String name, String type, String defaultValue,
20 boolean multiselect) { 29 boolean multiselect) {
21 this(name, type, multiselect, 1); 30 this(name, type, multiselect, 1);
22 this.defaultValue = defaultValue; 31 this.defaultValue = defaultValue;
23 32
24 } 33 }
25 34
26 /** 35 /**
27 * Constructor 36 * Constructor
37 * @param name
38 * @param type
39 * @param multiselect
40 * @param usedInQueries
28 */ 41 */
29 public DefaultInputValue(String name, String type, boolean multiselect, 42 public DefaultInputValue(String name, String type, boolean multiselect,
30 int usedInQueries) { 43 int usedInQueries) {
31 this.name = name; 44 this.name = name;
32 this.type = type; 45 this.type = type;
33 this.multiselect = multiselect; 46 this.multiselect = multiselect;
34 this.usedInQueries = usedInQueries; 47 this.usedInQueries = usedInQueries;
35 } 48 }
36 49
37 /** 50 /**
38 * @see de.intevation.gnv.state.InputValue#getName() 51 * @return
39 */ 52 */
40 public String getName() { 53 public String getName() {
41 return this.name; 54 return this.name;
42 } 55 }
43 56
44 /** 57 /**
45 * @see de.intevation.gnv.state.InputValue#getType() 58 * @return
46 */ 59 */
47 public String getType() { 60 public String getType() {
48 return this.type; 61 return this.type;
49 } 62 }
50 63
51 /** 64 /**
52 * @see java.lang.Object#toString() 65 * Returns the information as string.
66 *
67 * @return information as string.
53 */ 68 */
54 @Override 69 @Override
55 public String toString() { 70 public String toString() {
56 return "InputValue " + this.name + " ==> " + this.type 71 return "InputValue " + this.name + " ==> " + this.type
57 + "==> multiselect: " + this.multiselect; 72 + "==> multiselect: " + this.multiselect;
58 } 73 }
59 74
60 /** 75 /**
61 * @see de.intevation.gnv.state.InputValue#isMultiselect() 76 * @return
62 */ 77 */
63 public boolean isMultiselect() { 78 public boolean isMultiselect() {
64 return this.multiselect; 79 return this.multiselect;
65 } 80 }
66 81
82 /**
83 *
84 * @return
85 */
67 public int usedInQueries() { 86 public int usedInQueries() {
68 return this.usedInQueries; 87 return this.usedInQueries;
69 } 88 }
70 89
90 /**
91 *
92 * @return
93 */
71 public String getDefaultValue() { 94 public String getDefaultValue() {
72 return this.defaultValue; 95 return this.defaultValue;
73 } 96 }
74 97
75 } 98 }
99 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :

http://dive4elements.wald.intevation.org