DBVIEW
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes
org.dbview.resources.SotfForeignKeyDetectorCatalog Class Reference
Collaboration diagram for org.dbview.resources.SotfForeignKeyDetectorCatalog:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SotfForeignKeyDetectorCatalog () throws SotfForeignKeyDetectorException
Enumeration< String > getMatchers ()
String toString ()
AbstractSotfForeignKeyDetector getFkMatcherByName (String in_real_name) throws SotfForeignKeyDetectorException
AbstractSotfForeignKeyDetector getFkMatcherByCliName (String in_cli_name) throws SotfForeignKeyDetectorException
String getFkMatcherDescriptionByName (String in_name) throws SotfForeignKeyDetectorException
String getFkMatcherDescriptionByCliName (String in_cli_name) throws SotfForeignKeyDetectorException

Static Public Member Functions

static String fromCli (String in_cli_name)
static String toCli (String in_real_name)

Private Attributes

Hashtable< String, String > __matchers = null

Static Private Attributes

static final String __FJ_RESOURCE_NAME = "sotfForeignKeyDetectors"

Detailed Description

This class implements the catalogue of soft foreign key detectors.

Author:
Denis Beurive

Definition at line 40 of file SotfForeignKeyDetectorCatalog.java.

Constructor & Destructor Documentation

org.dbview.resources.SotfForeignKeyDetectorCatalog.SotfForeignKeyDetectorCatalog ( ) throws SotfForeignKeyDetectorException

Create the catalogue of soft foreign key detectors.

Exceptions:
Exception

Definition at line 62 of file SotfForeignKeyDetectorCatalog.java.

Member Function Documentation

static String org.dbview.resources.SotfForeignKeyDetectorCatalog.fromCli ( String  in_cli_name) [static]

This method returns the real name of a soft foreign key detector, given the CLI name of the detector.

Parameters:
in_cli_nameCLI name of the detector.
Returns:
The method returns the real name of a soft foreign key detector.

Definition at line 243 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherByCliName(), and org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherDescriptionByCliName().

AbstractSotfForeignKeyDetector org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherByCliName ( String  in_cli_name) throws SotfForeignKeyDetectorException

This method returns an instance of a soft foreign key detector, identified by its CLI (Command Line Interface) name.

Parameters:
in_cli_nameThe CLI name of the soft foreign key matcher.
Returns:
The method returns an instance of a soft foreign key matcher, identified the given CLI name.
Exceptions:
SotfForeignKeyDetectorException

Definition at line 209 of file SotfForeignKeyDetectorCatalog.java.

AbstractSotfForeignKeyDetector org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherByName ( String  in_real_name) throws SotfForeignKeyDetectorException

This method returns an instance of a soft foreign key detector, identified by its real (as opposed to "CLI") name.

Parameters:
in_real_nameThe CLI name of the soft foreign key detector.
Returns:
The method returns an instance of a soft foreign key detector, identified the given (real) name.
Exceptions:
SotfForeignKeyDetectorException

Definition at line 164 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherByCliName(), and org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherDescriptionByName().

String org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherDescriptionByCliName ( String  in_cli_name) throws SotfForeignKeyDetectorException

This method returns the description of a given soft foreign key detector, given its CLI name.

Parameters:
in_cli_nameCLI name of the soft foreign key detector.
Returns:
The method returns the description of a given soft foreign key detector.
Exceptions:
SotfForeignKeyDetectorException

Definition at line 233 of file SotfForeignKeyDetectorCatalog.java.

String org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherDescriptionByName ( String  in_name) throws SotfForeignKeyDetectorException

This method returns the description of a given soft foreign key detector, given its real name.

Parameters:
in_nameName of the soft foreign key detector.
Returns:
The method returns the description of a given soft foreign key detector.
Exceptions:
SotfForeignKeyDetectorException

Definition at line 221 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherDescriptionByCliName().

Enumeration<String> org.dbview.resources.SotfForeignKeyDetectorCatalog.getMatchers ( )

This method returns the list of all available soft foreign key detectors.

Returns:
The method returns the list of all available soft foreign key detectors.
Exceptions:
Exception

Definition at line 117 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.toString().

static String org.dbview.resources.SotfForeignKeyDetectorCatalog.toCli ( String  in_real_name) [static]

This method returns the CLI name of a soft foreign key detector, given the real name of the detector.

Parameters:
in_real_nameReam name of the detector.
Returns:
The method returns the CLI name of a soft foreign key detector.

Definition at line 253 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.toString().

String org.dbview.resources.SotfForeignKeyDetectorCatalog.toString ( )

The method produces a string that represents the catalogue.

Returns:
The method returns a string that represents the catalogue.

Definition at line 133 of file SotfForeignKeyDetectorCatalog.java.

Member Data Documentation

final String org.dbview.resources.SotfForeignKeyDetectorCatalog.__FJ_RESOURCE_NAME = "sotfForeignKeyDetectors" [static, private]

Name of the property that references the JAR file that contains the implementation of all soft foreign key detectors.

Remarks:
This property is defined in the configuration file of the software. The software's configuration file is a "property file" (see file "resources.properties").

Definition at line 47 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.SotfForeignKeyDetectorCatalog().

Hashtable<String, String> org.dbview.resources.SotfForeignKeyDetectorCatalog.__matchers = null [private]

This hash table lists all available soft foreign key detectors.

  • Key: The name of the soft foreign key detector.
  • Value: The name of the package that contains the soft foreign key detector.

Definition at line 56 of file SotfForeignKeyDetectorCatalog.java.

Referenced by org.dbview.resources.SotfForeignKeyDetectorCatalog.getFkMatcherByName(), org.dbview.resources.SotfForeignKeyDetectorCatalog.getMatchers(), org.dbview.resources.SotfForeignKeyDetectorCatalog.SotfForeignKeyDetectorCatalog(), and org.dbview.resources.SotfForeignKeyDetectorCatalog.toString().

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