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