Inheritance diagram for org.dbview.input_addons.AbstractConfiguration:

Public Member Functions
	AbstractConfiguration ()
String	getAddOnName ()
void	fromXml (Element in_xml, String in_addon_name, String in_profile_name) throws ConfigurationException, Exception
Element	toXml ()
Element	getData ()
String	printToXml ()
abstract ArrayList< String[]>	toStrings ()
Protected Member Functions
abstract ArrayList< Element >	_toXml_ ()
abstract void	_fromXml_ (Element in_xml) throws ConfigurationException
abstract String	_getAddOnName_ ()
Private Attributes
String	__profile_name = null
String	__addon = null

Detailed Description

This class implements the database's configuration adaptor.

Author:: Denis Beurive

Definition at line 33 of file AbstractConfiguration.java.

Constructor & Destructor Documentation

org.dbview.input_addons.AbstractConfiguration.AbstractConfiguration ( )

Construct a configuration.

Definition at line 48 of file AbstractConfiguration.java.

Member Function Documentation

abstract void org.dbview.input_addons.AbstractConfiguration._fromXml_ ( Element in_xml ) throws ConfigurationException [protected, pure virtual]

This method initializes the configuration for the specific add-on to which the configuration is associated. The initialization is done using the content of a given XML element.

Parameters:

in_xml Document XML.

Exceptions:

ConfigurationException

Note:: This method is used with the catalogue.

Implemented in org.dbview.addons.input.mysql.Configuration.

Referenced by org.dbview.input_addons.AbstractConfiguration.fromXml().

abstract String org.dbview.input_addons.AbstractConfiguration._getAddOnName_ ( ) [protected, pure virtual]

This method returns the name of the specific add-on to which the configuration is associated.

Returns:: The method returns the name of the specific add-on to which the configuration is associated.

Implemented in org.dbview.addons.input.mysql.Configuration.

Referenced by org.dbview.input_addons.AbstractConfiguration.AbstractConfiguration().

abstract ArrayList<Element> org.dbview.input_addons.AbstractConfiguration._toXml_ ( ) [protected, pure virtual]

This method returns a list of XML elements. These XML elements represent the configuration for the specific add-on to which the configuration is associated. These XML elements will be included in the configuration.

Returns:: The method returns a list of XML elements.

Note:: This method is used with the repository.

Implemented in org.dbview.addons.input.mysql.Configuration.

Referenced by org.dbview.input_addons.AbstractConfiguration.getData().

void org.dbview.input_addons.AbstractConfiguration.fromXml	(	Element	in_xml,
		String	in_addon_name,
		String	in_profile_name
	)		throws ConfigurationException, Exception

This method initializes a configuration based on a given XML document. The structure of this (XML) document depends on the values of parameters "in_addon_name" and "in_profile_name". If these parameters are NOT given, then the XML document must be:

      <configuration name="..." target="...">
         <data>
         ...
         </data>
      </configuration>

Otherwise:

      <data>
      ...
      </data>

Parameters:

in_xml	XML document.
in_addon_name	Name of the add-on to which this configuration is associated. This argument's value may be null.
in_profile_name	Name of the profile. This argument's value may be null.

Exceptions:

ConfigurationException

Definition at line 95 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.ProfilesRepository.getProfileInstance().

String org.dbview.input_addons.AbstractConfiguration.getAddOnName ( )

This method returns the name of the add-on associated to this adaptor.

Returns:: The method returns the name of the add-on associated to this adaptor.

Definition at line 58 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.AbstractConfiguration.toXml().

Element org.dbview.input_addons.AbstractConfiguration.getData ( )

This method returns the data part of the configuration.

The returned document is:

      <data>...</data>

Returns:: The method returns the data part of the configuration.

Definition at line 192 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.AbstractConfiguration.toXml().

String org.dbview.input_addons.AbstractConfiguration.printToXml ( )

This method generates a literal representation of the XML document.

Returns:: The method returns a literal representation of the XML document.

Definition at line 213 of file AbstractConfiguration.java.

abstract ArrayList<String[]> org.dbview.input_addons.AbstractConfiguration.toStrings ( ) [pure virtual]

This method returns a structure that can be sued to produce a literal representation of the configuration. The returned structure is an array. Each element of the returned array is an array that contains 2 strings.

The first element of the array is the name of a configuration parameter.
The second element of the array is the value of a configuration parameter.

Returns:: The method returns a structure that can be used to produce a literal representation of the configuration.

Implemented in org.dbview.addons.input.mysql.Configuration.

Element org.dbview.input_addons.AbstractConfiguration.toXml ( )

This method creates a XML document that represents a configuration.

The structure of the returned document is:

      <configuration name="..." target="...">
          <data>...</data>
      </configuration>

Returns:: The method returns a XML element.

Definition at line 169 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.AbstractConfiguration.printToXml().

Member Data Documentation

String org.dbview.input_addons.AbstractConfiguration.__addon = null [private]

The name of the add-on to which this adaptor is associated.

Definition at line 43 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.AbstractConfiguration.AbstractConfiguration(), org.dbview.input_addons.AbstractConfiguration.fromXml(), and org.dbview.input_addons.AbstractConfiguration.getAddOnName().

String org.dbview.input_addons.AbstractConfiguration.__profile_name = null [private]

Name of the profile associated to this configuration.

Definition at line 38 of file AbstractConfiguration.java.

Referenced by org.dbview.input_addons.AbstractConfiguration.fromXml(), and org.dbview.input_addons.AbstractConfiguration.toXml().

The documentation for this class was generated from the following file:

src/org/dbview/input_addons/AbstractConfiguration.java

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation