undisclosed
2023-10-19 b88616bc6e37ecba2404360426113f72f6c94b30
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/*
 *  BaseLink - Generic object relational mapping
 *  Copyright (C) 2011-2020  Ulrich Hilger, http://uhilger.de
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see http://www.gnu.org/licenses/
 */
 
package de.uhilger.baselink;
 
import java.util.*;
import java.util.logging.*;
import java.sql.*;
 
/**
 * Utility methods for the BaseLink package
 * 
 * @author Copyright (c) Ulrich Hilger, <a href="http://uhilger.de">http://uhilger.de</a>
 * @author Published under the terms and conditions of
 * the <a href="http://www.gnu.org/licenses/" target="_blank">GNU General Public License</a>
 * @version 1, October 31, 2014
 */
public class Util {
  
  private static final Logger logger = Logger.getLogger(Util.class.getName());
  
  public static final boolean DO_INCLUDE_BLOBS = true;
  public static final boolean DONT_INCLUDE_BLOBS = false;
  
  /**
   * Generate a database transfer object (DTO) for a table
   * 
   * @param pm  an object to be used for database access
   * @param schemaName name of database schema that contains the table 
   * @param tableName name of table to create DAO for
   * @return java source code of DTO
   */
  public String generateDTO(PersistenceManager pm, String schemaName, String tableName) {
    String indentation = "  ";
    //String indent = "";
    StringBuilder code = new StringBuilder();
    Connection c = null;
    try {
      c = pm.getConnection();
      code.append("@DBTable(name=\"");
      code.append(schemaName.toLowerCase());
      code.append(".");
      code.append(tableName.toLowerCase());
      code.append("\")");
      code.append(System.lineSeparator());
      code.append("@DBPrimaryKey({\"");
      List<List<String>> keys = getPrimaryKeys(pm, c, schemaName, tableName);
      String colName = null;
      for(int row = 1; row < keys.size(); row++) {
        if(row > 1) {
          code.append(",\"");
        }
        colName = keys.get(row).get(3).toLowerCase();
        code.append(colName);
        code.append("\"");
      }
      code.append("})");
      code.append(System.lineSeparator());
      code.append("public class ");
      code.append(tableName.toLowerCase());
      code.append(" {");
      code.append(System.lineSeparator());
  
      /*
        columns.size(): Anzahl Zeilen
        columns.get(0).size(): Anzahl Felder
        Column Name: columns.get(1).get(3)
        Datentyp: columns.get(1).get(4)
      */    
      List<List<String>> columns = getColumns(pm, c, schemaName, tableName);
      String fieldname = null;
      String typename = null;
      int type = -1;
  
      // class members
      for(int row = 1; row < columns.size(); row++) {
        type = Integer.parseInt(columns.get(row).get(4));
        fieldname = columns.get(row).get(3).toLowerCase();
        typename = getTypeName(type);
        code.append(indentation);
        code.append("private ");
        code.append(typename);
        code.append(" ");
        code.append(fieldname);
        code.append(";");
        code.append(System.lineSeparator());      
      }
      
      // setters and getters
      for(int row = 1; row < columns.size(); row++) {
        type = Integer.parseInt(columns.get(row).get(4));
        fieldname = columns.get(row).get(3).toLowerCase();
        typename = getTypeName(type);
        code.append(System.lineSeparator());
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append("public void set");
        code.append(fieldname);
        code.append("(");
        code.append(typename);
        code.append(" wert) {");
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append(indentation);
        code.append(fieldname);
        code.append(" = wert;");
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append("}");
        code.append(System.lineSeparator());
        code.append(System.lineSeparator());
        code.append(indentation);
        //  @DBColumn(name="dc_content", type=DBColumn.Type.BLOB)
        code.append("@DBColumn(name = \"");
        code.append(fieldname);
        if(type == java.sql.Types.BLOB) {
          code.append("\", type=DBColumn.Type.BLOB)");
        } else {
          code.append("\")");
        }
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append("public ");
        code.append(typename);
        code.append(" get");
        code.append(fieldname);
        code.append("() {");
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append(indentation);
        code.append("return ");
        code.append(fieldname);
        code.append(";");
        code.append(System.lineSeparator());
        code.append(indentation);
        code.append("}");
      }
      
      code.append(System.lineSeparator());
      code.append("}");
      c.close();
      c = null;
    } catch (Exception ex) {
      logger.log(Level.SEVERE, ex.getMessage(), ex);
    } finally {
      pm.closeConnectionFinally(c);
    }
    return code.toString();    
  }
  
  /**
   * Generate a database transfer object (DTO) for a table
   * 
   * This method is kept for compatibility reasons, it maps to 
   * <code>generateDTO</code>.
   * 
   * @param pm  an object to be used for database access
   * @param schemaName name of database schema that contains the table 
   * @param tableName name of table to create DAO for
   * @return java source code of DTO
   */
  public String generateDAO(PersistenceManager pm, String schemaName, String tableName) {
    return generateDTO(pm, schemaName, tableName);
  }
  
