Clover Coverage Report - Commons BeanUtils 1.8.3-kuali-SNAPSHOT
Coverage timestamp: Thu Jun 9 2011 11:19:33 MST
Overview   Package   File
    FRAMES   NO FRAMES     
../../../../img/srcFileCovDistChart9.png 27% of files have more coverage
14   249   9   2
2   42   0.64   7
7     1.29  
1    
 
  ResultSetDynaClass       Line # 84 14 0% 9 3 87% 0.8695652
 
  (3)
 
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.ResultSet;
23    import java.sql.SQLException;
24    import java.util.Iterator;
25   
26   
27    /**
28    * <p>Implementation of <code>DynaClass</code> for DynaBeans that wrap the
29    * <code>java.sql.Row</code> objects of a <code>java.sql.ResultSet</code>.
30    * The normal usage pattern is something like:</p>
31    * <pre>
32    * ResultSet rs = ...;
33    * ResultSetDynaClass rsdc = new ResultSetDynaClass(rs);
34    * Iterator rows = rsdc.iterator();
35    * while (rows.hasNext()) {
36    * DynaBean row = (DynaBean) rows.next();
37    * ... process this row ...
38    * }
39    * rs.close();
40    * </pre>
41    *
42    * <p>Each column in the result set will be represented as a DynaBean
43    * property of the corresponding name (optionally forced to lower case
44    * for portability).</p>
45    *
46    * <p><strong>WARNING</strong> - Any {@link DynaBean} instance returned by
47    * this class, or from the <code>Iterator</code> returned by the
48    * <code>iterator()</code> method, is directly linked to the row that the
49    * underlying result set is currently positioned at. This has the following
50    * implications:</p>
51    * <ul>
52    * <li>Once you retrieve a different {@link DynaBean} instance, you should
53    * no longer use any previous instance.</li>
54    * <li>Changing the position of the underlying result set will change the
55    * data that the {@link DynaBean} references.</li>
56    * <li>Once the underlying result set is closed, the {@link DynaBean}
57    * instance may no longer be used.</li>
58    * </ul>
59    *
60    * <p>Any database data that you wish to utilize outside the context of the
61    * current row of an open result set must be copied. For example, you could
62    * use the following code to create standalone copies of the information in
63    * a result set:</p>
64    * <pre>
65    * ArrayList results = new ArrayList(); // To hold copied list
66    * ResultSetDynaClass rsdc = ...;
67    * DynaProperty[] properties = rsdc.getDynaProperties();
68    * BasicDynaClass bdc =
69    * new BasicDynaClass("foo", BasicDynaBean.class,
70    * rsdc.getDynaProperties());
71    * Iterator rows = rsdc.iterator();
72    * while (rows.hasNext()) {
73    * DynaBean oldRow = (DynaBean) rows.next();
74    * DynaBean newRow = bdc.newInstance();
75    * PropertyUtils.copyProperties(newRow, oldRow);
76    * results.add(newRow);
77    * }
78    * </pre>
79    *
80    * @author Craig R. McClanahan
81    * @version $Revision: 926685 $ $Date: 2010-03-23 13:59:08 -0400 (Tue, 23 Mar 2010) $
82    */
83   
 
