java/sql-dk/src/info/globalcode/sql/dk/configuration/Configuration.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 28 Dec 2013 16:45:04 +0100
branchv_0
changeset 89 98d18e9a357b
parent 88 102ba0fcb07f
child 123 248a98c13ca4
permissions -rw-r--r--
InfoLister (configuration listings) will use TabularPrefetchingFormatter as default
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@29
    22
import info.globalcode.sql.dk.formatting.SilentFormatter;
franta-hg@60
    23
import info.globalcode.sql.dk.formatting.SingleValueFormatter;
franta-hg@32
    24
import info.globalcode.sql.dk.formatting.TabularFormatter;
franta-hg@88
    25
import info.globalcode.sql.dk.formatting.TabularPrefetchingFormatter;
franta-hg@29
    26
import info.globalcode.sql.dk.formatting.XmlFormatter;
franta-hg@26
    27
import java.util.ArrayList;
franta-hg@29
    28
import java.util.Collection;
franta-hg@29
    29
import java.util.Collections;
franta-hg@26
    30
import java.util.List;
franta-hg@29
    31
import javax.xml.bind.annotation.XmlElement;
franta-hg@26
    32
import javax.xml.bind.annotation.XmlRootElement;
franta-hg@67
    33
import javax.xml.bind.annotation.XmlTransient;
franta-hg@20
    34
franta-hg@20
    35
/**
franta-hg@20
    36
 *
franta-hg@20
    37
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@20
    38
 */
franta-hg@30
    39
@XmlRootElement(name = "configuration", namespace = CONFIGURATION)
franta-hg@20
    40
