annotate artifact-database/src/main/java/org/dive4elements/artifactdatabase/db/SQL.java @ 473:d0ac790a6c89 dive4elements-move

Moved directories to org.dive4elements
author Sascha L. Teichmann <teichmann@intevation.de>
date Thu, 25 Apr 2013 10:57:18 +0200
parents artifact-database/src/main/java/de/intevation/artifactdatabase/db/SQL.java@c40729bfe06d
children 415df0fc4fa1
rev   line source
305
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
1 package de.intevation.artifactdatabase.db;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
2
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
3 import java.util.Properties;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
4
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
5 import java.io.IOException;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
6 import java.io.InputStream;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
7
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
8 import org.apache.log4j.Logger;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
9
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
10 public class SQL {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
11
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
12 private static Logger logger = Logger.getLogger(SQL.class);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
13
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
14 protected Properties statements;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
15
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
16 public SQL() {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
17 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
18
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
19 public SQL(String driver) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
20 this(SQL.class, driver);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
21 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
22
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
23 public SQL(Class clazz, String driver) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
24 this(clazz, "/sql", driver);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
25 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
26
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
27 public SQL(Class clazz, String resourcePath, String driver) {
307
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
28 statements = loadStatements(clazz, resourcePath, driver);
305
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
29 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
30
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
31 public static final String driverToProperties(String driver) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
32 return driver.replace('.', '-').toLowerCase() + ".properties";
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
33 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
34
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
35 /**
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
36 * Returns key/value pairs of SQL statements for the used database
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
37 * backend.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
38 * The concrete set of SQL statements is determined by the
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
39 * used JDBC database driver which is configured in conf.xml.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
40 * The class name of the driver is transformed by replacing
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
41 * all '.' with '_' and lower case the resulting string.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
42 * The transformed string is used to load a properties file
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
43 * in '/sql/' which should contain the statements.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
44 * Example:<br>
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
45 * <code>org.postgresql.Driver</code> results in loading of
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
46 * <code>/sql/org-postgresql-driver.properties</code>.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
47 * @return The key/value pairs of SQL statements.
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
48 */
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
49 protected Properties loadStatements(
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
50 Class clazz,
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
51 String resourcePath,
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
52 String driver
394
c40729bfe06d Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 307
diff changeset
53 ) {
307
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
54 logger.debug("loadStatements");
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
55
305
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
56 Properties properties = new Properties();
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
57
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
58 String resDriver = driverToProperties(driver);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
59
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
60 InputStream in = null;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
61 try {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
62 String res = resourcePath + "/" + resDriver;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
63
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
64 in = clazz.getResourceAsStream(res);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
65
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
66 if (in == null) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
67 logger.warn("No SQL file for driver '" + driver + "' found.");
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
68 resDriver = driverToProperties(DBConnection.DEFAULT_DRIVER);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
69 res = resourcePath + "/" + resDriver;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
70
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
71 in = clazz.getResourceAsStream(res);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
72 if (in == null) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
73 logger.error("No SQL file for driver '" +
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
74 DBConnection.DEFAULT_DRIVER + "' found.");
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
75 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
76 }
307
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
77 else {
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
78 if (logger.isDebugEnabled()) {
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
79 logger.debug("found resource: " + res);
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
80 }
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
81 }
305
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
82
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
83 if (in != null) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
84 properties.load(in);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
85 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
86 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
87 catch (IOException ioe) {
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
88 logger.error(ioe);
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
89 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
90
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
91 return properties;
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
92 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
93
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
94 public String get(String key) {
307
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
95 boolean debug = logger.isDebugEnabled();
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
96 if (debug) {
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
97 logger.debug("looking for SQL " + key);
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
98 logger.debug("statements != null: " + (statements != null));
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
99 }
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
100
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
101 String sql = statements.getProperty(key);
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
102
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
103 if (sql == null) {
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
104 logger.error("cannot find SQL for key '" + key + "'");
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
105 }
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
106
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
107 if (debug) {
394
c40729bfe06d Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 307
diff changeset
108 logger.debug("-> '" + sql + "'");
307
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
109 }
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
110
d96bcb40dbf9 Make artifact server bootable again.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 305
diff changeset
111 return sql;
305
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
112 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
113 }
f33401ea2a6c Artifact database: Refactorized the usage of dialect independent SQL to be reusable.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
diff changeset
114 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org