  /**
   * Get a description of the columns of a database table
   * 
   * @param pm  an object to be used for database access
   * @param c  the database connection that has been opened for this action
   * @param schemaName name of database schema that contains the table 
   * @param tableName name of table to get column descriptions for
   * @return column description as returned by java.sql.DatabaseMetaData, 
   * transformed to a List of rows, each row being a List of Strings, each 
   * String being a field of the column description for respective table 
   * column
   */
  public List<List<String>> getColumns(PersistenceManager pm, Connection c, String schemaName, String tableName) {
    List<List<String>> list = null;
    ResultSet rs = null;
    try {
      DatabaseMetaData meta = c.getMetaData();
      rs = meta.getColumns(null, schemaName, tableName, null);
      list = pm.toList(rs, DONT_INCLUDE_BLOBS);
      rs.close();
      rs = null;
    } catch (Exception ex) {
      logger.log(Level.SEVERE, ex.getMessage(), ex);
    } finally {
      pm.closeResultSetFinally(rs);
    }
    return list;
  }
  
  /**
   * Get a description of the primary keys of a database table
   * 
   * @param pm  an object to be used for database access
   * @param c  the database connection that has been opened for this action
   * @param schemaName name of database schema that contains the table 
   * @param tableName name of table to get primary key descriptions for
   * @return primary key description as returned by java.sql.DatabaseMetaData, 
   * transformed to a List of rows, each row being a List of Strings, each 
   * String being a field of the primary key description for respective table
   */
  public List<List<String>> getPrimaryKeys(PersistenceManager pm, Connection c, String schemaName, String tableName) {
    List<List<String>> list = null;
    ResultSet rs = null;
    try {
      DatabaseMetaData meta = c.getMetaData();
      rs = meta.getPrimaryKeys(null, schemaName, tableName);
      list = pm.toList(rs, DONT_INCLUDE_BLOBS);
      rs.close();
      rs = null;
    } catch (Exception ex) {
      logger.log(Level.SEVERE, ex.getMessage(), ex);
    } finally {
      pm.closeResultSetFinally(rs);
    }
    return list;
  }
  
  
  /**
   * Convert a java.sql.Type to a Java type name 
   * @param type  SQL type to be converted
   * @return Java type name, e.g. String oder int; 
   * if the type can not be converted without an 
   * individually developed conversion 'tbd' is 
   * returned with the SQL type name included, e.g. 
   * tbd_CLOB, tbd_DISTINCT, etc.
   */
  private String getTypeName(int type) {
    String typename = null;
    switch(type) {
      case java.sql.Types.ARRAY:
        typename = "tbd_ARRAY";
        break;
      case java.sql.Types.BIGINT:
        typename = "long";
        break;
      case java.sql.Types.BINARY:
        typename = "byte[]";
        break;
      case java.sql.Types.BIT:
        typename = "tbd_BIT";
        break;
      case java.sql.Types.BLOB:
        typename = "String";
        break;
      case java.sql.Types.BOOLEAN:
        typename = "boolean";
        break;
      case java.sql.Types.CHAR:
        typename = "String";
        break;
      case java.sql.Types.CLOB:
        typename = "tbd_CLOB";
        break;
      case java.sql.Types.DATALINK:
        typename = "tbd_DATALINK";
        break;
      case java.sql.Types.DATE:
        typename = "java.sql.Date";
        break;
      case java.sql.Types.DECIMAL:
        typename = "float";
        break;
      case java.sql.Types.DISTINCT:
        typename = "tbd_DISTINCT";
        break;
      case java.sql.Types.DOUBLE:
        typename = "double";
        break;
      case java.sql.Types.FLOAT:
        typename = "float";
        break;
      case java.sql.Types.INTEGER:
        typename = "int";
        break;
      case java.sql.Types.JAVA_OBJECT:
        typename = "Object";
        break;
      case java.sql.Types.LONGVARCHAR:
        typename = "String";
        break;
      case java.sql.Types.NCHAR:
        typename = "String";
        break;
      case java.sql.Types.NCLOB:
        typename = "tbd_NCLOB";
        break;
      case java.sql.Types.NULL:
        typename = "tbd_NULL";
        break;
      case java.sql.Types.NUMERIC:
        typename = "float";
        break;
      case java.sql.Types.NVARCHAR:
        typename = "String";
        break;
      case java.sql.Types.OTHER:
        typename = "tbd_OTHER";
        break;
      case java.sql.Types.REAL:
        typename = "float";
        break;
      case java.sql.Types.REF:
        typename ="tbd_REF";
        break;
      case java.sql.Types.ROWID:
        typename = "tbd_ROWID";
        break;
      case java.sql.Types.SMALLINT:
        typename = "integer";
        break;
      case java.sql.Types.SQLXML:
        typename = "tbd_SQLXML";
        break;
      case java.sql.Types.STRUCT:
        typename = "tbd_STRUCT";
        break;
      case java.sql.Types.TIME:
        typename = "tbd_TIME";
        break;
      case java.sql.Types.TIMESTAMP:
        typename = "java.sql.Timestamp";
        break;
      case java.sql.Types.TINYINT:
        typename = "integer";
        break;
      case java.sql.Types.VARBINARY:
        typename = "tbd_VARBINARY";
        break;
      case java.sql.Types.VARCHAR:
        typename = "String";
        break;
      default:
        typename = "tbd_UNDEFINED";
        break;
    }
    return typename;
  }  
}