java/sql-dk/src/info/globalcode/sql/dk/configuration/FormatterDefinition.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 15 Jan 2014 21:26:15 +0100
branchv_0
changeset 160 84ea4a819fb2
parent 155 eb3676c6929b
child 188 54bacc7ed42b
permissions -rw-r--r--
InfoLister: option --list-formatters also tests, if formatter class can be instantiated (thus is valid)
franta-hg@26
     1
/**
franta-hg@26
     2
 * SQL-DK
franta-hg@26
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@26
     4
 *
franta-hg@26
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@26
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@26
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@26
     8
 * (at your option) any later version.
franta-hg@26
     9
 *
franta-hg@26
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@26
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@26
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@26
    13
 * GNU General Public License for more details.
franta-hg@26
    14
 *
franta-hg@26
    15
 * You should have received a copy of the GNU General Public License
franta-hg@26
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@26
    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@26
    21
import info.globalcode.sql.dk.DKException;
franta-hg@26
    22
import info.globalcode.sql.dk.formatting.Formatter;
franta-hg@26
    23
import info.globalcode.sql.dk.formatting.FormatterContext;
franta-hg@34
    24
import info.globalcode.sql.dk.formatting.FormatterException;
franta-hg@26
    25
import java.lang.reflect.Constructor;
franta-hg@26
    26
import java.lang.reflect.InvocationTargetException;
franta-hg@26
    27
import javax.xml.bind.annotation.XmlElement;
franta-hg@26
    28
franta-hg@26
    29
/**
franta-hg@155
    30
 * Configured (but not yet instantiated) formatter.
franta-hg@26
    31
 *
franta-hg@26
    32
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@26
    33
 */
franta-hg@26
    34
public class FormatterDefinition implements NameIdentified {
franta-hg@26
    35
franta-hg@26
    36
	private String name;
franta-hg@26
    37
	private String className;
franta-hg@104
    38
	private Properties properties = new Properties();
franta-hg@26
    39
franta-hg@29
    40
	public FormatterDefinition() {
franta-hg@29
    41
	}
franta-hg@29
    42
franta-hg@29
    43
	public FormatterDefinition(String name, String className) {
franta-hg@29
    44
		this.name = name;
franta-hg@29
    45
		this.className = className;
franta-hg@29
    46
	}
franta-hg@29
    47
franta-hg@104
    48
	public FormatterDefinition(String name, String className, Properties properties) {
franta-hg@104
    49
		this(name, className);
franta-hg@104
    50
		this.properties = properties;
franta-hg@104
    51
	}
franta-hg@104
    52
franta-hg@30
    53
	@XmlElement(name = "name", namespace = CONFIGURATION)
franta-hg@26
    54
	@Override
franta-hg@26
    55
	public String getName() {
franta-hg@26
    56
		return name;
franta-hg@26
    57
	}
franta-hg@26
    58
franta-hg@26
    59
	public void setName(String name) {
franta-hg@26
    60
		this.name = name;
franta-hg@26
    61
	}
franta-hg@26
    62
franta-hg@26
    63
	/**
franta-hg@26
    64
	 * Filter's class. Must implement the
franta-hg@26
    65
	 * <code>info.globalcode.sql.dk.formatting.Formatter</code> interface.
franta-hg@26
    66
	 * Subclassing the
franta-hg@26
    67
	 * <code>info.globalcode.sql.dk.formatting.AbstractFormatter</code> is strongly recommended.
franta-hg@26
    68
	 * The constructor must accept one parameter:
franta-hg@26
    69
	 * <code>info.globalcode.sql.dk.formatting.FormatterContext</code>
franta-hg@26
    70
	 *
franta-hg@26
    71
	 * @return fully qualified class name
franta-hg@26
    72
	 */
franta-hg@30
    73
	@XmlElement(name = "class", namespace = CONFIGURATION)
franta-hg@26
    74
	public String getClassName() {
franta-hg@26
    75
		return className;
franta-hg@26
    76
	}
franta-hg@26
    77
franta-hg@26
    78
	public void setClassName(String className) {
franta-hg@26
    79
		this.className = className;
franta-hg@26
    80
	}
franta-hg@26
    81
franta-hg@104
    82
	@XmlElement(name = "property", namespace = CONFIGURATION)
franta-hg@104
    83
	public Properties getProperties() {
franta-hg@104
    84
		return properties;
franta-hg@104
    85
	}
franta-hg@104
    86
franta-hg@104
    87
	public void setProperties(Properties properties) {
franta-hg@104
    88
		this.properties = properties;
franta-hg@104
    89
	}
franta-hg@104
    90
franta-hg@26
    91
	/**
franta-hg@26
    92
	 * @param context
franta-hg@26
    93
	 * @return
franta-hg@26
    94
	 * @throws DKException
franta-hg@26
    95
	 */
franta-hg@34
    96
	public Formatter getInstance(FormatterContext context) throws FormatterException {
franta-hg@104
    97
		context.getProperties().setDefaults(properties);
franta-hg@26
    98
		try {
franta-hg@26
    99
			Constructor constructor = Class.forName(className).getConstructor(context.getClass());
franta-hg@26
   100
franta-hg@26
   101
			Object instance = constructor.newInstance(context);
franta-hg@26
   102
			if (instance instanceof Formatter) {
franta-hg@26
   103
				return (Formatter) instance;
franta-hg@26
   104
			} else {
franta-hg@34
   105
				throw new FormatterException("Formatter " + instance + " does not implement the " + Formatter.class.getName() + " interface");
franta-hg@26
   106
			}
franta-hg@26
   107
		} catch (ClassNotFoundException e) {
franta-hg@160
   108
			throw new FormatterException("Formatter class does not exist: " + className, e);
franta-hg@26
   109
		} catch (NoSuchMethodException e) {
franta-hg@34
   110
			throw new FormatterException("Formatter class with no valid constructor: " + className, e);
franta-hg@26
   111
		} catch (InstantiationException | IllegalAccessException | InvocationTargetException e) {
franta-hg@34
   112
			throw new FormatterException("Formatter's constructor caused an error: " + className, e);
franta-hg@26
   113
		}
franta-hg@26
   114
	}
franta-hg@26
   115
}