Coverage Report

Coverage Report - org.apache.commons.beanutils.ResultSetIterator

Classes in this File

Line Coverage

Branch Coverage

Complexity

ResultSetIterator

50%

22/44

71%

10/14

2.929

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You 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.beanutils;
 
 
 import java.sql.SQLException;
 import java.util.Iterator;
 import java.util.NoSuchElementException;
 
 
 /**
  * <p>Implementation of <code>java.util.Iterator</code> returned by the
  * <code>iterator()</code> method of {@link ResultSetDynaClass}.  Each
  * object returned by this iterator will be a {@link DynaBean} that
  * represents a single row from the result set being wrapped.</p>
  *
  * @author Craig R. McClanahan
  * @version $Revision: 556221 $ $Date: 2007-07-14 00:19:21 -0400 (Sat, 14 Jul 2007) $
  */
 
 public class ResultSetIterator implements DynaBean, Iterator {
 
 
     // ------------------------------------------------------------ Constructor
 
 
     /**
      * <p>Construct an <code>Iterator</code> for the result set being wrapped
      * by the specified {@link ResultSetDynaClass}.</p>
      *
      * @param dynaClass The {@link ResultSetDynaClass} wrapping the
      *  result set we will iterate over
      */
     ResultSetIterator(ResultSetDynaClass dynaClass) {
 
         this.dynaClass = dynaClass;
 
     }
 
 
     // ----------------------------------------------------- Instance Variables
 
 
 
     /**
      * <p>Flag indicating whether the result set is currently positioned at a
      * row for which we have not yet returned an element in the iteration.</p>
      */
     protected boolean current = false;
 
 
     /**
      * <p>The {@link ResultSetDynaClass} we are associated with.</p>
      */
     protected ResultSetDynaClass dynaClass = null;
 
 
     /**
      * <p>Flag indicating whether the result set has indicated that there are
      * no further rows.</p>
      */
     protected boolean eof = false;
 
 
     // ------------------------------------------------------- DynaBean Methods
 
 
     /**
      * Does the specified mapped property contain a value for the specified
      * key value?
      *
      * @param name Name of the property to check
      * @param key Name of the key to check
      * @return <code>true<code> if the mapped property contains a value for
      * the specified key, otherwise <code>false</code>
      *
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      */
     public boolean contains(String name, String key) {
 
         throw new UnsupportedOperationException
             ("FIXME - mapped properties not currently supported");
 
     }
 
 
     /**
      * Return the value of a simple property with the specified name.
      *
      * @param name Name of the property whose value is to be retrieved
      * @return The property's value
      *
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      */
     public Object get(String name) {
 
         if (dynaClass.getDynaProperty(name) == null) {
             throw new IllegalArgumentException(name);
         }
         try {
             return dynaClass.getObjectFromResultSet(name);
         } catch (SQLException e) {
             throw new RuntimeException
                 ("get(" + name + "): SQLException: " + e);
         }
 
     }
 
 
     /**
      * Return the value of an indexed property with the specified name.
      *
      * @param name Name of the property whose value is to be retrieved
      * @param index Index of the value to be retrieved
      * @return The indexed property's value
      *
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      * @exception IllegalArgumentException if the specified property
      *  exists, but is not indexed
      * @exception IndexOutOfBoundsException if the specified index
      *  is outside the range of the underlying property
      * @exception NullPointerException if no array or List has been
      *  initialized for this property
      */
     public Object get(String name, int index) {
 
         throw new UnsupportedOperationException
             ("FIXME - indexed properties not currently supported");
 
     }
 
 
     /**
      * Return the value of a mapped property with the specified name,
      * or <code>null</code> if there is no value for the specified key.
      *
      * @param name Name of the property whose value is to be retrieved
      * @param key Key of the value to be retrieved
      * @return The mapped property's value
      *
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      * @exception IllegalArgumentException if the specified property
      *  exists, but is not mapped
      */
     public Object get(String name, String key) {
 
         throw new UnsupportedOperationException
             ("FIXME - mapped properties not currently supported");
 
     }
 
 
     /**
      * Return the <code>DynaClass</code> instance that describes the set of
      * properties available for this DynaBean.
      *
      * @return The associated DynaClass
      */
     public DynaClass getDynaClass() {
 
         return (this.dynaClass);
 
     }
 
 
     /**
      * Remove any existing value for the specified key on the
      * specified mapped property.
      *
      * @param name Name of the property for which a value is to
      *  be removed
      * @param key Key of the value to be removed
      *
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      */
     public void remove(String name, String key) {
 
         throw new UnsupportedOperationException
             ("FIXME - mapped operations not currently supported");
 
     }
 
 
     /**
      * Set the value of a simple property with the specified name.
      *
      * @param name Name of the property whose value is to be set
      * @param value Value to which this property is to be set
      *
      * @exception ConversionException if the specified value cannot be
      *  converted to the type required for this property
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      * @exception NullPointerException if an attempt is made to set a
      *  primitive property to null
      */
     public void set(String name, Object value) {
 
         if (dynaClass.getDynaProperty(name) == null) {
             throw new IllegalArgumentException(name);
         }
         try {
             dynaClass.getResultSet().updateObject(name, value);
         } catch (SQLException e) {
             throw new RuntimeException
                 ("set(" + name + "): SQLException: " + e);
         }
 
     }
 
 
     /**
      * Set the value of an indexed property with the specified name.
      *
      * @param name Name of the property whose value is to be set
      * @param index Index of the property to be set
      * @param value Value to which this property is to be set
      *
      * @exception ConversionException if the specified value cannot be
      *  converted to the type required for this property
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      * @exception IllegalArgumentException if the specified property
      *  exists, but is not indexed
      * @exception IndexOutOfBoundsException if the specified index
      *  is outside the range of the underlying property
      */
     public void set(String name, int index, Object value) {
 
         throw new UnsupportedOperationException
             ("FIXME - indexed properties not currently supported");
 
     }
 
 
     /**
      * Set the value of a mapped property with the specified name.
      *
      * @param name Name of the property whose value is to be set
      * @param key Key of the property to be set
      * @param value Value to which this property is to be set
      *
      * @exception ConversionException if the specified value cannot be
      *  converted to the type required for this property
      * @exception IllegalArgumentException if there is no property
      *  of the specified name
      * @exception IllegalArgumentException if the specified property
      *  exists, but is not mapped
      */
     public void set(String name, String key, Object value) {
 
         throw new UnsupportedOperationException
             ("FIXME - mapped properties not currently supported");
 
     }
 
 
     // ------------------------------------------------------- Iterator Methods
 
 
     /**
      * <p>Return <code>true</code> if the iteration has more elements.</p>
      *
      * @return <code>true</code> if the result set has another
      * row, otherwise <code>false</code>
      */
     public boolean hasNext() {
 
         try {
             advance();
             return (!eof);
         } catch (SQLException e) {
             throw new RuntimeException("hasNext():  SQLException:  " + e);
         }
 
     }
 
 
     /**
      * <p>Return the next element in the iteration.</p>
      *
      * @return advance to the new row and return this
      */
     public Object next() {
 
         try {
             advance();
             if (eof) {
                 throw new NoSuchElementException();
             }
             current = false;
             return (this);
         } catch (SQLException e) {
             throw new RuntimeException("next():  SQLException:  " + e);
         }
 
     }
 
 
     /**
      * <p>Remove the current element from the iteration.  This method is
      * not supported.</p>
      */
     public void remove() {
 
         throw new UnsupportedOperationException("remove()");
 
     }
 
 
     // ------------------------------------------------------ Protected Methods
 
 
     /**
      * <p>Advance the result set to the next row, if there is not a current
      * row (and if we are not already at eof).</p>
      *
      * @exception SQLException if the result set throws an exception
      */
     protected void advance() throws SQLException {
 
         if (!current && !eof) {
             if (dynaClass.getResultSet().next()) {
                 current = true;
                 eof = false;
             } else {
                 current = false;
                 eof = true;
             }
         }
 
     }
 
 
 }

