Coverage Report

Coverage Report - org.apache.commons.workflow.base.BaseDescriptor

Classes in this File

Line Coverage

Branch Coverage

Complexity

BaseDescriptor

0/97

0/56

2.895

 /*
  * Copyright 1999-2001,2004 The Apache Software Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  * 
  *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ 
 
 package org.apache.commons.workflow.base;
 
 
 import java.util.EmptyStackException;
 import org.apache.commons.jxpath.JXPathContext;
 import org.apache.commons.workflow.Context;
 import org.apache.commons.workflow.Descriptor;
 
 
 /**
  * <p>Basic implementation of the <strong>Descriptor</strong> interface.</p>
  *
  * @version $Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $
  * @author Craig R. McClanahan
  */
 
 public class BaseDescriptor implements Descriptor {
 
 
     // ----------------------------------------------------------- Constructors
 
 
     /**
      * Create an instance with default values.
      */
     public BaseDescriptor() {
 
         super();
 
     }
 
 
     /**
      * Create an instance with the specified values.
      *
      * @param xpath The XPath reference expression
      */
     public BaseDescriptor(String xpath) {
 
         this(null, null, xpath, null);
 
     }
 
 
     /**
      * Create an instance with the specified values.
      *
      * @param xpath The XPath reference expression
      * @param type The expected class of this object
      */
     public BaseDescriptor(String xpath, Class type) {
 
         this(null, null, xpath, type);
 
     }
 
 
     /**
      * Create an instance with the specified values.
      *
      * @param name The object name
      * @param scope The object scope
      */
     public BaseDescriptor(String name, String scope) {
 
         this(name, scope, null, null);
 
     }
 
 
     /**
      * Create an instance with the specified values.
      *
      * @param name The object name
      * @param scope The object scope
      * @param type The expected class of this object
      */
     public BaseDescriptor(String name, String scope, Class type) {
 
         this(name, scope, null, type);
 
     }
 
 
     /**
      * Create an instance with the specified values.
      *
      * @param name The object name
      * @param scope The object scope
      * @param xpath The XPath reference expression
      * @param type The expected class
      */
     public BaseDescriptor(String name, String scope,
                           String xpath, Class type) {
 
         super();
         setName(name);
         setScope(scope);
         setXpath(xpath);
         setType(type);
 
     }
 
 
     // ----------------------------------------------------- Instance Variables
 
 
     /**
      * The name of the Java object (in some scope).
      */
     protected String name = null;
 
 
     /**
      * The scope of the Java object.
      */
     protected String scope = null;
 
 
     /**
      * The optional Java class expected by this Descriptor.
      */
     protected Class type = null;
 
 
     /**
      * The XPath expression used to access the Java object.
      */
     protected String xpath = null;
 
 
     // ------------------------------------------------------------- Properties
 
 
     /**
      * Return the name of the Java object (in some scope) referenced by
      * this Descriptor.
      */
     public String getName() {
 
         return (this.name);
 
     }
 
 
     /**
      * Set the name of the Java object (in some scope) referenced by
      * this Descriptor.
      *
      * @param name The new object name
      */
     public void setName(String name) {
 
         this.name = name;
 
     }
 
 
     /**
      * Return the scope of the Java object referenced by this Descriptor.
      */
     public String getScope() {
 
         return (this.scope);
 
     }
 
 
     /**
      * Set the scope of the Java object referenced by this Descriptor.
      *
      * @param scope The new scope name
      */
     public void setScope(String scope) {
 
         this.scope = scope;
 
     }
 
 
     /**
      * Return the optional Java class expected by this Descriptor.
      */
     public Class getType() {
 
         return (this.type);
 
     }
 
 
     /**
      * Set the optional Java class expected by this Descriptor.
      *
      * @param type The new expected type
      */
     public void setType(Class type) {
 
         this.type = type;
 
     }
 
 
     /**
      * Return the XPath expression used to access the Java object
      * referenced by this Descriptor.
      */
     public String getXpath() {
 
         return (this.xpath);
 
     }
 
 
     /**
      * Set the XPath expression used to access the Java object
      * referenced by this Descriptor.
      *
      * @param xpath The new XPath expression
      */
     public void setXpath(String xpath) {
 
         this.xpath = xpath;
 
     }
 
 
     // --------------------------------------------------------- Public Methods
 
 
     /**
      * Return the value specified by this Descriptor from the specified
      * Context.  If there is no such value, return <code>null</code>.
      *
      * @param context Context from which to retrieve this value
      */
     public Object get(Context context) {
 
         if (xpath != null) {
             JXPathContext jpc = context.getJXPathContext();
             jpc.setLenient(true);
             return (jpc.getValue("local/" + xpath));
         } else if (name != null) {
             if (scope == null)
                 return (context.get(name));
             else {
                 int scopeId = context.getScopeId(scope);
                 return (context.get(name, scopeId));
             }
         } else {
             try {
                 return (context.pop());
             } catch (EmptyStackException e) {
                 return (null);
             }
         }
 
     }
 
 
     /**
      * <p>Call <code>get()</code> to retrieve the value specified by this
      * Descriptor, and then return <code>true</code> if this value represents
      * a positive result; otherwise return <code>false</code>.  A positive
      * result depends on the data type of the retrieved value:</p>
      * <ul>
      * <li>Value returned is a <code>String</code> of length greater than 0.
      *     </li>
      * <li>Value is a Boolean "true"</code>.</li>
      * <li>Value is a numeric primitive (byte, char, float, double, int,
      *     long, short), or an Object wrapper for one of these types, and
      *     the corresponding value is non-zero.</li>
      * <li>Value returned is a non-null Object.</li>
      * </ul>
      *
      * @param context Context from which to retrieve this value
      */
     public boolean positive(Context context) {
 
         Object value = get(context);
         if (value == null)
             return (false);
         else if (value instanceof Boolean)
             return (((Boolean) value).booleanValue());
         else if (value instanceof Byte)
             return (((Byte) value).byteValue() != (byte) 0);
         else if (value instanceof Character)
             return (((Character) value).charValue() != (char) 0);
         else if (value instanceof Double)
             return (((Double) value).doubleValue() != (double) 0.0);
         else if (value instanceof Float)
             return (((Double) value).floatValue() != (float) 0.0);
         else if (value instanceof Integer)
             return (((Integer) value).intValue() != (int) 0);
         else if (value instanceof Long)
             return (((Long) value).longValue() != (long) 0);
         else if (value instanceof Short)
             return (((Short) value).shortValue() != (short) 0);
         else if (value instanceof String)
             return (((String) value).length() > 0);
         else
             return (true); // Non-null object
 
 
     }
 
 
     /**
      * Store the value into the destination specified by this Descriptor
      * in the specified Context, replacing any existing value.
      *
      * @param context Context into which to store this value
      * @param value Object value to be stored
      */
     public void put(Context context, Object value) {
 
         if (xpath != null) {
             JXPathContext jpc = context.getJXPathContext();
             jpc.setValue("local/" + xpath, value);
         } else {
             if (scope == null)
                 context.put(name, value);
             else {
                 int scopeId = context.getScopeId(scope);
                 context.put(name, value, scopeId);
             }
         }
 
     }
 
 
     /**
      * Remove any existing value associated with this Descriptor from the
      * specified Context.
      *
      * @param context Context from which to remove this value.
      */
     public void remove(Context context) {
 
         if (xpath != null) {
             throw new IllegalStateException("Cannot 'remove' throw xpath");
         } else {
             if (scope == null)
                 context.remove(name);
             else {
                 int scopeId = context.getScopeId(scope);
                 context.remove(name, scopeId);
             }
         }
 
     }
 
 
     /**
      * Render a printable version of this object.
      */
     public String toString() {
 
         StringBuffer sb = new StringBuffer("<descriptor");
         if (xpath != null) {
             sb.append(" xpath=\"");
             sb.append(xpath);
             sb.append("\"");
         }
         if (name != null) {
             sb.append(" name=\"");
             sb.append(name);
             sb.append("\"");
         }
         if (scope != null) {
             sb.append(" scope=\"");
             sb.append(scope);
             sb.append("\"");
         }
         sb.append("/>");
         return (sb.toString());
 
     }
 
 
 }