84    public class ResultSetDynaClass extends JDBCDynaClass implements DynaClass {
85   
86   
87    // ----------------------------------------------------------- Constructors
88   
89   
90    /**
91    * <p>Construct a new ResultSetDynaClass for the specified
92    * <code>ResultSet</code>. The property names corresponding
93    * to column names in the result set will be lower cased.</p>
94    *
95    * @param resultSet The result set to be wrapped
96    *
97    * @exception NullPointerException if <code>resultSet</code>
98    * is <code>null</code>
99    * @exception SQLException if the metadata for this result set
100    * cannot be introspected
101    */
 
102  7 toggle public ResultSetDynaClass(ResultSet resultSet) throws SQLException {
103   
104  7 this(resultSet, true);
105   
106    }
107   
108   
109    /**
110    * <p>Construct a new ResultSetDynaClass for the specified
111    * <code>ResultSet</code>. The property names corresponding
112    * to the column names in the result set will be lower cased or not,
113    * depending on the specified <code>lowerCase</code> value.</p>
114    *
115    * <p><strong>WARNING</strong> - If you specify <code>false</code>
116    * for <code>lowerCase</code>, the returned property names will
117    * exactly match the column names returned by your JDBC driver.
118    * Because different drivers might return column names in different
119    * cases, the property names seen by your application will vary
120    * depending on which JDBC driver you are using.</p>
121    *
122    * @param resultSet The result set to be wrapped
123    * @param lowerCase Should property names be lower cased?
124    *
125    * @exception NullPointerException if <code>resultSet</code>
126    * is <code>null</code>
127    * @exception SQLException if the metadata for this result set
128    * cannot be introspected
129    */
 
130  8 toggle public ResultSetDynaClass(ResultSet resultSet, boolean lowerCase)
131    throws SQLException {
132   
133  8 this(resultSet, lowerCase, false);
134   
135    }
136   
137   
138    /**
139    * <p>Construct a new ResultSetDynaClass for the specified
140    * <code>ResultSet</code>. The property names corresponding
141    * to the column names in the result set will be lower cased or not,
142    * depending on the specified <code>lowerCase</code> value.</p>
143    *
144    * <p><strong>WARNING</strong> - If you specify <code>false</code>
145    * for <code>lowerCase</code>, the returned property names will
146    * exactly match the column names returned by your JDBC driver.
147    * Because different drivers might return column names in different
148    * cases, the property names seen by your application will vary
149    * depending on which JDBC driver you are using.</p>
150    *
151    * @param resultSet The result set to be wrapped
152    * @param lowerCase Should property names be lower cased?
153    * @param useColumnLabel true if the column label should be used, otherwise false
154    *
155    * @exception NullPointerException if <code>resultSet</code>
156    * is <code>null</code>
157    * @exception SQLException if the metadata for this result set
158    * cannot be introspected
159    * @since 1.8.3
160    */
 
161  8 toggle public ResultSetDynaClass(ResultSet resultSet, boolean lowerCase, boolean useColumnLabel)
162    throws SQLException {
163   
164  8 if (resultSet == null) {
165  0 throw new NullPointerException();
166    }
167  8 this.resultSet = resultSet;
168  8 this.lowerCase = lowerCase;
169  8 setUseColumnLabel(useColumnLabel);
170  8 introspect(resultSet);
171   
172    }
173   
174   
175    // ----------------------------------------------------- Instance Variables
176   
177   
178    /**
179    * <p>The <code>ResultSet</code> we are wrapping.</p>
180    */
181    protected ResultSet resultSet = null;
182   
183   
184    // --------------------------------------------------------- Public Methods
185   
186   
187    /**
188    * <p>Return an <code>Iterator</code> of {@link DynaBean} instances for
189    * each row of the wrapped <code>ResultSet</code>, in "forward" order.
190    * Unless the underlying result set supports scrolling, this method
191    * should be called only once.</p>
192    * @return An <code>Iterator</code> of {@link DynaBean} instances
193    */
 
194  3 toggle public Iterator iterator() {
195   
196  3 return (new ResultSetIterator(this));
197   
198    }
199   
200   
201    /**
202    * Get a value from the {@link ResultSet} for the specified
203    * property name.
204    *
205    * @param name The property name
206    * @return The value
207    * @throws SQLException if an error occurs
208    * @since 1.8.0
209    */
 
210  8 toggle public Object getObjectFromResultSet(String name) throws SQLException {
211  8 return getObject(getResultSet(), name);
212    }
213   
214    // -------------------------------------------------------- Package Methods
215   
216   
217    /**
218    * <p>Return the result set we are wrapping.</p>
219    */
 
220  20 toggle ResultSet getResultSet() {
221   
222  20 return (this.resultSet);
223   
224    }
225   
226   
227    // ------------------------------------------------------ Protected Methods
228   
229    /**
230    * <p>Loads the class of the given name which by default uses the class loader used
231    * to load this library.
232    * Dervations of this class could implement alternative class loading policies such as
233    * using custom ClassLoader or using the Threads's context class loader etc.
234    * </p>
235    * @param className The name of the class to load
236    * @return The loaded class
237    * @throws SQLException if the class cannot be loaded
238    */
 
239  80 toggle protected Class loadClass(String className) throws SQLException {
240   
241  80 try {
242  80 return getClass().getClassLoader().loadClass(className);
243    }
244    catch (Exception e) {
245  0 throw new SQLException("Cannot load column class '" +
246    className + "': " + e);
247    }
248    }
249    }
 
CloverReport generated by Clover Code Coverage v3.0.2
Thu Jun 9 2011 11:23:06 MST.		   Clover: Open Source License registered to University of Arizona.