java/sql-dk/src/main/java/info/globalcode/sql/dk/CLIOptions.java
author František Kučera <franta-hg@frantovo.cz>
Tue, 05 Mar 2019 22:03:02 +0100
branchv_0
changeset 246 277c18b48762
parent 238 4a1864c3e867
child 250 aae5009bd0af
permissions -rw-r--r--
support custom relation names in the XML formatter (added --relation CLI option)
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@1
    20
import static info.globalcode.sql.dk.Functions.isNotEmpty;
franta-hg@14
    21
import static info.globalcode.sql.dk.Functions.equalz;
franta-hg@69
    22
import info.globalcode.sql.dk.InfoLister.InfoType;
franta-hg@104
    23
import info.globalcode.sql.dk.configuration.Properties;
franta-hg@104
    24
import info.globalcode.sql.dk.configuration.Property;
franta-hg@146
    25
import java.io.InputStream;
franta-hg@34
    26
import java.io.OutputStream;
franta-hg@1
    27
import java.util.ArrayList;
franta-hg@1
    28
import java.util.Collection;
franta-hg@14
    29
import java.util.EnumSet;
franta-hg@162
    30
import java.util.LinkedHashSet;
franta-hg@246
    31
import java.util.LinkedList;
franta-hg@1
    32
import java.util.List;
franta-hg@74
    33
import java.util.Set;
franta-hg@63
    34
import java.util.regex.Pattern;
franta-hg@63
    35
import java.util.regex.PatternSyntaxException;
franta-hg@1
    36
franta-hg@1
    37
/**
franta-hg@155
    38
 * Holds options from command line, validates them, combines with configuration and provides derived
franta-hg@155
    39
 * objects.
franta-hg@1
    40
 *
franta-hg@1
    41
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@1
    42
 */
franta-hg@1
    43
