java/sql-dk/src/info/globalcode/sql/dk/configuration/Configuration.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 15 Aug 2015 16:12:06 +0200
branchv_0
changeset 218 8e38caf43ca8
parent 202 01078e09b85b
child 224 36db9fd27436
permissions -rw-r--r--
SingleRecordFormatter: escape whitespace characters in the same way as in TabularFormatter
franta-hg@20
     1
/**
franta-hg@20
     2
 * SQL-DK
franta-hg@20
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@20
     4
 *
franta-hg@20
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@20
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@20
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@20
     8
 * (at your option) any later version.
franta-hg@20
     9
 *
franta-hg@20
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@20
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@20
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@20
    13
 * GNU General Public License for more details.
franta-hg@20
    14
 *
franta-hg@20
    15
 * You should have received a copy of the GNU General Public License
franta-hg@20
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@20
    17
 */
franta-hg@26
    18
package info.globalcode.sql.dk.configuration;
franta-hg@26
    19
franta-hg@30
    20
import static info.globalcode.sql.dk.Xmlns.CONFIGURATION;
franta-hg@29
    21
import static info.globalcode.sql.dk.Functions.findByName;
franta-hg@188
    22
import info.globalcode.sql.dk.formatting.DsvFormatter;
franta-hg@29
    23
import info.globalcode.sql.dk.formatting.SilentFormatter;
franta-hg@202
    24
import info.globalcode.sql.dk.formatting.SingleRecordFormatter;
franta-hg@60
    25
import info.globalcode.sql.dk.formatting.SingleValueFormatter;
franta-hg@32
    26
import info.globalcode.sql.dk.formatting.TabularFormatter;
franta-hg@88
    27
import info.globalcode.sql.dk.formatting.TabularPrefetchingFormatter;
franta-hg@123
    28
import info.globalcode.sql.dk.formatting.TabularWrappingFormatter;
franta-hg@174
    29
import info.globalcode.sql.dk.formatting.TeXFormatter;
franta-hg@128
    30
import info.globalcode.sql.dk.formatting.XhtmlFormatter;
franta-hg@29
    31
import info.globalcode.sql.dk.formatting.XmlFormatter;
franta-hg@26
    32
import java.util.ArrayList;
franta-hg@29
    33
import java.util.Collection;
franta-hg@29
    34
import java.util.Collections;
franta-hg@26
    35
import java.util.List;
franta-hg@29
    36
import javax.xml.bind.annotation.XmlElement;
franta-hg@26
    37
import javax.xml.bind.annotation.XmlRootElement;
franta-hg@67
    38
import javax.xml.bind.annotation.XmlTransient;
franta-hg@20
    39
franta-hg@20
    40
/**
franta-hg@155
    41
 * Object representation of user configuration loaded from XML.
franta-hg@20
    42
 *
franta-hg@20
    43
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@20
    44
 */
franta-hg@30
    45
@XmlRootElement(name = "configuration", namespace = CONFIGURATION)
franta-hg@20
    46
