java/sql-dk/src/info/globalcode/sql/dk/InfoLister.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 26 Dec 2013 21:18:54 +0100
branchv_0
changeset 69 0befec5034c2
parent 67 10c9b9e54622
child 70 02c8eaa425e8
permissions -rw-r--r--
InfoLister, InfoType: switch → enum
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@14
    18
package info.globalcode.sql.dk;
franta-hg@14
    19
franta-hg@67
    20
import info.globalcode.sql.dk.configuration.Configuration;
franta-hg@65
    21
import info.globalcode.sql.dk.configuration.ConfigurationException;
franta-hg@26
    22
import info.globalcode.sql.dk.configuration.ConfigurationProvider;
franta-hg@65
    23
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@67
    24
import info.globalcode.sql.dk.configuration.FormatterDefinition;
franta-hg@67
    25
import static info.globalcode.sql.dk.Functions.rpad;
franta-hg@69
    26
import info.globalcode.sql.dk.formatting.ColumnsHeader;
franta-hg@69
    27
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@69
    28
import info.globalcode.sql.dk.formatting.FormatterContext;
franta-hg@69
    29
import info.globalcode.sql.dk.formatting.FormatterException;
franta-hg@17
    30
import java.io.BufferedReader;
franta-hg@17
    31
import java.io.InputStreamReader;
franta-hg@14
    32
import java.io.PrintStream;
franta-hg@65
    33
import java.sql.SQLException;
franta-hg@66
    34
import java.util.List;
franta-hg@17
    35
import java.util.logging.Level;
franta-hg@17
    36
import java.util.logging.Logger;
franta-hg@69
    37
import javax.sql.rowset.RowSetMetaDataImpl;
franta-hg@14
    38
franta-hg@14
    39
/**
franta-hg@14
    40
 * Displays info like help, version etc.
franta-hg@14
    41
 *
franta-hg@14
    42
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@14
    43
 */
franta-hg@14
    44
