DBVIEW
Public Member Functions
org.dbview.resources.AbstractSotfForeignKeyDetector Class Reference
Inheritance diagram for org.dbview.resources.AbstractSotfForeignKeyDetector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

abstract Boolean isFk (String in_field_name)
abstract String referenceTable (String in_field_name)
abstract String referenceField (String in_field_name)
abstract String description ()

Detailed Description

This class defines the interface for a "soft foreign key" detector. Please note that a soft foreign key is defined by the field's name only. There is no constraint declared in the database. This kind of foreign key is used with database systems that don't support foreign keys (ex: MyIsam).

Author:
Denis Beurive

Definition at line 32 of file AbstractSotfForeignKeyDetector.java.

Member Function Documentation

abstract String org.dbview.resources.AbstractSotfForeignKeyDetector.description ( ) [pure virtual]

This method returns a description of the detector.

Returns:
The method returns a description of the detector.

Implemented in org.dbview.resources.softforeignkeydetectors.FkUsTargetTableName, org.dbview.resources.softforeignkeydetectors.IdUsTargetTableName, org.dbview.resources.softforeignkeydetectors.TargetTableNameUsId, org.dbview.resources.softforeignkeydetectors.FkTargetTableName, and org.dbview.resources.softforeignkeydetectors.IdTargetTableName.

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

abstract Boolean org.dbview.resources.AbstractSotfForeignKeyDetector.isFk ( String  in_field_name) [pure virtual]

This method tests whether a field, identified by its name, is a soft foreign key or not.

Parameters:
in_field_nameName of the field to test.
Returns:
If the field is a (soft) foreign key, then the method returns the value TRUE. Otherwise, it returns the value FALSE.

Implemented in org.dbview.resources.softforeignkeydetectors.FkTargetTableName, org.dbview.resources.softforeignkeydetectors.FkUsTargetTableName, org.dbview.resources.softforeignkeydetectors.IdTargetTableName, org.dbview.resources.softforeignkeydetectors.IdUsTargetTableName, and org.dbview.resources.softforeignkeydetectors.TargetTableNameUsId.

abstract String org.dbview.resources.AbstractSotfForeignKeyDetector.referenceField ( String  in_field_name) [pure virtual]

If the field is a (soft) foreign key, then the method returns the name of the "reference" field (within the "reference" table).

Parameters:
in_field_nameName of the field.
Returns:
If the field is a (soft) foreign key, then the method returns the name of the "reference" field. Otherwise, the method returns the value null.

Implemented in org.dbview.resources.softforeignkeydetectors.FkUsTargetTableName, org.dbview.resources.softforeignkeydetectors.IdUsTargetTableName, org.dbview.resources.softforeignkeydetectors.TargetTableNameUsId, org.dbview.resources.softforeignkeydetectors.FkTargetTableName, and org.dbview.resources.softforeignkeydetectors.IdTargetTableName.

abstract String org.dbview.resources.AbstractSotfForeignKeyDetector.referenceTable ( String  in_field_name) [pure virtual]

If the field is a soft foreign key, then the method returns the name of the "reference" table.

Parameters:
in_field_nameName of the field.
Returns:
If the field is a (soft) foreign key, then the method returns the name of the "reference" table. Otherwise, the method returns the value null.

Implemented in org.dbview.resources.softforeignkeydetectors.FkTargetTableName, org.dbview.resources.softforeignkeydetectors.FkUsTargetTableName, org.dbview.resources.softforeignkeydetectors.IdTargetTableName, org.dbview.resources.softforeignkeydetectors.IdUsTargetTableName, and org.dbview.resources.softforeignkeydetectors.TargetTableNameUsId.

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