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