public class InfoLister {
franta-hg@14
    45
franta-hg@17
    46
	private static final Logger log = Logger.getLogger(InfoLister.class.getName());
franta-hg@17
    47
	private PrintStream out;
franta-hg@20
    48
	private ConfigurationProvider configurationProvider;
franta-hg@69
    49
	private CLIOptions options;
franta-hg@17
    50
franta-hg@69
    51
	public InfoLister(PrintStream out, ConfigurationProvider configurationProvider, CLIOptions options) {
franta-hg@17
    52
		this.out = out;
franta-hg@20
    53
		this.configurationProvider = configurationProvider;
franta-hg@69
    54
		this.options = options;
franta-hg@17
    55
	}
franta-hg@17
    56
franta-hg@69
    57
	public void listFormatters() throws ConfigurationException {
franta-hg@69
    58
		for (FormatterDefinition fd : configurationProvider.getConfiguration().getBuildInFormatters()) {
franta-hg@69
    59
			log.log(Level.INFO, "Built-in formatter:   {0} implemented by class: {1}", new Object[]{rpad(fd.getName(), 16), fd.getClassName()});
franta-hg@69
    60
		}
franta-hg@69
    61
		List<FormatterDefinition> configuredFormatters = configurationProvider.getConfiguration().getFormatters();
franta-hg@69
    62
		for (FormatterDefinition fd : configuredFormatters) {
franta-hg@69
    63
			log.log(Level.INFO, "Configured formatter: {0} implemented by class: {1}", new Object[]{rpad(fd.getName(), 16), fd.getClassName()});
franta-hg@69
    64
		}
franta-hg@69
    65
		if (configuredFormatters.isEmpty()) {
franta-hg@69
    66
			log.log(Level.INFO, "No other formatters are configured");
franta-hg@69
    67
		}
franta-hg@69
    68
		String configuredDefaultFormatter = configurationProvider.getConfiguration().getDefaultFormatter();
franta-hg@69
    69
		if (configuredDefaultFormatter == null) {
franta-hg@69
    70
			log.log(Level.INFO, "Built-in default formatter: {0}", Configuration.DEFAULT_FORMATTER);
franta-hg@69
    71
		} else {
franta-hg@69
    72
			log.log(Level.INFO, "Configured default formatter: {0}", configuredDefaultFormatter);
franta-hg@69
    73
		}
franta-hg@69
    74
	}
franta-hg@67
    75
franta-hg@69
    76
	public void listTypes() throws FormatterException {
franta-hg@69
    77
	}
franta-hg@67
    78
franta-hg@69
    79
	public void listDatabases() throws ConfigurationException {
franta-hg@69
    80
		final List<DatabaseDefinition> configuredDatabases = configurationProvider.getConfiguration().getDatabases();
franta-hg@69
    81
		if (configuredDatabases.isEmpty()) {
franta-hg@69
    82
			log.log(Level.WARNING, "No databases are configured.");
franta-hg@69
    83
		} else {
franta-hg@69
    84
			for (DatabaseDefinition dd : configuredDatabases) {
franta-hg@69
    85
				log.log(Level.INFO, "Configured database: {0}", dd.getName());
franta-hg@14
    86
			}
franta-hg@14
    87
		}
franta-hg@14
    88
	}
franta-hg@17
    89
franta-hg@69
    90
	public void testConnection() {
franta-hg@69
    91
		boolean connectionTestResult = false;
franta-hg@69
    92
		String dbName = options.getDatabaseNameToTest();
franta-hg@69
    93
		log.log(Level.FINE, "Testing connection to database: {0}", dbName);
franta-hg@69
    94
		try {
franta-hg@69
    95
			DatabaseDefinition dd = configurationProvider.getConfiguration().getDatabase(dbName);
franta-hg@69
    96
			if (dd == null) {
franta-hg@69
    97
				log.log(Level.SEVERE, "No database with this name is configured: {0}", dbName);
franta-hg@69
    98
			} else {
franta-hg@69
    99
				log.log(Level.FINE, "Database definition was loaded from configuration");
franta-hg@69
   100
				DatabaseConnection dc = dd.connect();
franta-hg@69
   101
				connectionTestResult = dc.test();
franta-hg@69
   102
			}
franta-hg@69
   103
		} catch (ConfigurationException | SQLException e) {
franta-hg@69
   104
			log.log(Level.SEVERE, "Error during testing connection", e);
franta-hg@69
   105
		}
franta-hg@69
   106
		log.log(Level.INFO, "Connection test result: {0}", connectionTestResult ? "success" : "failure");
franta-hg@69
   107
	}
franta-hg@69
   108
franta-hg@69
   109
	public void printResource(String fileName) {
franta-hg@18
   110
		try (BufferedReader reader = new BufferedReader(new InputStreamReader(getClass().getClassLoader().getResourceAsStream(fileName)))) {
franta-hg@17
   111
			while (true) {
franta-hg@18
   112
				String line = reader.readLine();
franta-hg@17
   113
				if (line == null) {
franta-hg@17
   114
					break;
franta-hg@17
   115
				} else {
franta-hg@17
   116
					println(line);
franta-hg@17
   117
				}
franta-hg@17
   118
			}
franta-hg@17
   119
		} catch (Exception e) {
franta-hg@18
   120
			log.log(Level.SEVERE, "Unable to print this info. Please see our website for it: " + Constants.WEBSITE, e);
franta-hg@17
   121
		}
franta-hg@17
   122
	}
franta-hg@17
   123
franta-hg@17
   124
	private void println(String line) {
franta-hg@17
   125
		out.println(line);
franta-hg@17
   126
	}
franta-hg@69
   127
franta-hg@69
   128
	private void printTable(Formatter formatter, ColumnsHeader header, List<Object[]> data) throws ConfigurationException, FormatterException {
franta-hg@69
   129
		formatter.writeStartResultSet();
franta-hg@69
   130
		formatter.writeColumnsHeader(header);
franta-hg@69
   131
franta-hg@69
   132
		for (Object[] row : data) {
franta-hg@69
   133
			formatter.writeStartRow();
franta-hg@69
   134
			for (Object cell : row) {
franta-hg@69
   135
				formatter.writeColumnValue(cell);
franta-hg@69
   136
			}
franta-hg@69
   137
			formatter.writeEndRow();
franta-hg@69
   138
		}
franta-hg@69
   139
franta-hg@69
   140
		formatter.writeEndResultSet();
franta-hg@69
   141
	}
franta-hg@69
   142
franta-hg@69
   143
	private Formatter getFormatter() throws ConfigurationException, FormatterException {
franta-hg@69
   144
		FormatterDefinition fd = configurationProvider.getConfiguration().getFormatter(options.getFormatterName());
franta-hg@69
   145
		FormatterContext context = new FormatterContext(out);
franta-hg@69
   146
		return fd.getInstance(context);
franta-hg@69
   147
	}
franta-hg@69
   148
franta-hg@69
   149
	private ColumnsHeader constructHeader(HeaderField... fields) throws FormatterException {
franta-hg@69
   150
		try {
franta-hg@69
   151
			RowSetMetaDataImpl metaData = new RowSetMetaDataImpl();
franta-hg@69
   152
			metaData.setColumnCount(fields.length);
franta-hg@69
   153
franta-hg@69
   154
			for (int i = 0; i < fields.length; i++) {
franta-hg@69
   155
				HeaderField hf = fields[i];
franta-hg@69
   156
				int sqlIndex = i + 1;
franta-hg@69
   157
				metaData.setColumnName(sqlIndex, hf.name);
franta-hg@69
   158
				metaData.setColumnLabel(sqlIndex, hf.name);
franta-hg@69
   159
				metaData.setColumnType(sqlIndex, hf.type.getCode());
franta-hg@69
   160
				metaData.setColumnTypeName(sqlIndex, hf.type.name());
franta-hg@69
   161
			}
franta-hg@69
   162
franta-hg@69
   163
			return new ColumnsHeader(metaData);
franta-hg@69
   164
		} catch (SQLException e) {
franta-hg@69
   165
			throw new FormatterException("Error while constructing table headers", e);
franta-hg@69
   166
		}
franta-hg@69
   167
	}
franta-hg@69
   168
franta-hg@69
   169
	private static class HeaderField {
franta-hg@69
   170
franta-hg@69
   171
		String name;
franta-hg@69
   172
		SQLType type;
franta-hg@69
   173
franta-hg@69
   174
		public HeaderField(String name, SQLType type) {
franta-hg@69
   175
			this.name = name;
franta-hg@69
   176
			this.type = type;
franta-hg@69
   177
		}
franta-hg@69
   178
	}
franta-hg@69
   179
franta-hg@69
   180
	public enum InfoType {
franta-hg@69
   181
franta-hg@69
   182
		HELP {
franta-hg@69
   183
			@Override
franta-hg@69
   184
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   185
				infoLister.printResource(Constants.HELP_FILE);
franta-hg@69
   186
			}
franta-hg@69
   187
		},
franta-hg@69
   188
		VERSION {
franta-hg@69
   189
			@Override
franta-hg@69
   190
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   191
				infoLister.printResource(Constants.VERSION_FILE);
franta-hg@69
   192
			}
franta-hg@69
   193
		},