1		/*
2		* Copyright 1999-2001,2004 The Apache Software Foundation.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16
17		package org.apache.commons.workflow.base;
18
19
20		import java.util.EmptyStackException;
21		import org.apache.commons.jxpath.JXPathContext;
22		import org.apache.commons.workflow.Context;
23		import org.apache.commons.workflow.Descriptor;
24
25
26		/**
27		* <p>Basic implementation of the <strong>Descriptor</strong> interface.</p>
28		*
29		* @version $Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $
30		* @author Craig R. McClanahan
31		*/
32
33		public class BaseDescriptor implements Descriptor {
34
35
36		// ----------------------------------------------------------- Constructors
37
38
39		/**
40		* Create an instance with default values.
41		*/
42		public BaseDescriptor() {
43
44	0	super();
45
46	0	}
47
48
49		/**
50		* Create an instance with the specified values.
51		*
52		* @param xpath The XPath reference expression
53		*/
54		public BaseDescriptor(String xpath) {
55
56	0	this(null, null, xpath, null);
57
58	0	}
59
60
61		/**
62		* Create an instance with the specified values.
63		*
64		* @param xpath The XPath reference expression
65		* @param type The expected class of this object
66		*/
67		public BaseDescriptor(String xpath, Class type) {
68
69	0	this(null, null, xpath, type);
70
71	0	}
72
73
74		/**
75		* Create an instance with the specified values.
76		*
77		* @param name The object name
78		* @param scope The object scope
79		*/
80		public BaseDescriptor(String name, String scope) {
81
82	0	this(name, scope, null, null);
83
84	0	}
85
86
87		/**
88		* Create an instance with the specified values.
89		*
90		* @param name The object name
91		* @param scope The object scope
92		* @param type The expected class of this object
93		*/
94		public BaseDescriptor(String name, String scope, Class type) {
95
96	0	this(name, scope, null, type);
97
98	0	}
99
100
101		/**
102		* Create an instance with the specified values.
103		*
104		* @param name The object name
105		* @param scope The object scope
106		* @param xpath The XPath reference expression
107		* @param type The expected class
108		*/
109		public BaseDescriptor(String name, String scope,
110		String xpath, Class type) {
111
112	0	super();
113	0	setName(name);
114	0	setScope(scope);
115	0	setXpath(xpath);
116	0	setType(type);
117
118	0	}
119
120
121		// ----------------------------------------------------- Instance Variables
122
123
124		/**
125		* The name of the Java object (in some scope).
126		*/
127	0	protected String name = null;
128
129
130		/**
131		* The scope of the Java object.
132		*/
133	0	protected String scope = null;
134
135
136		/**
137		* The optional Java class expected by this Descriptor.
138		*/
139	0	protected Class type = null;
140
141
142		/**
143		* The XPath expression used to access the Java object.
144		*/
145	0	protected String xpath = null;
146
147
148		// ------------------------------------------------------------- Properties
149
150
151		/**
152		* Return the name of the Java object (in some scope) referenced by
153		* this Descriptor.
154		*/
155		public String getName() {
156
157	0	return (this.name);
158
159		}
160
161
162		/**
163		* Set the name of the Java object (in some scope) referenced by
164		* this Descriptor.
165		*
166		* @param name The new object name
167		*/
168		public void setName(String name) {
169
170	0	this.name = name;
171
172	0	}
173
174
175		/**
176		* Return the scope of the Java object referenced by this Descriptor.
177		*/
178		public String getScope() {
179
180	0	return (this.scope);
181
182		}
183
184
185		/**
186		* Set the scope of the Java object referenced by this Descriptor.
187		*
188		* @param scope The new scope name
189		*/
190		public void setScope(String scope) {
191
192	0	this.scope = scope;
193
194	0	}
195
196
197		/**
198		* Return the optional Java class expected by this Descriptor.
199		*/
200		public Class getType() {
201
202	0	return (this.type);
203
204		}
205
206
207		/**
208		* Set the optional Java class expected by this Descriptor.
209		*
210		* @param type The new expected type
211		*/
212		public void setType(Class type) {
213
214	0	this.type = type;
215
216	0	}
217
218
219		/**
220		* Return the XPath expression used to access the Java object
221		* referenced by this Descriptor.
222		*/
223		public String getXpath() {
224
225	0	return (this.xpath);
226
227		}
228
229
230		/**
231		* Set the XPath expression used to access the Java object
232		* referenced by this Descriptor.
233		*
234		* @param xpath The new XPath expression
235		*/
236		public void setXpath(String xpath) {
237
238	0	this.xpath = xpath;
239
240	0	}
241
242
243		// --------------------------------------------------------- Public Methods
244
245
246		/**
247		* Return the value specified by this Descriptor from the specified
248		* Context. If there is no such value, return <code>null</code>.
249		*
250		* @param context Context from which to retrieve this value
251		*/
252		public Object get(Context context) {
253
254	0	if (xpath != null) {
255	0	JXPathContext jpc = context.getJXPathContext();
256	0	jpc.setLenient(true);
257	0	return (jpc.getValue("local/" + xpath));
258	0	} else if (name != null) {
259	0	if (scope == null)
260	0	return (context.get(name));
261		else {
262	0	int scopeId = context.getScopeId(scope);
263	0	return (context.get(name, scopeId));
264		}
265		} else {
266		try {
267	0	return (context.pop());
268	0	} catch (EmptyStackException e) {
269	0	return (null);
270		}
271		}
272
273		}
274
275
276		/**
277		* <p>Call <code>get()</code> to retrieve the value specified by this
278		* Descriptor, and then return <code>true</code> if this value represents
279		* a positive result; otherwise return <code>false</code>. A positive
280		* result depends on the data type of the retrieved value:</p>
281		* <ul>
282		* <li>Value returned is a <code>String</code> of length greater than 0.
283		* </li>
284		* <li>Value is a Boolean "true"</code>.</li>
285		* <li>Value is a numeric primitive (byte, char, float, double, int,
286		* long, short), or an Object wrapper for one of these types, and
287		* the corresponding value is non-zero.</li>
288		* <li>Value returned is a non-null Object.</li>
289		* </ul>
290		*
291		* @param context Context from which to retrieve this value
292		*/
293		public boolean positive(Context context) {
294
295	0	Object value = get(context);
296	0	if (value == null)
297	0	return (false);
298	0	else if (value instanceof Boolean)
299	0	return (((Boolean) value).booleanValue());
300	0	else if (value instanceof Byte)
301	0	return (((Byte) value).byteValue() != (byte) 0);
302	0	else if (value instanceof Character)
303	0	return (((Character) value).charValue() != (char) 0);
304	0	else if (value instanceof Double)
305	0	return (((Double) value).doubleValue() != (double) 0.0);
306	0	else if (value instanceof Float)
307	0	return (((Double) value).floatValue() != (float) 0.0);
308	0	else if (value instanceof Integer)
309	0	return (((Integer) value).intValue() != (int) 0);
310	0	else if (value instanceof Long)
311	0	return (((Long) value).longValue() != (long) 0);
312	0	else if (value instanceof Short)
313	0	return (((Short) value).shortValue() != (short) 0);
314	0	else if (value instanceof String)
315	0	return (((String) value).length() > 0);
316		else
317	0	return (true); // Non-null object
318
319
320		}
321
322
323		/**
324		* Store the value into the destination specified by this Descriptor
325		* in the specified Context, replacing any existing value.
326		*
327		* @param context Context into which to store this value
328		* @param value Object value to be stored
329		*/
330		public void put(Context context, Object value) {
331
332	0	if (xpath != null) {
333	0	JXPathContext jpc = context.getJXPathContext();
334	0	jpc.setValue("local/" + xpath, value);
335	0	} else {
336	0	if (scope == null)
337	0	context.put(name, value);
338		else {
339	0	int scopeId = context.getScopeId(scope);
340	0	context.put(name, value, scopeId);
341		}
342		}
343
344	0	}
345
346
347		/**
348		* Remove any existing value associated with this Descriptor from the
349		* specified Context.
350		*
351		* @param context Context from which to remove this value.
352		*/
353		public void remove(Context context) {
354
355	0	if (xpath != null) {
356	0	throw new IllegalStateException("Cannot 'remove' throw xpath");
357		} else {
358	0	if (scope == null)
359	0	context.remove(name);
360		else {
361	0	int scopeId = context.getScopeId(scope);
362	0	context.remove(name, scopeId);
363		}
364		}
365
366	0	}
367
368
369		/**
370		* Render a printable version of this object.
371		*/
372		public String toString() {
373
374	0	StringBuffer sb = new StringBuffer("<descriptor");
375	0	if (xpath != null) {
376	0	sb.append(" xpath=\"");
377	0	sb.append(xpath);
378	0	sb.append("\"");
379		}
380	0	if (name != null) {
381	0	sb.append(" name=\"");
382	0	sb.append(name);
383	0	sb.append("\"");
384		}
385	0	if (scope != null) {
386	0	sb.append(" scope=\"");
387	0	sb.append(scope);
388	0	sb.append("\"");
389		}
390	0	sb.append("/>");
391	0	return (sb.toString());
392
393		}
394
395
396		}