1		/*
2		* Licensed to the Apache Software Foundation (ASF) under one or more
3		* contributor license agreements. See the NOTICE file distributed with
4		* this work for additional information regarding copyright ownership.
5		* The ASF licenses this file to You under the Apache License, Version 2.0
6		* (the "License"); you may not use this file except in compliance with
7		* the License. You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18
19		package org.apache.commons.beanutils;
20
21
22		import java.sql.SQLException;
23		import java.util.Iterator;
24		import java.util.NoSuchElementException;
25
26
27		/**
28		* <p>Implementation of <code>java.util.Iterator</code> returned by the
29		* <code>iterator()</code> method of {@link ResultSetDynaClass}. Each
30		* object returned by this iterator will be a {@link DynaBean} that
31		* represents a single row from the result set being wrapped.</p>
32		*
33		* @author Craig R. McClanahan
34		* @version $Revision: 556221 $ $Date: 2007-07-14 00:19:21 -0400 (Sat, 14 Jul 2007) $
35		*/
36
37		public class ResultSetIterator implements DynaBean, Iterator {
38
39
40		// ------------------------------------------------------------ Constructor
41
42
43		/**
44		* <p>Construct an <code>Iterator</code> for the result set being wrapped
45		* by the specified {@link ResultSetDynaClass}.</p>
46		*
47		* @param dynaClass The {@link ResultSetDynaClass} wrapping the
48		* result set we will iterate over
49		*/
50	3	ResultSetIterator(ResultSetDynaClass dynaClass) {
51
52	3	this.dynaClass = dynaClass;
53
54	3	}
55
56
57		// ----------------------------------------------------- Instance Variables
58
59
60
61		/**
62		* <p>Flag indicating whether the result set is currently positioned at a
63		* row for which we have not yet returned an element in the iteration.</p>
64		*/
65	3	protected boolean current = false;
66
67
68		/**
69		* <p>The {@link ResultSetDynaClass} we are associated with.</p>
70		*/
71	3	protected ResultSetDynaClass dynaClass = null;
72
73
74		/**
75		* <p>Flag indicating whether the result set has indicated that there are
76		* no further rows.</p>
77		*/
78	3	protected boolean eof = false;
79
80
81		// ------------------------------------------------------- DynaBean Methods
82
83
84		/**
85		* Does the specified mapped property contain a value for the specified
86		* key value?
87		*
88		* @param name Name of the property to check
89		* @param key Name of the key to check
90		* @return <code>true<code> if the mapped property contains a value for
91		* the specified key, otherwise <code>false</code>
92		*
93		* @exception IllegalArgumentException if there is no property
94		* of the specified name
95		*/
96		public boolean contains(String name, String key) {
97
98	0	throw new UnsupportedOperationException
99		("FIXME - mapped properties not currently supported");
100
101		}
102
103
104		/**
105		* Return the value of a simple property with the specified name.
106		*
107		* @param name Name of the property whose value is to be retrieved
108		* @return The property's value
109		*
110		* @exception IllegalArgumentException if there is no property
111		* of the specified name
112		*/
113		public Object get(String name) {
114
115	10	if (dynaClass.getDynaProperty(name) == null) {
116	2	throw new IllegalArgumentException(name);
117		}
118		try {
119	8	return dynaClass.getObjectFromResultSet(name);
120	0	} catch (SQLException e) {
121	0	throw new RuntimeException
122		("get(" + name + "): SQLException: " + e);
123		}
124
125		}
126
127
128		/**
129		* Return the value of an indexed property with the specified name.
130		*
131		* @param name Name of the property whose value is to be retrieved
132		* @param index Index of the value to be retrieved
133		* @return The indexed property's value
134		*
135		* @exception IllegalArgumentException if there is no property
136		* of the specified name
137		* @exception IllegalArgumentException if the specified property
138		* exists, but is not indexed
139		* @exception IndexOutOfBoundsException if the specified index
140		* is outside the range of the underlying property
141		* @exception NullPointerException if no array or List has been
142		* initialized for this property
143		*/
144		public Object get(String name, int index) {
145
146	0	throw new UnsupportedOperationException
147		("FIXME - indexed properties not currently supported");
148
149		}
150
151
152		/**
153		* Return the value of a mapped property with the specified name,
154		* or <code>null</code> if there is no value for the specified key.
155		*
156		* @param name Name of the property whose value is to be retrieved
157		* @param key Key of the value to be retrieved
158		* @return The mapped property's value
159		*
160		* @exception IllegalArgumentException if there is no property
161		* of the specified name
162		* @exception IllegalArgumentException if the specified property
163		* exists, but is not mapped
164		*/
165		public Object get(String name, String key) {
166
167	0	throw new UnsupportedOperationException
168		("FIXME - mapped properties not currently supported");
169
170		}
171
172
173		/**
174		* Return the <code>DynaClass</code> instance that describes the set of
175		* properties available for this DynaBean.
176		*
177		* @return The associated DynaClass
178		*/
179		public DynaClass getDynaClass() {
180
181	0	return (this.dynaClass);
182
183		}
184
185
186		/**
187		* Remove any existing value for the specified key on the
188		* specified mapped property.
189		*
190		* @param name Name of the property for which a value is to
191		* be removed
192		* @param key Key of the value to be removed
193		*
194		* @exception IllegalArgumentException if there is no property
195		* of the specified name
196		*/
197		public void remove(String name, String key) {
198
199	0	throw new UnsupportedOperationException
200		("FIXME - mapped operations not currently supported");
201
202		}
203
204
205		/**
206		* Set the value of a simple property with the specified name.
207		*
208		* @param name Name of the property whose value is to be set
209		* @param value Value to which this property is to be set
210		*
211		* @exception ConversionException if the specified value cannot be
212		* converted to the type required for this property
213		* @exception IllegalArgumentException if there is no property
214		* of the specified name
215		* @exception NullPointerException if an attempt is made to set a
216		* primitive property to null
217		*/
218		public void set(String name, Object value) {
219
220	0	if (dynaClass.getDynaProperty(name) == null) {
221	0	throw new IllegalArgumentException(name);
222		}
223		try {
224	0	dynaClass.getResultSet().updateObject(name, value);
225	0	} catch (SQLException e) {
226	0	throw new RuntimeException
227		("set(" + name + "): SQLException: " + e);
228	0	}
229
230	0	}
231
232
233		/**
234		* Set the value of an indexed property with the specified name.
235		*
236		* @param name Name of the property whose value is to be set
237		* @param index Index of the property to be set
238		* @param value Value to which this property is to be set
239		*
240		* @exception ConversionException if the specified value cannot be
241		* converted to the type required for this property
242		* @exception IllegalArgumentException if there is no property
243		* of the specified name
244		* @exception IllegalArgumentException if the specified property
245		* exists, but is not indexed
246		* @exception IndexOutOfBoundsException if the specified index
247		* is outside the range of the underlying property
248		*/
249		public void set(String name, int index, Object value) {
250
251	0	throw new UnsupportedOperationException
252		("FIXME - indexed properties not currently supported");
253
254		}
255
256
257		/**
258		* Set the value of a mapped property with the specified name.
259		*
260		* @param name Name of the property whose value is to be set
261		* @param key Key of the property to be set
262		* @param value Value to which this property is to be set
263		*
264		* @exception ConversionException if the specified value cannot be
265		* converted to the type required for this property
266		* @exception IllegalArgumentException if there is no property
267		* of the specified name
268		* @exception IllegalArgumentException if the specified property
269		* exists, but is not mapped
270		*/
271		public void set(String name, String key, Object value) {
272
273	0	throw new UnsupportedOperationException
274		("FIXME - mapped properties not currently supported");
275
276		}
277
278
279		// ------------------------------------------------------- Iterator Methods
280
281
282		/**
283		* <p>Return <code>true</code> if the iteration has more elements.</p>
284		*
285		* @return <code>true</code> if the result set has another
286		* row, otherwise <code>false</code>
287		*/
288		public boolean hasNext() {
289
290		try {
291	6	advance();
292	6	return (!eof);
293	0	} catch (SQLException e) {
294	0	throw new RuntimeException("hasNext(): SQLException: " + e);
295		}
296
297		}
298
299
300		/**
301		* <p>Return the next element in the iteration.</p>
302		*
303		* @return advance to the new row and return this
304		*/
305		public Object next() {
306
307		try {
308	11	advance();
309	11	if (eof) {
310	0	throw new NoSuchElementException();
311		}
312	11	current = false;
313	11	return (this);
314	0	} catch (SQLException e) {
315	0	throw new RuntimeException("next(): SQLException: " + e);
316		}
317
318		}
319
320
321		/**
322		* <p>Remove the current element from the iteration. This method is
323		* not supported.</p>
324		*/
325		public void remove() {
326
327	0	throw new UnsupportedOperationException("remove()");
328
329		}
330
331
332		// ------------------------------------------------------ Protected Methods
333
334
335		/**
336		* <p>Advance the result set to the next row, if there is not a current
337		* row (and if we are not already at eof).</p>
338		*
339		* @exception SQLException if the result set throws an exception
340		*/
341		protected void advance() throws SQLException {
342
343	17	if (!current && !eof) {
344	12	if (dynaClass.getResultSet().next()) {
345	11	current = true;
346	11	eof = false;
347		} else {
348	1	current = false;
349	1	eof = true;
350		}
351		}
352
353	17	}
354
355
356		}