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