001 //$HeadURL: svn+ssh://rbezema@svn.wald.intevation.org/deegree/base/branches/2.2_testing/src/org/deegree/io/datastore/sql/StatementBuffer.java $
002 /*---------------- FILE HEADER ------------------------------------------
003
004 This file is part of deegree.
005 Copyright (C) 2001-2008 by:
006 EXSE, Department of Geography, University of Bonn
007 http://www.giub.uni-bonn.de/deegree/
008 lat/lon GmbH
009 http://www.lat-lon.de
010
011 This library is free software; you can redistribute it and/or
012 modify it under the terms of the GNU Lesser General Public
013 License as published by the Free Software Foundation; either
014 version 2.1 of the License, or (at your option) any later version.
015
016 This library is distributed in the hope that it will be useful,
017 but WITHOUT ANY WARRANTY; without even the implied warranty of
018 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019 Lesser General Public License for more details.
020
021 You should have received a copy of the GNU Lesser General Public
022 License along with this library; if not, write to the Free Software
023 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
024
025 Contact:
026
027 Andreas Poth
028 lat/lon GmbH
029 Aennchenstraße 19
030 53177 Bonn
031 Germany
032 E-Mail: poth@lat-lon.de
033
034 Prof. Dr. Klaus Greve
035 Department of Geography
036 University of Bonn
037 Meckenheimer Allee 166
038 53115 Bonn
039 Germany
040 E-Mail: greve@giub.uni-bonn.de
041
042 ---------------------------------------------------------------------------*/
043 package org.deegree.io.datastore.sql;
044
045 import java.sql.PreparedStatement;
046 import java.util.ArrayList;
047 import java.util.Iterator;
048 import java.util.List;
049
050 import org.deegree.framework.log.ILogger;
051 import org.deegree.framework.log.LoggerFactory;
052
053 /**
054 * Helper class for the creation and logging of {@link PreparedStatement}s.
055 * <p>
056 * It allows to concatenate the query step by step and holds the arguments of the query as well.
057 *
058 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
059 * @author last edited by: $Author: apoth $
060 *
061 * @version $Revision: 9342 $, $Date: 2007-12-27 13:32:57 +0100 (Do, 27 Dez 2007) $
062 */
063 public class StatementBuffer {
064
065 protected static final ILogger LOG = LoggerFactory.getLogger( StatementBuffer.class );
066
067 // contains the SQL-query string
068 private StringBuffer queryBuffer = new StringBuffer( 500 );
069
070 // contains the arguments of the query
071 private List<StatementArgument> argumentList = new ArrayList<StatementArgument>();
072
073 /**
074 * Appends the given character to the statement.
075 *
076 * @param c
077 */
078 public void append( char c ) {
079 this.queryBuffer.append( c );
080 }
081
082 /**
083 * Appends the given string to the statement.
084 *
085 * @param s
086 */
087 public void append( String s ) {
088 this.queryBuffer.append( s );
089 }
090
091 /**
092 * Appends the given {@link StringBuffer} to the statement.
093 *
094 * @param sb
095 */
096 public void append( StringBuffer sb ) {
097 this.queryBuffer.append( sb );
098 }
099
100 /**
101 * Appends the given argument (as the replacement value for the '?' character in the query) to
102 * the statement.
103 *
104 * @param o
105 * @param typeCode
106 */
107 public void addArgument( Object o, int typeCode ) {
108 StatementArgument argument = new StatementArgument( o, typeCode );
109 this.argumentList.add( argument );
110 }
111
112 /**
113 * Returns the query string (without the arguments' values).
114 *
115 * @return the query string (without the arguments' values)
116 */
117 public String getQueryString() {
118 return this.queryBuffer.toString();
119 }
120
121 /**
122 * Returns an {@link Iterator} over the arguments of the query.
123 *
124 * @return an Iterator over the arguments of the query
125 */
126 public Iterator<StatementArgument> getArgumentsIterator() {
127 return this.argumentList.iterator();
128 }
129
130 @Override
131 public String toString() {
132 return queryBuffer.toString();
133 }
134
135 /**
136 * Encapsulates an argument value and the SQL type code for the target column.
137 *
138 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
139 * @author last edited by: $Author: apoth $
140 *
141 * @version $Revision: 9342 $, $Date: 2007-12-27 13:32:57 +0100 (Do, 27 Dez 2007) $
142 */
143 public class StatementArgument {
144
145 private Object o;
146
147 private int typeCode;
148
149 StatementArgument( Object o, int typeCode ) {
150 this.o = o;
151 this.typeCode = typeCode;
152 }
153
154 /**
155 * Returns the argument value.
156 *
157 * @return the argument value
158 */
159 public Object getArgument() {
160 return this.o;
161 }
162
163 /**
164 * Returns the SQL type code for the column that is targeted by the argument.
165 *
166 * @return the SQL type code for the column that is targeted by the argument
167 */
168 public int getTypeCode() {
169 return this.typeCode;
170 }
171 }
172 }