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. package org.apache.commons.dbutils.wrappers;
  61. import java.lang.reflect.InvocationHandler;
  62. import java.lang.reflect.Method;
  63. import java.sql.ResultSet;
  64. import org.apache.commons.dbutils.ProxyFactory;
  65. /**
  66. * Wraps a <code>ResultSet</code> to trim strings returned by the
  67. * <code>getString()</code> and <code>getObject()</code> methods.
  68. *
  69. * <p>
  70. * Usage Example:
  71. * This example shows how to decorate ResultSets so processing continues as
  72. * normal but all Strings are trimmed before being returned from the
  73. * <code>ResultSet</code>.
  74. * </p>
  75. *
  76. * <pre>
  77. * ResultSet rs = // somehow get a ResultSet;
  78. *
  79. * // Substitute wrapped ResultSet with additional behavior for real ResultSet
  80. * rs = StringTrimmedResultSet.wrap(rs);
  81. *
  82. * // Pass wrapped ResultSet to processor
  83. * List list = BasicRowProcessor.instance().toBeanList(rs);
  84. * </pre>
  85. *
  86. * @author <a href="stevencaswell@apache.org">Steven Caswell</a>
  87. * @author David Graham
  88. * @version $Id: StringTrimmedResultSet.java,v 1.1 2003/11/02 19:15:23 dgraham Exp $
  89. */
  90. public class StringTrimmedResultSet implements InvocationHandler {
  91. /**
  92. * The factory to create proxies with.
  93. */
  94. private static final ProxyFactory factory = ProxyFactory.instance();
  95. /**
  96. * Wraps the <code>ResultSet</code> in an instance of this class. This is
  97. * equivalent to:
  98. * <pre>
  99. * ProxyFactory.instance().createResultSet(new StringTrimmedResultSet(rs));
  100. * </pre>
  101. *
  102. * @param rs The <code>ResultSet</code> to wrap.
  103. */
  104. public static ResultSet wrap(ResultSet rs) {
  105. return factory.createResultSet(new StringTrimmedResultSet(rs));
  106. }
  107. /**
  108. * The wrapped result.
  109. */
  110. private final ResultSet rs;
  111. /**
  112. * Constructs a new instance of <code>StringTrimmedResultSet</code>
  113. * to wrap the specified <code>ResultSet</code>.
  114. */
  115. public StringTrimmedResultSet(ResultSet rs) {
  116. super();
  117. this.rs = rs;
  118. }
  119. /**
  120. * Intercept calls to the <code>getString()</code> and
  121. * <code>getObject()</code> methods and trim any Strings before they're
  122. * returned.
  123. *
  124. * @throws Throwable
  125. * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
  126. */
  127. public Object invoke(Object proxy, Method method, Object[] args)
  128. throws Throwable {
  129. Object result = method.invoke(this.rs, args);
  130. if (method.getName().equals("getObject")
  131. || method.getName().equals("getString")) {
  132. if (result instanceof String) {
  133. result = ((String) result).trim();
  134. }
  135. }
  136. return result;
  137. }
  138. }