annotate servlet/src/digilib/servlet/Parameter.java @ 153:4980c969be4c

Servlet version 1.16a1 - cleanup of DigilibConfig class - now uses new Parameter and ParameterMap classes - new parameter default-quality
author robcast
date Wed, 03 Sep 2003 00:56:16 +0200
parents
children d40922628e4a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
153
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
1 /* Parameter -- General digilib parameter class.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
2
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
3 Digital Image Library servlet components
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
4
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
5 Copyright (C) 2003 Robert Casties (robcast@mail.berlios.de)
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
6
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
7 This program is free software; you can redistribute it and/or modify it
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
9 Free Software Foundation; either version 2 of the License, or (at your
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
10 option) any later version.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
11
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
12 Please read license.txt for the full details. A copy of the GPL
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
13 may be found at http://www.gnu.org/copyleft/lgpl.html
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
14
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
16 along with this program; if not, write to the Free Software
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
18
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
19 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
20 * Created on 02.09.2003 by casties
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
21 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
22 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
23 package digilib.servlet;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
24
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
25 /** General digilib parameter class.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
26 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
27 * @author casties
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
28 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
29 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
30 public class Parameter {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
31 /** real value */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
32 protected Object value = null;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
33
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
34 /** default value */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
35 protected Object defval = null;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
36
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
37 /** parameter name (e.g. in config file) */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
38 protected String name = null;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
39
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
40 /** parameter type */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
41 protected int type = 0;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
42
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
43 /** Default constructor.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
44 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
45 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
46 public Parameter() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
47 super();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
48 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
49
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
50 /** Constructor with name, default, and value.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
51 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
52 * @param value
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
53 * @param defval
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
54 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
55 public Parameter(String name, Object defval, Object value) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
56 this.name = name;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
57 this.value = value;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
58 this.defval = defval;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
59 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
60
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
61 /** Constructor with name, default, value, and type.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
62 * @param value
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
63 * @param defval
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
64 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
65 public Parameter(String name, Object defval, Object value, int type) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
66 this.name = name;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
67 this.value = value;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
68 this.defval = defval;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
69 this.type = type;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
70 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
71
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
72 /** Is the value valid.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
73 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
74 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
75 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
76 public boolean hasValue() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
77 return (value != null);
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
78 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
79
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
80 /** Try to set the value from a String.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
81 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
82 * Tries to convert the String to the same type as the default value.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
83 * Sets the value anyway if the default is null.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
84 * Returns if the value could be set.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
85 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
86 * @param val
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
87 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
88 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
89 public boolean setValueFromString(String val) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
90 if (defval == null) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
91 this.value = val;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
92 return true;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
93 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
94 Class c = defval.getClass();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
95 // take String as is
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
96 if (c == String.class) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
97 this.value = val;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
98 return true;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
99 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
100 // set Boolean if string == "true"
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
101 if (c == Boolean.class) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
102 this.value = new Boolean(val.compareToIgnoreCase("true") == 0);
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
103 return true;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
104 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
105 // set Integer
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
106 if (c == Integer.class) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
107 this.value = new Integer(Integer.parseInt(val));
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
108 return true;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
109 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
110 // set Float
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
111 if (c == Float.class) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
112 this.value = new Float(Float.parseFloat(val));
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
113 return true;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
114 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
115 // then it's unknown
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
116 return false;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
117 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
118
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
119 /** Get the default as Object.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
120 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
121 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
122 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
123 public Object getDefault() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
124 return defval;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
125 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
126
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
127 /** Set the default.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
128 * @param defval
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
129 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
130 public void setDefault(Object defval) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
131 this.defval = defval;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
132 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
133
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
134 /** Get the value as Object.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
135 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
136 * Returns the default if the value is not set.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
137 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
138 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
139 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
140 public Object getValue() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
141 return (value != null) ? value : defval;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
142 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
143
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
144 public int getAsInt() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
145 Integer i = (Integer) getValue();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
146 return (i != null) ? i.intValue() : 0;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
147 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
148
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
149 public float getAsFloat() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
150 Float f = (Float) getValue();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
151 return (f != null) ? f.floatValue() : 0f;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
152 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
153
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
154 public String getAsString() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
155 return (String) getValue();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
156 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
157
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
158 public boolean getAsBoolean() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
159 Boolean b = (Boolean) getValue();
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
160 return (b != null) ? b.booleanValue() : false;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
161 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
162
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
163 /** Set the value.
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
164 *
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
165 * @param value
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
166 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
167 public void setValue(Object value) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
168 this.value = value;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
169 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
170
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
171 /**
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
172 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
173 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
174 public String getName() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
175 return name;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
176 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
177
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
178 /**
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
179 * @param name
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
180 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
181 public void setName(String name) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
182 this.name = name;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
183 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
184
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
185 /**
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
186 * @return
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
187 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
188 public int getType() {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
189 return type;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
190 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
191
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
192 /**
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
193 * @param type
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
194 */
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
195 public void setType(int type) {
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
196 this.type = type;
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
197 }
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
198
4980c969be4c Servlet version 1.16a1
robcast
parents:
diff changeset
199 }