org.dbview.databaseExporters.dot.AbstractDatabaseExporter Class Reference

Inheritance diagram for org.dbview.databaseExporters.dot.AbstractDatabaseExporter:

Collaboration diagram for org.dbview.databaseExporters.dot.AbstractDatabaseExporter:

List of all members.

Public Member Functions
	AbstractDatabaseExporter (ArrayList< Table > in_tables, Database in_db)
abstract String	export (Hashtable< String, Object > in_options) throws Exception
Protected Member Functions
String	_relationColor (int in_table_to_table_relation_type) throws Exception
Protected Attributes
ArrayList< Table >	_tables = null
Database	_db = null

---

Detailed Description

This class defines the generic interface of a database exporter that relies on Grahviz. A database exporter creates a representation of a given list of tables, within a given database.

Remarks:

Please note that all DOT add-ons use this exporter.

Author:

Denis Beurive

Definition at line 35 of file AbstractDatabaseExporter.java.

---

Constructor & Destructor Documentation

org.dbview.databaseExporters.dot.AbstractDatabaseExporter.AbstractDatabaseExporter	(	ArrayList< Table >	in_tables,
		Database	in_db
	)

Create the exporter.

Parameters:

in_tables	List of tables to export. This parameter can be null. If the parameter's value is null, then all tables of the database are exported.
in_db	Handle to the database.

Definition at line 54 of file AbstractDatabaseExporter.java.

---

Member Function Documentation

String org.dbview.databaseExporters.dot.AbstractDatabaseExporter._relationColor

(

int

in_table_to_table_relation_type

)

throws Exception [protected]

This method returns the color to apply to a given edge, given the type of the table to table relation.

Parameters:

in_table_to_table_relation_type

The type of the relation.

Returns:

The method returns the color to apply to a given edge.

Exceptions:

Exception

Definition at line 75 of file AbstractDatabaseExporter.java.

Referenced by org.dbview.databaseExporters.dot.DotLight.export(), org.dbview.databaseExporters.dot.DotMedium.export(), and org.dbview.databaseExporters.dot.DotFull.export().

abstract String org.dbview.databaseExporters.dot.AbstractDatabaseExporter.export

(

Hashtable< String, Object >

in_options

)

throws Exception [pure virtual]

This method exports the given tables, from the given database.

Parameters:

in_options

Options.

Returns:

The method returns a string that represents the DOT representation.

Exceptions:

Exception

Implemented in org.dbview.databaseExporters.dot.DotFull, org.dbview.databaseExporters.dot.DotMedium, and org.dbview.databaseExporters.dot.DotLight.

---

Member Data Documentation

Database org.dbview.databaseExporters.dot.AbstractDatabaseExporter._db = null [protected]

Database to export.

Definition at line 46 of file AbstractDatabaseExporter.java.

Referenced by org.dbview.databaseExporters.dot.AbstractDatabaseExporter.AbstractDatabaseExporter(), org.dbview.databaseExporters.dot.DotLight.export(), org.dbview.databaseExporters.dot.DotMedium.export(), and org.dbview.databaseExporters.dot.DotFull.export().

ArrayList<Table> org.dbview.databaseExporters.dot.AbstractDatabaseExporter._tables = null [protected]

List of table to export. Please note that the property's value may be null. If the property's value is null, then all tables of the database are exported.

Definition at line 41 of file AbstractDatabaseExporter.java.

Referenced by org.dbview.databaseExporters.dot.AbstractDatabaseExporter.AbstractDatabaseExporter(), org.dbview.databaseExporters.dot.DotLight.export(), org.dbview.databaseExporters.dot.DotMedium.export(), and org.dbview.databaseExporters.dot.DotFull.export().

---

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

• src/org/dbview/databaseExporters/dot/AbstractDatabaseExporter.java