DBVIEW
Static Public Member Functions
org.dbview.runtime.actions.Actions Class Reference

List of all members.

Static Public Member Functions

static void listInputTargets () throws Exception
static void listFkMatchers () throws Exception
static void helpInputAddOn (Hashtable< String, Object > in_args) throws Exception
static void helpOutputAddOn (Hashtable< String, Object > in_args) throws Exception
static void listOutputTargets () throws Exception
static void addProfile (Hashtable< String, Object > in_args) throws Exception
static void removeProfile (Hashtable< String, Object > in_args) throws Exception
static void updateProfile (Hashtable< String, Object > in_args) throws Exception
static void showProfile (Hashtable< String, Object > in_args) throws Exception
static void listProfiles () throws Exception
static void export (Hashtable< String, Object > in_args) throws Exception

Detailed Description

This class implements all action defined by the command line interface.

Author:
Denis Beurive

Definition at line 50 of file Actions.java.

Member Function Documentation

static void org.dbview.runtime.actions.Actions.addProfile ( Hashtable< String, Object >  in_args) throws Exception [static]

This method adds a new profile to the repository.

Parameters:
in_argsThis hash table contains the parameters required for updating a profile. Keys are:
  • name: Name of the new profile to add.
  • input-target: Profile's target.
  • input-target-configuration: XML document, generated by the CLI parser, that represents the profile.
Exceptions:
Exception

Definition at line 183 of file Actions.java.

static void org.dbview.runtime.actions.Actions.export ( Hashtable< String, Object >  in_args) throws Exception [static]

This method exports a given database to a given output format.

Parameters:
in_argshis hash table contains the parameters for the export. Keys are:
  • path-between: If the user request the calculation of a path, this array contains the names of the tables at the extremities.
  • path-limit: If the user request the calculation of a path, this integer represents the maximum number of paths.
  • zoom-list: If the user request a zoom around tables, this array contains the list of tables to zoom in.
  • zoom-level: If the user request a zoom around tables, this integer represents the neighbourhood area.
  • input-target-name: Name of the add-on that is used to connect to a database.
  • output-target-name: Name of the add-on used to export the database.
  • input-configuration: Specific configuration for the input add-on.
  • output-configuration: Specific configuration for the output add-on.
Exceptions:
Exception

Definition at line 354 of file Actions.java.

static void org.dbview.runtime.actions.Actions.helpInputAddOn ( Hashtable< String, Object >  in_args) throws Exception [static]

This method prints the help for a specific input add-on.

Parameters:
in_argsThis hash table contains the parameters required for printing the help for a specific input add-on. Keys are:
  • name; Name of the input add-on.
Exceptions:
Exception

Definition at line 99 of file Actions.java.

static void org.dbview.runtime.actions.Actions.helpOutputAddOn ( Hashtable< String, Object >  in_args) throws Exception [static]

This method prints the help for a specific output target.

Parameters:
in_argsThis hash table contains the parameters required for printing the help for a specific output add-on. Keys are:
  • name: Name of the output add-on.
Exceptions:
Exception

Definition at line 132 of file Actions.java.

static void org.dbview.runtime.actions.Actions.listFkMatchers ( ) throws Exception [static]

This method lists all foreign key matchers.

Exceptions:
Exception

Definition at line 72 of file Actions.java.

static void org.dbview.runtime.actions.Actions.listInputTargets ( ) throws Exception [static]

This method lists all input targets.

Exceptions:
Exception

Definition at line 58 of file Actions.java.

static void org.dbview.runtime.actions.Actions.listOutputTargets ( ) throws Exception [static]

This method lists all output targets.

Exceptions:
Exception

Definition at line 160 of file Actions.java.

static void org.dbview.runtime.actions.Actions.listProfiles ( ) throws Exception [static]

This method prints the list of profile's names stored in the repository.

Exceptions:
Exception

Definition at line 319 of file Actions.java.

static void org.dbview.runtime.actions.Actions.removeProfile ( Hashtable< String, Object >  in_args) throws Exception [static]

This method removes a profile from the repository.

Parameters:
in_argsThis hash table contains the parameters required for updating a profile. Keys are:
  • name: Name of the profile to remove.
Exceptions:
Exception

Definition at line 207 of file Actions.java.

static void org.dbview.runtime.actions.Actions.showProfile ( Hashtable< String, Object >  in_args) throws Exception [static]

This method prints a given profile.

Parameters:
in_argsThis hash table contains the parameters required for showing a profile. Keys are:
  • name: Name of the profile to show.
Exceptions:
Exception

Definition at line 290 of file Actions.java.

Referenced by org.dbview.runtime.actions.Actions.listProfiles().

static void org.dbview.runtime.actions.Actions.updateProfile ( Hashtable< String, Object >  in_args) throws Exception [static]

This method removes a profile from the repository.

Parameters:
in_argsThis hash table contains the parameters required for updating a profile. Keys are:
  • name: Name of the profile to upddate.
  • target: Name of the profile's target.
  • new_configuration: XML document, generated by the CLI parser, that represents the new profile.
  • old_configuration: XML document, generated by the CLI parser, that represents the old profile.
Exceptions:
Exception

Definition at line 226 of file Actions.java.

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