Inheritance diagram for org.dbview.addons.input.mysql.Configuration:

Collaboration diagram for org.dbview.addons.input.mysql.Configuration:

Public Member Functions
	Configuration ()
ArrayList< String[]>	toStrings ()
String	getAddOnName ()
void	fromXml (Element in_xml, String in_addon_name, String in_profile_name) throws ConfigurationException, Exception
Element	toXml ()
Element	getData ()
String	printToXml ()
Protected Member Functions
String	_getAddOnName_ ()
ArrayList< Element >	_toXml_ ()
void	_fromXml_ (Element in_xml) throws ConfigurationException
Private Attributes
String	__host = null
Integer	__port = new Integer(3306)
String	__login = null
String	__password = null
String	__db_name = null
String	__soft_foreign_key_detector = null

Detailed Description

This class implements the configuration adapter for the Mysql add-on.

Author:: Denis BEURIVE

Definition at line 37 of file Configuration.java.

Constructor & Destructor Documentation

org.dbview.addons.input.mysql.Configuration.Configuration ( )

Constructor.

Author:: Denis BEURIVE

Definition at line 78 of file Configuration.java.

Member Function Documentation

void org.dbview.addons.input.mysql.Configuration._fromXml_ ( Element in_xml ) throws ConfigurationException [protected, 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 (that represents a configuration).

Exceptions:

ConfigurationException

Note:: This method is used with the profile's repository.

Implements org.dbview.input_addons.AbstractConfiguration.

Definition at line 124 of file Configuration.java.

String org.dbview.addons.input.mysql.Configuration._getAddOnName_ ( ) [protected, 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.

Implements org.dbview.input_addons.AbstractConfiguration.

Definition at line 90 of file Configuration.java.

ArrayList<Element> org.dbview.addons.input.mysql.Configuration._toXml_ ( ) [protected, 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 (in this case "mysql"). These XML elements will be included in the configuration.

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

Implements org.dbview.input_addons.AbstractConfiguration.

Definition at line 102 of file Configuration.java.

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

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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.

ArrayList<String[]> org.dbview.addons.input.mysql.Configuration.toStrings ( ) [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.

Implements org.dbview.input_addons.AbstractConfiguration.

Definition at line 169 of file Configuration.java.

Element org.dbview.input_addons.AbstractConfiguration.toXml ( ) [inherited]

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.addons.input.mysql.Configuration.__db_name = null [private]

Name of the database.

Author:: Denis BEURIVE

Definition at line 67 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

String org.dbview.addons.input.mysql.Configuration.__host = null [private]

Name of the host that runs the MySql server.

Author:: Denis BEURIVE

Definition at line 43 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

String org.dbview.addons.input.mysql.Configuration.__login = null [private]

Identifier used to access the database.

Author:: Denis BEURIVE

Definition at line 55 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

String org.dbview.addons.input.mysql.Configuration.__password = null [private]

Password used to authenticate to the MySql server.

Author:: Denis BEURIVE

Definition at line 61 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), org.dbview.addons.input.mysql.Configuration._toXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

Integer org.dbview.addons.input.mysql.Configuration.__port = new Integer(3306) [private]

Port number used to connect to the MySql serveur.

Author:: Denis BEURIVE

Definition at line 49 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

String org.dbview.addons.input.mysql.Configuration.__soft_foreign_key_detector = null [private]

This string represents the name of the class used to detect foreign keys from field's names.

Definition at line 72 of file Configuration.java.

Referenced by org.dbview.addons.input.mysql.Configuration._fromXml_(), org.dbview.addons.input.mysql.Configuration._toXml_(), and org.dbview.addons.input.mysql.Configuration.toStrings().

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

src/org/dbview/addons/input/mysql/Configuration.java

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation