java/sql-dk/src/info/globalcode/sql/dk/SQLCommandNamed.java
author František Kučera <franta-hg@frantovo.cz>
Tue, 24 Dec 2013 11:54:58 +0100
branchv_0
changeset 51 6730214fab41
parent 50 074b81e5fa7c
child 54 53020d0bd2e4
permissions -rw-r--r--
log warning: Possibly missing parameters
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
16
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     1
/**
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     2
 * SQL-DK
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     4
 *
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     7
 * the Free Software Foundation, either version 3 of the License, or
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     8
 * (at your option) any later version.
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
     9
 *
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    10
 * This program is distributed in the hope that it will be useful,
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    13
 * GNU General Public License for more details.
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    14
 *
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    15
 * You should have received a copy of the GNU General Public License
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
5b8fcd35d4d6 license: GNU GPLv3+
František Kučera <franta-hg@frantovo.cz>
parents: 1
diff changeset
    17
 */
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
package info.globalcode.sql.dk;
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    20
import static info.globalcode.sql.dk.Functions.notNull;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    21
import static info.globalcode.sql.dk.Functions.findByName;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    22
import java.sql.Connection;
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    23
import java.sql.PreparedStatement;
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    24
import java.sql.SQLException;
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    25
import java.util.ArrayList;
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    26
import java.util.List;
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    27
import java.util.logging.Level;
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    28
import java.util.logging.Logger;
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    29
import java.util.regex.Matcher;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    30
import java.util.regex.Pattern;
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    32
/**
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    33
 *
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    34
 * @author Ing. František Kučera (frantovo.cz)
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    35
 */
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    36
public class SQLCommandNamed extends SQLCommand {
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    37
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    38
	private static final Logger log = Logger.getLogger(SQLCommandNamed.class.getName());
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    39
	private String namePrefix;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    40
	private String nameSuffix;
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    41
	private List<NamedParameter> parameters;
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    42
	private List<NamedParameter> parametersUsed = new ArrayList<>();
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    43
	private StringBuilder updatedQuery;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    44
	private Pattern pattern;
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    45
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    46
	public SQLCommandNamed(String query, List<NamedParameter> parameters, String namePrefix, String nameSuffix) {
37
9e6f8e5d5f98 support SQL commands returning more ResultSets + remove COMMAND_TYPE (type is now derived from result returned from SQL – it is not needed to specify the type on CLI)
František Kučera <franta-hg@frantovo.cz>
parents: 35
diff changeset
    47
		super(query);
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    48
		this.updatedQuery = new StringBuilder(query.length());
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    49
		this.parameters = parameters;
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    50
		this.namePrefix = namePrefix;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    51
		this.nameSuffix = nameSuffix;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    52
	}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    53
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    54
	@Override
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    55
	public PreparedStatement prepareStatement(Connection c) throws SQLException {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    56
		buildPattern();
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    57
		placeParametersAndUpdateQuery();
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    58
		logPossiblyMissingParameters();
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    59
		return c.prepareStatement(updatedQuery.toString());
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    60
	}
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    61
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    62
	@Override
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
    63
	public void parametrize(PreparedStatement ps) throws SQLException {
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    64
		int i = 1;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    65
		for (Parameter p : notNull(parametersUsed)) {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    66
			ps.setObject(i++, p.getValue(), p.getType());
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    67
		}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    68
	}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    69
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    70
	/**
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    71
	 * Builds a regexp pattern that matches all parameter names (with prefix/suffix) and which has
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    72
	 * one group: parameter name (without prefix/suffix)
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    73
	 */
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    74
	private void buildPattern() {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    75
		StringBuilder patternString = new StringBuilder();
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    76
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    77
		patternString.append(Pattern.quote(namePrefix));
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    78
		patternString.append("(");
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    79
		for (int i = 0; i < parameters.size(); i++) {
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    80
			patternString.append(Pattern.quote(parameters.get(i).getName()));
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    81
			if (i < parameters.size() - 1) {
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    82
				patternString.append("|");
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    83
			}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    84
		}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    85
		patternString.append(")");
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
    86
		patternString.append(Pattern.quote(nameSuffix));
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    87
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    88
		pattern = Pattern.compile(patternString.toString());
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    89
	}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    90
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    91
	private void placeParametersAndUpdateQuery() throws SQLException {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    92
		final String originalQuery = getQuery();
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    93
		Matcher m = pattern.matcher(originalQuery);
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    94
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    95
		int lastPosition = 0;
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    96
		while (m.find(lastPosition)) {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    97
			String name = m.group(1);
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    98
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
    99
			updatedQuery.append(originalQuery.substring(lastPosition, m.start()));
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   100
			updatedQuery.append("?");
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   101
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   102
			parametersUsed.add(findByName(parameters, name));
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   103
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   104
			lastPosition = m.end();
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   105
		}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   106
		updatedQuery.append(originalQuery.substring(lastPosition, originalQuery.length()));
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   107
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   108
		for (NamedParameter definedParameter : parameters) {
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   109
			if (findByName(parametersUsed, definedParameter.getName()) == null) {
50
074b81e5fa7c named parameters: better exceptions
František Kučera <franta-hg@frantovo.cz>
parents: 49
diff changeset
   110
				throw new SQLException("Parameter „" + definedParameter.getName() + "“ is defined but not used in the query: „" + originalQuery + "“");
49
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   111
			}
b4c74461d0f9 support named parameters
František Kučera <franta-hg@frantovo.cz>
parents: 37
diff changeset
   112
		}
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   113
	}
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
   114
51
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   115
	private void logPossiblyMissingParameters() {
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   116
		Pattern p = Pattern.compile(Pattern.quote(namePrefix) + ".*?" + Pattern.quote(nameSuffix));
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   117
		Matcher m = p.matcher(updatedQuery);
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   118
		int lastPosition = 0;
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   119
		while (m.find(lastPosition)) {
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   120
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   121
			log.log(Level.WARNING, "Possibly missing parameter: {0}", m.group());
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   122
			lastPosition = m.end();
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   123
		}
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   124
	}
6730214fab41 log warning: Possibly missing parameters
František Kučera <franta-hg@frantovo.cz>
parents: 50
diff changeset
   125
34
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
   126
	@Override
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
   127
	public List<NamedParameter> getParameters() {
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
   128
		return parameters;
9335cf31c0f2 first working version
František Kučera <franta-hg@frantovo.cz>
parents: 16
diff changeset
   129
	}
1
f32dac78d13a WOW some classes LOL; TODO: refactor
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   130
}