public class Configuration {
franta-hg@26
    47
franta-hg@26
    48
	private List<DatabaseDefinition> databases = new ArrayList<>();
franta-hg@26
    49
	private List<FormatterDefinition> formatters = new ArrayList<>();
franta-hg@32
    50
	/**
franta-hg@32
    51
	 * is used if no formatter is specified on CLI nor in user configuration
franta-hg@32
    52
	 */
franta-hg@32
    53
	public static final String DEFAULT_FORMATTER = TabularFormatter.NAME;
franta-hg@89
    54
	/**
franta-hg@89
    55
	 * Can be used as default if prefetching is ok – for configuration listings (config is alread in
franta-hg@89
    56
	 * memory, so this does not matter)
franta-hg@89
    57
	 */
franta-hg@89
    58
	public static final String DEFAULT_FORMATTER_PREFETCHING = TabularPrefetchingFormatter.NAME;
franta-hg@29
    59
	private String defaultFormatter;
franta-hg@29
    60
	/**
franta-hg@29
    61
	 * Default list of formatters. Is used if particular name is not found in user configuration.
franta-hg@29
    62
	 */
franta-hg@29
    63
	private static final Collection<FormatterDefinition> buildInFormatters;
franta-hg@26
    64
franta-hg@29
    65
	static {
franta-hg@29
    66
		Collection<FormatterDefinition> l = new ArrayList<>();
franta-hg@29
    67
		l.add(new FormatterDefinition(SilentFormatter.NAME, SilentFormatter.class.getName()));
franta-hg@60
    68
		l.add(new FormatterDefinition(SingleValueFormatter.NAME, SingleValueFormatter.class.getName()));
franta-hg@202
    69
		l.add(new FormatterDefinition(SingleRecordFormatter.NAME, SingleRecordFormatter.class.getName()));
franta-hg@29
    70
		l.add(new FormatterDefinition(XmlFormatter.NAME, XmlFormatter.class.getName()));
franta-hg@128
    71
		l.add(new FormatterDefinition(XhtmlFormatter.NAME, XhtmlFormatter.class.getName()));
franta-hg@32
    72
		l.add(new FormatterDefinition(TabularFormatter.NAME, TabularFormatter.class.getName()));
franta-hg@88
    73
		l.add(new FormatterDefinition(TabularPrefetchingFormatter.NAME, TabularPrefetchingFormatter.class.getName()));
franta-hg@123
    74
		l.add(new FormatterDefinition(TabularWrappingFormatter.NAME, TabularWrappingFormatter.class.getName()));
franta-hg@174
    75
		l.add(new FormatterDefinition(TeXFormatter.NAME, TeXFormatter.class.getName()));
franta-hg@188
    76
		l.add(new FormatterDefinition(DsvFormatter.NAME, DsvFormatter.class.getName()));
franta-hg@29
    77
		buildInFormatters = Collections.unmodifiableCollection(l);
franta-hg@29
    78
	}
franta-hg@29
    79
franta-hg@30
    80
	@XmlElement(name = "database", namespace = CONFIGURATION)
franta-hg@26
    81
	public List<DatabaseDefinition> getDatabases() {
franta-hg@26
    82
		return databases;
franta-hg@26
    83
	}
franta-hg@26
    84
franta-hg@26
    85
	public void setDatabases(List<DatabaseDefinition> databases) {
franta-hg@26
    86
		this.databases = databases;
franta-hg@26
    87
	}
franta-hg@26
    88
franta-hg@75
    89
	/**
franta-hg@202
    90
	 * @param name
franta-hg@202
    91
	 * @return 
franta-hg@75
    92
	 * @throws ConfigurationException if no database with this name is configured
franta-hg@75
    93
	 */
franta-hg@75
    94
	public DatabaseDefinition getDatabase(String name) throws ConfigurationException {
franta-hg@75
    95
		DatabaseDefinition dd = findByName(databases, name);
franta-hg@75
    96
		if (dd == null) {
franta-hg@75
    97
			throw new ConfigurationException("Database is not configured: " + name);
franta-hg@75
    98
		} else {
franta-hg@75
    99
			return dd;
franta-hg@75
   100
		}
franta-hg@29
   101
	}
franta-hg@29
   102
franta-hg@80
   103
	/**
franta-hg@80
   104
	 * @return only configured formatters
franta-hg@80
   105
	 * @see #getBuildInFormatters()
franta-hg@80
   106
	 * @see #getAllFormatters()
franta-hg@80
   107
	 */
franta-hg@30
   108
	@XmlElement(name = "formatter", namespace = CONFIGURATION)
franta-hg@26
   109
	public List<FormatterDefinition> getFormatters() {
franta-hg@26
   110
		return formatters;
franta-hg@26
   111
	}
franta-hg@26
   112
franta-hg@26
   113
	public void setFormatters(List<FormatterDefinition> formatters) {
franta-hg@26
   114
		this.formatters = formatters;
franta-hg@26
   115
	}
franta-hg@29
   116
franta-hg@32
   117
	/**
franta-hg@32
   118
	 * @param name name of desired formatter. Looking for this name in user configuration, then in
franta-hg@32
   119
	 * buil-in formatters. If null, default from configuration or (if not configured) built-in
franta-hg@32
   120
	 * default is used.
franta-hg@75
   121
	 * @return formatter definition
franta-hg@75
   122
	 * @throws ConfigurationException if no formatter with this name was found
franta-hg@32
   123
	 */
franta-hg@75
   124
	public FormatterDefinition getFormatter(String name) throws ConfigurationException {
franta-hg@32
   125
		if (name == null) {
franta-hg@75
   126
			return defaultFormatter == null ? getFormatter(DEFAULT_FORMATTER) : getFormatter(defaultFormatter);
franta-hg@32
   127
		} else {
franta-hg@32
   128
			FormatterDefinition fd = findByName(formatters, name);
franta-hg@75
   129
			fd = fd == null ? findByName(buildInFormatters, name) : fd;
franta-hg@75
   130
			if (fd == null) {
franta-hg@75
   131
				throw new ConfigurationException("Formatter is not configured: " + name);
franta-hg@75
   132
			} else {
franta-hg@75
   133
				return fd;
franta-hg@75
   134
			}
franta-hg@32
   135
		}
franta-hg@29
   136
	}
franta-hg@29
   137
franta-hg@80
   138
	/**
franta-hg@80
   139
	 * @return only built-in formatters
franta-hg@80
   140
	 * @see #getAllFormatters()
franta-hg@80
   141
	 * @see #getFormatters()
franta-hg@80
   142
	 */
franta-hg@67
   143
	@XmlTransient
franta-hg@67
   144
	public Collection<FormatterDefinition> getBuildInFormatters() {
franta-hg@67
   145
		return buildInFormatters;
franta-hg@67
   146
	}
franta-hg@67
   147
franta-hg@29
   148
	/**
franta-hg@80
   149
	 * @return built-in + configured formatters
franta-hg@80
   150
	 * @see #getFormatters()
franta-hg@80
   151
	 */
franta-hg@80
   152
	@XmlTransient
franta-hg@80
   153
	public Collection<FormatterDefinition> getAllFormatters() {
franta-hg@80
   154
		Collection<FormatterDefinition> allFormatters = new ArrayList<>();
franta-hg@80
   155
		allFormatters.addAll(buildInFormatters);
franta-hg@80
   156
		allFormatters.addAll(formatters);
franta-hg@80
   157
		return allFormatters;
franta-hg@80
   158
	}
franta-hg@80
   159
franta-hg@80
   160
	/**
franta-hg@29
   161
	 * @return name of default formatter, is used if name is not specified on CLI
franta-hg@29
   162
	 */
franta-hg@30
   163
	@XmlElement(name = "defaultFormatter", namespace = CONFIGURATION)
franta-hg@29
   164
	public String getDefaultFormatter() {
franta-hg@29
   165
		return defaultFormatter;
franta-hg@29
   166
	}
franta-hg@29
   167
franta-hg@29
   168
	public void setDefaultFormatter(String defaultFormatter) {
franta-hg@29
   169
		this.defaultFormatter = defaultFormatter;
franta-hg@29
   170
	}
franta-hg@20
   171
}