public class CLIOptions {
franta-hg@1
    44
franta-hg@3
    45
	public static final String DEFAULT_NAME_PREFIX = ":";
franta-hg@54
    46
	public static final String DEFAULT_NAME_SUFFIX = "(?=([^\\w]|$))";
franta-hg@1
    47
	private String sql;
franta-hg@1
    48
	private String databaseName;
franta-hg@246
    49
	private final List<String> relationNames = new ArrayList<>();
franta-hg@200
    50
	private final Set<String> databaseNamesToTest = new LinkedHashSet<>();
franta-hg@200
    51
	private final Set<String> databaseNamesToListProperties = new LinkedHashSet<>();
franta-hg@209
    52
	private final Set<String> formatterNamesToListProperties = new LinkedHashSet<>();
franta-hg@3
    53
	private String namePrefix = DEFAULT_NAME_PREFIX;
franta-hg@44
    54
	private String nameSuffix = DEFAULT_NAME_SUFFIX;
franta-hg@14
    55
	private String formatterName;
franta-hg@1
    56
	private boolean batch;
franta-hg@200
    57
	private final Properties formatterProperties = new Properties();
franta-hg@200
    58
	private final Properties databaseProperties = new Properties();
franta-hg@2
    59
franta-hg@2
    60
	public enum MODE {
franta-hg@2
    61
franta-hg@2
    62
		QUERY_NOW,
franta-hg@2
    63
		PREPARE_BATCH,
franta-hg@14
    64
		EXECUTE_BATCH,
franta-hg@14
    65
		JUST_SHOW_INFO
franta-hg@14
    66
	}
franta-hg@34
    67
	private final List<NamedParameter> namedParameters = new ArrayList<>();
franta-hg@1
    68
	private final List<Parameter> numberedParameters = new ArrayList<>();
franta-hg@69
    69
	private final EnumSet<InfoType> showInfo = EnumSet.noneOf(InfoType.class);
franta-hg@1
    70
franta-hg@1
    71
	public void validate() throws InvalidOptionsException {
franta-hg@1
    72
		InvalidOptionsException e = new InvalidOptionsException();
franta-hg@1
    73
franta-hg@14
    74
		MODE mode = getMode();
franta-hg@14
    75
		if (mode == null) {
franta-hg@1
    76
			e.addProblem(new InvalidOptionsException.OptionProblem("Invalid combination of DB, SQL and BATCH – please specify just 2 of this 3 options"));
franta-hg@14
    77
		} else if (mode == MODE.JUST_SHOW_INFO) {
franta-hg@14
    78
			if (!namedParameters.isEmpty()) {
franta-hg@14
    79
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not use named parameters if just showing info."));
franta-hg@14
    80
			}
franta-hg@14
    81
			if (!numberedParameters.isEmpty()) {
franta-hg@14
    82
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not use numbered parameters if just showing info."));
franta-hg@14
    83
			}
franta-hg@14
    84
			if (isNotEmpty(sql, false)) {
franta-hg@14
    85
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not specify SQL if just showing info."));
franta-hg@14
    86
			}
franta-hg@14
    87
			if (isNotEmpty(databaseName, false)) {
franta-hg@14
    88
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not specify database if just showing info."));
franta-hg@14
    89
			}
franta-hg@14
    90
			if (batch) {
franta-hg@14
    91
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not specify batch if just showing info."));
franta-hg@14
    92
			}
franta-hg@14
    93
			if (!equalz(namePrefix, DEFAULT_NAME_PREFIX)) {
franta-hg@14
    94
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not specify name prefix if just showing info."));
franta-hg@14
    95
			}
franta-hg@44
    96
			if (!equalz(nameSuffix, DEFAULT_NAME_SUFFIX)) {
franta-hg@44
    97
				e.addProblem(new InvalidOptionsException.OptionProblem("Do not specify name suffix if just showing info."));
franta-hg@44
    98
			}
franta-hg@155
    99
			if (showInfo.contains(InfoType.CONNECTION) && databaseNamesToTest.isEmpty()) {
franta-hg@15
   100
				e.addProblem(new InvalidOptionsException.OptionProblem("Please specify which database should be tested."));
franta-hg@15
   101
			}
franta-hg@159
   102
			if (showInfo.contains(InfoType.JDBC_PROPERTIES) && databaseNamesToListProperties.isEmpty()) {
franta-hg@159
   103
				e.addProblem(new InvalidOptionsException.OptionProblem("Please specify for which database the properties should be listed."));
franta-hg@159
   104
			}
franta-hg@1
   105
		}
franta-hg@1
   106
franta-hg@1
   107
		if (!namedParameters.isEmpty() && !numberedParameters.isEmpty()) {
franta-hg@1
   108
			e.addProblem(new InvalidOptionsException.OptionProblem("Named and numbered parameters can not be used together in one command."));
franta-hg@1
   109
		}
franta-hg@1
   110
franta-hg@63
   111
		try {
franta-hg@63
   112
			Pattern.compile(namePrefix + "test" + nameSuffix);
franta-hg@63
   113
		} catch (PatternSyntaxException regexException) {
franta-hg@63
   114
			e.addProblem(new InvalidOptionsException.OptionProblem("Ivalid regular expression in name prefix or suffix", regexException));
franta-hg@63
   115
		}
franta-hg@1
   116
franta-hg@1
   117
		if (e.hasProblems()) {
franta-hg@1
   118
			throw e;
franta-hg@1
   119
		}
franta-hg@1
   120
	}
franta-hg@1
   121
franta-hg@2
   122
	private boolean hasSql() {
franta-hg@2
   123
		return isNotEmpty(getSql(), true);
franta-hg@1
   124
	}
franta-hg@1
   125
franta-hg@2
   126
	private boolean hasDb() {
franta-hg@2
   127
		return isNotEmpty(getDatabaseName(), true);
franta-hg@1
   128
	}
franta-hg@1
   129
franta-hg@2
   130
	/**
franta-hg@2
   131
	 * Depends on options: DB, BATCH, SQL
franta-hg@2
   132
	 *
franta-hg@2
   133
	 * @return mode | or null if options are not yet initialized or combination of options is
franta-hg@2
   134
	 * invalid
franta-hg@2
   135
	 */
franta-hg@2
   136
	public MODE getMode() {
franta-hg@2
   137
		if (hasDb() && !batch && hasSql()) {
franta-hg@2
   138
			return MODE.QUERY_NOW;
franta-hg@2
   139
		} else if (!hasDb() && batch && hasSql()) {
franta-hg@2
   140
			return MODE.PREPARE_BATCH;
franta-hg@2
   141
		} else if (hasDb() && batch && !hasSql()) {
franta-hg@2
   142
			return MODE.EXECUTE_BATCH;
franta-hg@2
   143
		} else {
franta-hg@14
   144
			return showInfo.isEmpty() ? null : MODE.JUST_SHOW_INFO;
franta-hg@2
   145
		}
franta-hg@2
   146
	}
franta-hg@2
   147
franta-hg@2
   148
	public String getSql() {
franta-hg@2
   149
		return sql;
franta-hg@2
   150
	}
franta-hg@2
   151
franta-hg@2
   152
	public void setSql(String sql) {
franta-hg@2
   153
		this.sql = sql;
franta-hg@2
   154
	}
franta-hg@2
   155
franta-hg@2
   156
	public String getDatabaseName() {
franta-hg@2
   157
		return databaseName;
franta-hg@2
   158
	}
franta-hg@2
   159
franta-hg@2
   160
	public void setDatabaseName(String databaseName) {
franta-hg@2
   161
		this.databaseName = databaseName;
franta-hg@2
   162
	}
franta-hg@2
   163
franta-hg@246
   164
	public List<String> getRelationNames() {
franta-hg@246
   165
		return relationNames;
franta-hg@246
   166
	}
franta-hg@246
   167
franta-hg@246
   168
	public void addRelationName(String name) {
franta-hg@246
   169
		relationNames.add(name);
franta-hg@246
   170
	}
franta-hg@246
   171
franta-hg@2
   172
	public void setBatch(boolean batch) {
franta-hg@2
   173
		this.batch = batch;
franta-hg@2
   174
	}
franta-hg@2
   175
franta-hg@2
   176
	public Collection<NamedParameter> getNamedParameters() {
franta-hg@2
   177
		return namedParameters;
franta-hg@2
   178
	}
franta-hg@2
   179
franta-hg@2
   180
	public List<Parameter> getNumberedParameters() {
franta-hg@2
   181
		return numberedParameters;
franta-hg@2
   182
	}
franta-hg@2
   183
franta-hg@2
   184
	public void addNumberedParameter(Parameter p) {
franta-hg@2
   185
		numberedParameters.add(p);
franta-hg@2
   186
	}
franta-hg@2
   187
franta-hg@2
   188
	public void addNamedParameter(NamedParameter p) {
franta-hg@2
   189
		namedParameters.add(p);
franta-hg@1
   190
	}
franta-hg@3
   191
franta-hg@104
   192
	public Properties getDatabaseProperties() {
franta-hg@104
   193
		return databaseProperties;
franta-hg@104
   194
	}
franta-hg@104
   195
franta-hg@104
   196
	public Properties getFormatterProperties() {
franta-hg@104
   197
		return formatterProperties;
franta-hg@104
   198
	}
franta-hg@104
   199
franta-hg@104
   200
	public void addDatabaseProperty(Property p) {
franta-hg@104
   201
		databaseProperties.add(p);
franta-hg@104
   202
	}
franta-hg@104
   203
franta-hg@104
   204
	public void addFormatterProperty(Property p) {
franta-hg@104
   205
		formatterProperties.add(p);
franta-hg@104
   206
	}
franta-hg@104
   207
franta-hg@54
   208
	/**
franta-hg@54
   209
	 * @return regular expression describing the name prefix
franta-hg@54
   210
	 */
franta-hg@3
   211
	public String getNamePrefix() {
franta-hg@3
   212
		return namePrefix;
franta-hg@3
   213
	}
franta-hg@3
   214
franta-hg@54
   215
	/**
franta-hg@209
   216
	 * @param namePrefix
franta-hg@54
   217
	 * @see #getNamePrefix()
franta-hg@54
   218
	 */
franta-hg@3
   219
	public void setNamePrefix(String namePrefix) {
franta-hg@3
   220
		this.namePrefix = namePrefix;
franta-hg@3
   221
	}
franta-hg@14
   222
franta-hg@54
   223
	/**
franta-hg@54
   224
	 * @return regular expression describing the name prefix
franta-hg@54
   225
	 */
franta-hg@44
   226
	public String getNameSuffix() {
franta-hg@44
   227
		return nameSuffix;
franta-hg@44
   228
	}
franta-hg@44
   229
franta-hg@54
   230
	/**
franta-hg@209
   231
	 * @param nameSuffix
franta-hg@54
   232
	 * @see #getNameSuffix()
franta-hg@54
   233
	 */
franta-hg@44
   234
	public void setNameSuffix(String nameSuffix) {
franta-hg@44
   235
		this.nameSuffix = nameSuffix;
franta-hg@44
   236
	}
franta-hg@44
   237
franta-hg@14
   238
	public String getFormatterName() {
franta-hg@14
   239
		return formatterName;
franta-hg@14
   240
	}
franta-hg@14
   241
franta-hg@14
   242
	public void setFormatterName(String formatterName) {
franta-hg@14
   243
		this.formatterName = formatterName;
franta-hg@14
   244
	}
franta-hg@14
   245
franta-hg@69
   246
	public void addShowInfo(InfoType info) {
franta-hg@14
   247
		showInfo.add(info);
franta-hg@14
   248
	}
franta-hg@14
   249
franta-hg@69
   250
	public EnumSet<InfoType> getShowInfo() {
franta-hg@14
   251
		return showInfo;
franta-hg@14
   252
	}
franta-hg@15
   253
franta-hg@155
   254
	public Set<String> getDatabaseNamesToTest() {
franta-hg@155
   255
		return databaseNamesToTest;
franta-hg@15
   256
	}
franta-hg@15
   257
franta-hg@159
   258
	public void addDatabaseNameToTest(String name) {
franta-hg@159
   259
		databaseNamesToTest.add(name);
franta-hg@15
   260
	}
franta-hg@34
   261
franta-hg@159
   262
	public Set<String> getDatabaseNamesToListProperties() {
franta-hg@159
   263
		return databaseNamesToListProperties;
franta-hg@159
   264
	}
franta-hg@159
   265
franta-hg@159
   266
	public void addDatabaseNameToListProperties(String name) {
franta-hg@159
   267
		databaseNamesToListProperties.add(name);
franta-hg@159
   268
	}
franta-hg@209
   269
franta-hg@209
   270
	public Set<String> getFormatterNamesToListProperties() {
franta-hg@209
   271
		return formatterNamesToListProperties;
franta-hg@209
   272
	}
franta-hg@209
   273
franta-hg@209
   274
	public void addFormatterNameToListProperties(String name) {
franta-hg@209
   275
		formatterNamesToListProperties.add(name);
franta-hg@209
   276
	}
franta-hg@209
   277
franta-hg@34
   278
	public SQLCommand getSQLCommand() {
franta-hg@34
   279
		if (namedParameters.isEmpty()) {
franta-hg@37
   280
			return new SQLCommandNumbered(sql, numberedParameters);
franta-hg@34
   281
		} else {
franta-hg@47
   282
			return new SQLCommandNamed(sql, namedParameters, namePrefix, nameSuffix);
franta-hg@34
   283
		}
franta-hg@34
   284
	}
franta-hg@34
   285
franta-hg@34
   286
	public OutputStream getOutputStream() {
franta-hg@34
   287
		return System.out;
franta-hg@34
   288
	}
franta-hg@146
   289
franta-hg@146
   290
	public InputStream getInputStream() {
franta-hg@146
   291
		return System.in;
franta-hg@146
   292
	}
franta-hg@1
   293
}