KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > commons > dbutils > wrappers > StringTrimmedResultSet


1 /*
2  * $Header: /home/cvs/jakarta-commons/dbutils/src/java/org/apache/commons/dbutils/wrappers/StringTrimmedResultSet.java,v 1.1 2003/11/02 19:15:23 dgraham Exp $
3  * $Revision: 1.1 $
4  * $Date: 2003/11/02 19:15:23 $
5  *
6  * ====================================================================
7  *
8  * The Apache Software License, Version 1.1
9  *
10  * Copyright (c) 2003 The Apache Software Foundation. All rights
11  * reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  *
17  * 1. Redistributions of source code must retain the above copyright
18  * notice, this list of conditions and the following disclaimer.
19  *
20  * 2. Redistributions in binary form must reproduce the above copyright
21  * notice, this list of conditions and the following disclaimer in
22  * the documentation and/or other materials provided with the
23  * distribution.
24  *
25  * 3. The end-user documentation included with the redistribution, if
26  * any, must include the following acknowledgement:
27  * "This product includes software developed by the
28  * Apache Software Foundation (http://www.apache.org/)."
29  * Alternately, this acknowledgement may appear in the software itself,
30  * if and wherever such third-party acknowledgements normally appear.
31  *
32  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33  * Foundation" must not be used to endorse or promote products derived
34  * from this software without prior written permission. For written
35  * permission, please contact apache@apache.org.
36  *
37  * 5. Products derived from this software may not be called "Apache"
38  * nor may "Apache" appear in their names without prior written
39  * permission of the Apache Software Foundation.
40  *
41  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52  * SUCH DAMAGE.
53  * ====================================================================
54  *
55  * This software consists of voluntary contributions made by many
56  * individuals on behalf of the Apache Software Foundation. For more
57  * information on the Apache Software Foundation, please see
58  * <http://www.apache.org/>.
59  */
60
61 package org.apache.commons.dbutils.wrappers;
62
63 import java.lang.reflect.InvocationHandler JavaDoc;
64 import java.lang.reflect.Method JavaDoc;
65 import java.sql.ResultSet JavaDoc;
66
67 import org.apache.commons.dbutils.ProxyFactory;
68
69 /**
70  * Wraps a <code>ResultSet</code> to trim strings returned by the
71  * <code>getString()</code> and <code>getObject()</code> methods.
72  *
73  * <p>
74  * Usage Example:
75  * This example shows how to decorate ResultSets so processing continues as
76  * normal but all Strings are trimmed before being returned from the
77  * <code>ResultSet</code>.
78  * </p>
79  *
80  * <pre>
81  * ResultSet rs = // somehow get a ResultSet;
82  *
83  * // Substitute wrapped ResultSet with additional behavior for real ResultSet
84  * rs = StringTrimmedResultSet.wrap(rs);
85  *
86  * // Pass wrapped ResultSet to processor
87  * List list = BasicRowProcessor.instance().toBeanList(rs);
88  * </pre>
89  *
90  * @author <a HREF="stevencaswell@apache.org">Steven Caswell</a>
91  * @author David Graham
92  * @version $Id: StringTrimmedResultSet.java,v 1.1 2003/11/02 19:15:23 dgraham Exp $
93  */
94 public class StringTrimmedResultSet implements InvocationHandler JavaDoc {
95
96     /**
97      * The factory to create proxies with.
98      */
99     private static final ProxyFactory factory = ProxyFactory.instance();
100
101     /**
102      * Wraps the <code>ResultSet</code> in an instance of this class. This is
103      * equivalent to:
104      * <pre>
105      * ProxyFactory.instance().createResultSet(new StringTrimmedResultSet(rs));
106      * </pre>
107      *
108      * @param rs The <code>ResultSet</code> to wrap.
109      */
110     public static ResultSet JavaDoc wrap(ResultSet JavaDoc rs) {
111         return factory.createResultSet(new StringTrimmedResultSet(rs));
112     }
113
114     /**
115      * The wrapped result.
116      */
117     private final ResultSet JavaDoc rs;
118
119     /**
120      * Constructs a new instance of <code>StringTrimmedResultSet</code>
121      * to wrap the specified <code>ResultSet</code>.
122      */
123     public StringTrimmedResultSet(ResultSet JavaDoc rs) {
124         super();
125         this.rs = rs;
126     }
127
128     /**
129      * Intercept calls to the <code>getString()</code> and
130      * <code>getObject()</code> methods and trim any Strings before they're
131      * returned.
132      *
133      * @throws Throwable
134      * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
135      */
136     public Object JavaDoc invoke(Object JavaDoc proxy, Method JavaDoc method, Object JavaDoc[] args)
137         throws Throwable JavaDoc {
138
139         Object JavaDoc result = method.invoke(this.rs, args);
140
141         if (method.getName().equals("getObject")
142             || method.getName().equals("getString")) {
143
144             if (result instanceof String JavaDoc) {
145                 result = ((String JavaDoc) result).trim();
146             }
147         }
148
149         return result;
150     }
151
152 }
153
Popular Tags