public class Configuration {
franta-hg@26
    41
franta-hg@26
    42
	private List<DatabaseDefinition> databases = new ArrayList<>();
franta-hg@26
    43
	private List<FormatterDefinition> formatters = new ArrayList<>();
franta-hg@32
    44
	/**
franta-hg@32
    45
	 * is used if no formatter is specified on CLI nor in user configuration
franta-hg@32
    46
	 */
franta-hg@32
    47
	public static final String DEFAULT_FORMATTER = TabularFormatter.NAME;
franta-hg@89
    48
	/**
franta-hg@89
    49
	 * Can be used as default if prefetching is ok – for configuration listings (config is alread in
franta-hg@89
    50
	 * memory, so this does not matter)
franta-hg@89
    51
	 */
franta-hg@89
    52
	public static final String DEFAULT_FORMATTER_PREFETCHING = TabularPrefetchingFormatter.NAME;
franta-hg@29
    53
	private String defaultFormatter;
franta-hg@29
    54
	/**
franta-hg@29
    55
	 * Default list of formatters. Is used if particular name is not found in user configuration.
franta-hg@29
    56
	 */
franta-hg@29
    57
	private static final Collection<FormatterDefinition> buildInFormatters;
franta-hg@26
    58
franta-hg@29
    59
	static {
franta-hg@29
    60
		Collection<FormatterDefinition> l = new ArrayList<>();
franta-hg@29
    61
		l.add(new FormatterDefinition(SilentFormatter.NAME, SilentFormatter.class.getName()));
franta-hg@60
    62
		l.add(new FormatterDefinition(SingleValueFormatter.NAME, SingleValueFormatter.class.getName()));
franta-hg@29
    63
		l.add(new FormatterDefinition(XmlFormatter.NAME, XmlFormatter.class.getName()));
franta-hg@32
    64
		l.add(new FormatterDefinition(TabularFormatter.NAME, TabularFormatter.class.getName()));
franta-hg@88
    65
		l.add(new FormatterDefinition(TabularPrefetchingFormatter.NAME, TabularPrefetchingFormatter.class.getName()));
franta-hg@29
    66
		buildInFormatters = Collections.unmodifiableCollection(l);
franta-hg@29
    67
	}
franta-hg@29
    68
franta-hg@30
    69
	@XmlElement(name = "database", namespace = CONFIGURATION)
franta-hg@26
    70
	public List<DatabaseDefinition> getDatabases() {
franta-hg@26
    71
		return databases;
franta-hg@26
    72
	}
franta-hg@26
    73
franta-hg@26
    74
	public void setDatabases(List<DatabaseDefinition> databases) {
franta-hg@26
    75
		this.databases = databases;
franta-hg@26
    76
	}
franta-hg@26
    77
franta-hg@75
    78
	/**
franta-hg@75
    79
	 * @throws ConfigurationException if no database with this name is configured
franta-hg@75
    80
	 */
franta-hg@75
    81
	public DatabaseDefinition getDatabase(String name) throws ConfigurationException {
franta-hg@75
    82
		DatabaseDefinition dd = findByName(databases, name);
franta-hg@75
    83
		if (dd == null) {
franta-hg@75
    84
			throw new ConfigurationException("Database is not configured: " + name);
franta-hg@75
    85
		} else {
franta-hg@75
    86
			return dd;
franta-hg@75
    87
		}
franta-hg@29
    88
	}
franta-hg@29
    89
franta-hg@80
    90
	/**
franta-hg@80
    91
	 * @return only configured formatters
franta-hg@80
    92
	 * @see #getBuildInFormatters()
franta-hg@80
    93
	 * @see #getAllFormatters()
franta-hg@80
    94
	 */
franta-hg@30
    95
	@XmlElement(name = "formatter", namespace = CONFIGURATION)
franta-hg@26
    96
	public List<FormatterDefinition> getFormatters() {
franta-hg@26
    97
		return formatters;
franta-hg@26
    98
	}
franta-hg@26
    99
franta-hg@26
   100
	public void setFormatters(List<FormatterDefinition> formatters) {
franta-hg@26
   101
		this.formatters = formatters;
franta-hg@26
   102
	}
franta-hg@29
   103
franta-hg@32
   104
	/**
franta-hg@32
   105
	 * @param name name of desired formatter. Looking for this name in user configuration, then in
franta-hg@32
   106
	 * buil-in formatters. If null, default from configuration or (if not configured) built-in
franta-hg@32
   107
	 * default is used.
franta-hg@75
   108
	 * @return formatter definition
franta-hg@75
   109
	 * @throws ConfigurationException if no formatter with this name was found
franta-hg@32
   110
	 */
franta-hg@75
   111
	public FormatterDefinition getFormatter(String name) throws ConfigurationException {
franta-hg@32
   112
		if (name == null) {
franta-hg@75
   113
			return defaultFormatter == null ? getFormatter(DEFAULT_FORMATTER) : getFormatter(defaultFormatter);
franta-hg@32
   114
		} else {
franta-hg@32
   115
			FormatterDefinition fd = findByName(formatters, name);
franta-hg@75
   116
			fd = fd == null ? findByName(buildInFormatters, name) : fd;
franta-hg@75
   117
			if (fd == null) {
franta-hg@75
   118
				throw new ConfigurationException("Formatter is not configured: " + name);
franta-hg@75
   119
			} else {
franta-hg@75
   120
				return fd;
franta-hg@75
   121
			}
franta-hg@32
   122
		}
franta-hg@29
   123
	}
franta-hg@29
   124
franta-hg@80
   125
	/**
franta-hg@80
   126
	 * @return only built-in formatters
franta-hg@80
   127
	 * @see #getAllFormatters()
franta-hg@80
   128
	 * @see #getFormatters()
franta-hg@80
   129
	 */
franta-hg@67
   130
	@XmlTransient
franta-hg@67
   131
	public Collection<FormatterDefinition> getBuildInFormatters() {
franta-hg@67
   132
		return buildInFormatters;
franta-hg@67
   133
	}
franta-hg@67
   134
franta-hg@29
   135
	/**
franta-hg@80
   136
	 * @return built-in + configured formatters
franta-hg@80
   137
	 * @see #getFormatters()
franta-hg@80
   138
	 */
franta-hg@80
   139
	@XmlTransient
franta-hg@80
   140
	public Collection<FormatterDefinition> getAllFormatters() {
franta-hg@80
   141
		Collection<FormatterDefinition> allFormatters = new ArrayList<>();
franta-hg@80
   142
		allFormatters.addAll(buildInFormatters);
franta-hg@80
   143
		allFormatters.addAll(formatters);
franta-hg@80
   144
		return allFormatters;
franta-hg@80
   145
	}
franta-hg@80
   146
franta-hg@80
   147
	/**
franta-hg@29
   148
	 * @return name of default formatter, is used if name is not specified on CLI
franta-hg@29
   149
	 */
franta-hg@30
   150
	@XmlElement(name = "defaultFormatter", namespace = CONFIGURATION)
franta-hg@29
   151
	public String getDefaultFormatter() {
franta-hg@29
   152
		return defaultFormatter;
franta-hg@29
   153
	}
franta-hg@29
   154
franta-hg@29
   155
	public void setDefaultFormatter(String defaultFormatter) {
franta-hg@29
   156
		this.defaultFormatter = defaultFormatter;
franta-hg@29
   157
	}
franta-hg@20
   158
}