franta-hg@69
   194
		LICENSE {
franta-hg@69
   195
			@Override
franta-hg@69
   196
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   197
				infoLister.printResource(Constants.LICENSE_FILE);
franta-hg@69
   198
			}
franta-hg@69
   199
		},
franta-hg@69
   200
		FORMATTERS {
franta-hg@69
   201
			@Override
franta-hg@69
   202
			public void showInfo(InfoLister infoLister) throws ConfigurationException {
franta-hg@69
   203
				infoLister.listFormatters();
franta-hg@69
   204
			}
franta-hg@69
   205
		},
franta-hg@69
   206
		TYPES {
franta-hg@69
   207
			@Override
franta-hg@69
   208
			public void showInfo(InfoLister infoLister) throws FormatterException {
franta-hg@69
   209
				infoLister.listTypes();
franta-hg@69
   210
			}
franta-hg@69
   211
		},
franta-hg@69
   212
		DATABASES {
franta-hg@69
   213
			@Override
franta-hg@69
   214
			public void showInfo(InfoLister infoLister) throws ConfigurationException {
franta-hg@69
   215
				infoLister.listDatabases();
franta-hg@69
   216
			}
franta-hg@69
   217
		},
franta-hg@69
   218
		CONNECTION {
franta-hg@69
   219
			@Override
franta-hg@69
   220
			public void showInfo(InfoLister infoLister) {
franta-hg@69
   221
				infoLister.testConnection();
franta-hg@69
   222
			}
franta-hg@69
   223
		};
franta-hg@69
   224
franta-hg@69
   225
		public abstract void showInfo(InfoLister infoLister) throws ConfigurationException, FormatterException;
franta-hg@69
   226
	}
franta-hg@14
   227
}