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

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

Public Member Functions
OptionContainer	getOptionsContainer ()
ArrayList< CliParameter >	getOptions ()
Element	getConf (String[] in_vargs, Boolean in_strict, Boolean in_set_default) throws CliException
Protected Member Functions
ArrayList< Element >	_getConf_ (String[] in_vargs, Boolean in_strict, Boolean in_set_default) throws CliException
Private Attributes
CliOptions	__options = new CliOptions()

Detailed Description

This class is responsible for extracting values from the command line, for the MySql add-on.

Definition at line 42 of file Cli.java.

Member Function Documentation

ArrayList<Element> org.dbview.addons.input.mysql.Cli._getConf_	(	String[]	in_vargs,
		Boolean	in_strict,
		Boolean	in_set_default
	)		throws CliException `[protected, virtual]`

This method returns the information extracted from the command line.

Parameters:

in_vargs	The command line arguments.
in_strict	This parameter indicates whether the CLI parser should check the presence of mandatory options, or not. TRUE: Check the presence of mandatory options. FALSE: Does not check the presence of mandatory options.
in_set_default	This parameter indicates whether the method should set default values or not. TRUE: Set default values. When adding a new profile, you should activate the assignment of default values. FALSE: Does not set default values. When updating a profile, you should deactivate the assignment of default values.

Returns:: The method returns the information extracted from the command line. The configuration is represented by a list of XML elements. Each element of the returned list will be included in the XML representation of the configuration.

Definition at line 81 of file Cli.java.

Element org.dbview.adapter.AbstractCli.getConf	(	String[]	in_vargs,
		Boolean	in_strict,
		Boolean	in_set_default
	)		throws CliException `[inherited]`

This method returns an XML document that represents the command line.

Parameters:

in_vargs	The command line arguments.
in_strict	This parameter indicates whether the CLI parser should check the presence of mandatory options, or not. TRUE: Check the presence of mandatory options. FALSE: Does not check the presence of mandatory options.
in_set_default	This parameter indicates whether the method should set default values or not. TRUE: Set default values. When adding a new profile, you should activate the assignment of default values. FALSE: Does not set default values. When updating a profile, you should deactivate the assignment of default values.

Returns:: The method returns the extracted information. The returned structure is a XML element identified by the tag "data". Example: <data><login>...</login><password>...</password></data>

Definition at line 82 of file AbstractCli.java.

ArrayList<CliParameter> org.dbview.addons.input.mysql.Cli.getOptions ( ) [virtual]

This method returns the description of the command line expected by this adaptor.

Returns:: The method returns an array of command line parameter's descriptions.

Definition at line 160 of file Cli.java.

OptionContainer org.dbview.addons.input.mysql.Cli.getOptionsContainer ( ) [virtual]

Return the command line options container.

Remarks:: The returned container is mainly used to detect unexpected arguments in the command line.

Definition at line 55 of file Cli.java.

This attribute represents the command line options' container used to parse the command line that applies to the add-on.

Remarks:: See Args4j. The command line options are declared in a class. We call this class the command line options container

Definition at line 48 of file Cli.java.

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