001: /*
002: * ====================================================================
003: * JAFFA - Java Application Framework For All
004: *
005: * Copyright (C) 2002 JAFFA Development Group
006: *
007: * This library is free software; you can redistribute it and/or
008: * modify it under the terms of the GNU Lesser General Public
009: * License as published by the Free Software Foundation; either
010: * version 2.1 of the License, or (at your option) any later version.
011: *
012: * This library is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this library; if not, write to the Free Software
019: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020: *
021: * Redistribution and use of this software and associated documentation ("Software"),
022: * with or without modification, are permitted provided that the following conditions are met:
023: * 1. Redistributions of source code must retain copyright statements and notices.
024: * Redistributions must also contain a copy of this document.
025: * 2. Redistributions in binary form must reproduce the above copyright notice,
026: * this list of conditions and the following disclaimer in the documentation
027: * and/or other materials provided with the distribution.
028: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
029: * this Software without prior written permission. For written permission,
030: * please contact mail to: jaffagroup@yahoo.com.
031: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
032: * appear in their names without prior written permission.
033: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
034: *
035: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
036: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046: * SUCH DAMAGE.
047: * ====================================================================
048: */
049:
050: package org.jaffa.persistence.engines.jdbcengine.querygenerator;
051:
052: import java.io.IOException;
053: import java.sql.ResultSet;
054: import java.sql.PreparedStatement;
055: import java.sql.CallableStatement;
056: import java.sql.SQLException;
057: import org.jaffa.persistence.Criteria;
058:
059: /** This class has helper routines for passing values in DML strings and PreparedStatements.
060: * There are routines to extract appropriate objects from ResultSets and CallableStatements.
061: */
062: public class DataTranslator {
063:
064: // no need to create an instance
065: private DataTranslator() {
066: }
067:
068: /** Returns the string to be used in SQL statements, appropriate for the datatype.
069: * @param object an object for which the SQL statement is to be generated.
070: * @param typeName The sqlType defined in the mapping file.
071: * @param engineType The engine type as defined in init.xml
072: * @return the string to be used in SQL statements, appropriate for the datatype.
073: * @throws IOException if any error occurs while extracting the String from the input object.
074: */
075: public static String getDml(Object object, String typeName,
076: String engineType) throws IOException {
077: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
078: .getDml(object, engineType);
079: }
080:
081: /** Returns the string to be used in SQL statements, appropriate for the datatype.
082: * @param object an object for which the SQL statement is to be generated.
083: * @param typeName The sqlType defined in the mapping file.
084: * @param engineType The engine type as defined in init.xml
085: * @return the string to be used in SQL statements, appropriate for the datatype.
086: * @throws IOException if any error occurs while extracting the String from the input object.
087: */
088: public static String getLikeDml(Object object, String typeName,
089: String engineType) throws IOException {
090: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
091: .getLikeDml(object, Criteria.RELATIONAL_LIKE,
092: engineType);
093: }
094:
095: /** Returns the string to be used in SQL statements, appropriate for the datatype.
096: * @param object an object for which the SQL statement is to be generated.
097: * @param typeName The sqlType defined in the mapping file.
098: * @param engineType The engine type as defined in init.xml
099: * @return the string to be used in SQL statements, appropriate for the datatype.
100: * @throws IOException if any error occurs while extracting the String from the input object.
101: */
102: public static String getBeginsWithDml(Object object,
103: String typeName, String engineType) throws IOException {
104: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
105: .getLikeDml(object, Criteria.RELATIONAL_BEGINS_WITH,
106: engineType);
107: }
108:
109: /** Returns the string to be used in SQL statements, appropriate for the datatype.
110: * @param object an object for which the SQL statement is to be generated.
111: * @param typeName The sqlType defined in the mapping file.
112: * @param engineType The engine type as defined in init.xml
113: * @return the string to be used in SQL statements, appropriate for the datatype.
114: * @throws IOException if any error occurs while extracting the String from the input object.
115: */
116: public static String getEndsWithDml(Object object, String typeName,
117: String engineType) throws IOException {
118: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
119: .getLikeDml(object, Criteria.RELATIONAL_ENDS_WITH,
120: engineType);
121: }
122:
123: /** Sets a parameter in the PreparedStatement.
124: * @param pstmt The PreparedStatement.
125: * @param parameterIndex The index of the parameter that is to be set.
126: * @param value The object to be assigned to the parameter.
127: * @param typeName The sqlType defined in the mapping file.
128: * @param engineType The engine type as defined in init.xml
129: * @throws SQLException if a database access error occurs.
130: */
131: public static void setAppObject(PreparedStatement pstmt,
132: int parameterIndex, Object value, String typeName,
133: String engineType) throws SQLException {
134: TypeDefs.getTypeDefinitionBySqlTypeName(typeName).setAppObject(
135: pstmt, parameterIndex, value, engineType);
136: }
137:
138: /** Gets a parameter from the ResultSet.
139: * @param rs The ResultSet.
140: * @param columnName The name of the parameter.
141: * @param engineType The engine type as defined in init.xml
142: * @return the parameter.
143: * @param typeName The sqlType defined in the mapping file.
144: * @throws SQLException if a database access error occurs.
145: * @throws IOException if any error occurs in reading the data from the database.
146: */
147: public static Object getAppObject(ResultSet rs, String columnName,
148: String typeName, String engineType) throws SQLException,
149: IOException {
150: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
151: .getAppObject(rs, columnName, engineType);
152: }
153:
154: /** Gets a parameter from the CallableStatement.
155: * @param cstmt The CallableStatement.
156: * @param parameterIndex The index of the parameter.
157: * @param engineType The engine type as defined in init.xml
158: * @return the parameter.
159: * @param typeName The sqlType defined in the mapping file.
160: * @throws SQLException if a database access error occurs.
161: * @throws IOException if any error occurs in reading the data from the database.
162: */
163: public static Object getAppObject(CallableStatement cstmt,
164: int parameterIndex, String typeName, String engineType)
165: throws SQLException, IOException {
166: return TypeDefs.getTypeDefinitionBySqlTypeName(typeName)
167: .getAppObject(cstmt, parameterIndex, engineType);
168: }
169:
170: }
|