All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • b4j.core.DefaultMetaInformation Maven / Gradle / Ivy

    There is a newer version: 3.0.1
    Show newest version
    /*
 * This file is part of Bugzilla for Java.
 *
 *  Bugzilla for Java is free software: you can redistribute it 
 *  and/or modify it under the terms of version 3 of the GNU 
 *  Lesser General Public  License as published by the Free Software 
 *  Foundation.
 *  
 *  Bugzilla for Java is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public 
 *  License along with Bugzilla for Java.  If not, see 
 *  .
 */
package b4j.core;

import java.io.File;
import java.io.FileReader;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.XMLConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import rsbaselib.configuration.ConfigurationUtils;
import b4j.report.BugzillaReportGenerator;


/**
 * Default implementation of meta information for a report generator.
 * This class reads its data from a XML file.
 * @author Ralph Schuster
 *
 */
public class DefaultMetaInformation implements MetaInformation {

	private static Logger log = LoggerFactory.getLogger(DefaultMetaInformation.class);
	
	private List reports;
	private SearchData searchData = new DefaultSearchData();
	private Session bugzillaSession;
	
	/**
	 * Default Constructor.
	 */
	public DefaultMetaInformation() {
	}
	
	/**
	 * Constructor with XML configuration file.
	 */
	public DefaultMetaInformation(File metaFile) throws Exception {
		read(metaFile);
	}

	/**
	 * Reads the XML configuration file.
	 * @param metaFile - the XML file to read
	 * @throws Exception - if an error occurs
	 */
	public void read(File metaFile) throws Exception {
			read(new FileReader(metaFile));
	}

	/**
	 * Reads and parses the XML configuration file from a stream reader.
	 * @param reader - a reader on the XML file.
	 * @throws ConfigurationException - if a configuration error occurs
	 */
	public void read(Reader reader) throws ConfigurationException {
			XMLConfiguration config = new XMLConfiguration();
			config.load(reader);
			configure(config);
	}
	
	/**
	 * Configures the data from an XML configuration object.
	 * @param config - XML configuration
	 * @throws ConfigurationException - if a configuration error occurs
	 */
	@SuppressWarnings("unchecked")
	public void configure(XMLConfiguration config) throws ConfigurationException {
		// Create and configure bugzilla session
		String className = null;
		Configuration sessionCfg = config.configurationAt("bugzilla-session(0)");
		bugzillaSession = (Session)ConfigurationUtils.load(sessionCfg, true);

		// Reports to generate
		reports = new ArrayList();
		List classNames = config.getList("report[@class]");
		Iterator i = classNames.iterator();
		int idx = 0;
		while (i.hasNext()) {
			className = (String)i.next();
			try {
				Class clazz = Class.forName(className);
				Class clazz2 = (Class)clazz;
				BugzillaReportGenerator r = clazz2.newInstance();
				Configuration cConfig = config.configurationAt("report("+idx+")");
				r.init(cConfig);
				r.setBugzillaSession(bugzillaSession);
				reports.add(r);
			} catch (ClassNotFoundException e) {
				log.error("Cannot find report "+className);
			} catch (InstantiationException e) {
				log.error("Cannot instantiate "+className);
			} catch (IllegalAccessException e) {
				log.error("Cannot access constructor of "+className);
			}
			idx++;
		}

		// Create and configure search data
		searchData = new DefaultSearchData();
		Configuration searchCfg = config.configurationAt("search(0)");
		searchData.beforeConfiguration();
		searchData.configure(searchCfg);
		searchData.afterConfiguration();
	}

	/**
	 * Returns all report generators.
	 * @return iterator on all report generators.
	 */
	public Iterator getReports() {
		return reports.iterator();
	}
	
	/**
	 * Returns the search data.
	 * @return search data object
	 */
	@Override
	public SearchData getBugzillaSearchData() {
		return searchData;
	}

	/**
	 * Returns the session object to be used.
	 * @return session object through which all Bugzilla communication will be performed
	 */
	@Override
	public Session getBugzillaSession() {
		return bugzillaSession;
	}

	
	/**
	 * Adds a new report generator.
	 * @param e - the generator to add
	 * @return true if generator could be added
	 */
	public boolean addReport(BugzillaReportGenerator e) {
		return reports.add(e);
	}

	/**
	 * Adds multiple report generators.
	 * @param c - collection of generators to add
	 * @return true if generators were added
	 */
	public boolean addAllReports(Collection c) {
		return reports.addAll(c);
	}

	/**
	 * Clears all generators.
	 */
	public void clearReports() {
		reports.clear();
	}

	/**
	 * Removes a report generator.
	 * @param o - generator object to remove
	 * @return true if generator could be removed
	 */
	public boolean removeReport(BugzillaReportGenerator o) {
		return reports.remove(o);
	}

	/**
	 * Removes all generators listed in argument.
	 * @param c - all generators to remove
	 * @return true if all reports were removed
	 */
	public boolean removeAllReports(Collection c) {
		return reports.removeAll(c);
	}

	/**
	 * Sets the search parameter object.
	 * @param searchData - the search data to set
	 */
	public void setSearchData(SearchData searchData) {
		this.searchData = searchData;
	}

	/**
	 * Debug information into log.
	 */
	public void dump() {
		dump(log);
	}
	
	/**
	 * Debug information into log.
	 * @param log - the log object
	 */
	@Override
	public void dump(Logger log) {
		if (!log.isDebugEnabled()) return;
		getBugzillaSession().dump();
		getBugzillaSearchData().dump(log);
		Iterator j = getReports();
		while (j.hasNext()) log.info("report="+j.next().getClass().getName());
	}
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy