b4j.core

Class DefaultMetaInformation

java.lang.Object

b4j.core.DefaultMetaInformation

All Implemented Interfaces:

MetaInformation

public class DefaultMetaInformation
extends Object
implements MetaInformation

Default implementation of meta information for a report generator. This class reads its data from a XML file.

Author:

Ralph Schuster

Constructor Summary

Constructors

Constructor and Description
DefaultMetaInformation() Default Constructor.
DefaultMetaInformation(File metaFile) Constructor with XML configuration file.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addAllReports(Collection<? extends BugzillaReportGenerator> c) Adds multiple report generators.
boolean	addReport(BugzillaReportGenerator e) Adds a new report generator.
void	clearReports() Clears all generators.
void	configure(org.apache.commons.configuration.XMLConfiguration config) Configures the data from an XML configuration object.
void	dump() Debug information into log.
void	dump(org.slf4j.Logger log) Debug information into log.
SearchData	getBugzillaSearchData() Returns the search data.
Session	getBugzillaSession() Returns the session object to be used.
Iterator<BugzillaReportGenerator>	getReports() Returns all report generators.
void	read(File metaFile) Reads the XML configuration file.
void	read(Reader reader) Reads and parses the XML configuration file from a stream reader.
boolean	removeAllReports(Collection<?> c) Removes all generators listed in argument.
boolean	removeReport(BugzillaReportGenerator o) Removes a report generator.
void	setSearchData(SearchData searchData) Sets the search parameter object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultMetaInformation

public DefaultMetaInformation()

Default Constructor.

DefaultMetaInformation

public DefaultMetaInformation(File metaFile)
                       throws Exception

Constructor with XML configuration file.

Throws:

Exception

Method Detail

read

public void read(File metaFile)
          throws Exception

Reads the XML configuration file.

Parameters:

metaFile - - the XML file to read

Throws:

Exception - - if an error occurs

read

public void read(Reader reader)
          throws org.apache.commons.configuration.ConfigurationException

Reads and parses the XML configuration file from a stream reader.

Parameters:

reader - - a reader on the XML file.

Throws:

org.apache.commons.configuration.ConfigurationException - - if a configuration error occurs

configure

public void configure(org.apache.commons.configuration.XMLConfiguration config)
               throws org.apache.commons.configuration.ConfigurationException

Configures the data from an XML configuration object.

Parameters:

config - - XML configuration

Throws:

org.apache.commons.configuration.ConfigurationException - - if a configuration error occurs

getReports

public Iterator<BugzillaReportGenerator> getReports()

Returns all report generators.

Specified by:

getReports in interface MetaInformation

Returns:

iterator on all report generators.

getBugzillaSearchData

public SearchData getBugzillaSearchData()

Returns the search data.

Specified by:

getBugzillaSearchData in interface MetaInformation

Returns:

search data object

getBugzillaSession

public Session getBugzillaSession()

Returns the session object to be used.

Specified by:

getBugzillaSession in interface MetaInformation

Returns:

session object through which all Bugzilla communication will be performed

addReport

public boolean addReport(BugzillaReportGenerator e)

Adds a new report generator.

Parameters:

e - - the generator to add

Returns:

true if generator could be added

addAllReports

public boolean addAllReports(Collection<? extends BugzillaReportGenerator> c)

Adds multiple report generators.

Parameters:

c - - collection of generators to add

Returns:

true if generators were added

clearReports

public void clearReports()

Clears all generators.

removeReport

public boolean removeReport(BugzillaReportGenerator o)

Removes a report generator.

Parameters:

o - - generator object to remove

Returns:

true if generator could be removed

removeAllReports

public boolean removeAllReports(Collection<?> c)

Removes all generators listed in argument.

Parameters:

c - - all generators to remove

Returns:

true if all reports were removed

setSearchData

public void setSearchData(SearchData searchData)

Sets the search parameter object.

Parameters:

searchData - - the search data to set

dump

public void dump()

Debug information into log.

dump

public void dump(org.slf4j.Logger log)

Debug information into log.

Specified by:

dump in interface MetaInformation

Parameters:

log - - the log object