org.dbview.databaseExporters.dot.DotFull Class Reference

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

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

List of all members.

Public Member Functions
	DotFull (ArrayList< Table > in_tables, Database in_db)
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
Private Member Functions
String	__createFullTableLabel (Table in_table, String in_rankdir)
String	__createIndexLabel (Table in_table, String in_rankdir) throws Exception
String	__createJoinLabel (ArrayList< FieldToFieldJoin > in_relations, String in_rankdir)

---

Detailed Description

This class implements the export to DOT, with a high level of details.

See also:

AbstractDatabaseExporter

Author:

Denis Beurive

Definition at line 42 of file DotFull.java.

---

Constructor & Destructor Documentation

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

Create the exporter.

Parameters:

in_tables	List of tables to export.
in_db	Handle to the database.

Definition at line 49 of file DotFull.java.

---

Member Function Documentation

String org.dbview.databaseExporters.dot.DotFull.__createFullTableLabel	(	Table	in_table,
		String	in_rankdir
	)		[private]

This method creates the "full" label for a given table. The label is a grid that contains 5 columns, and as many row as the number of fields in the table.

Parameters:

in_table	The table.
in_rankdir	Initial orientation of a record node. Values can be: TB (Top to bottom) LR (Left to right) RL 'Right to left)

See GRAPHVIZ' documentation for "rankdir": http://www.graphviz.org/doc/info/shapes.html

Returns:

The method returns a string that represents the label.

Definition at line 194 of file DotFull.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.export().

String org.dbview.databaseExporters.dot.DotFull.__createIndexLabel	(	Table	in_table,
		String	in_rankdir
	)		throws Exception [private]

This method creates the "index" label for a given table.

Parameters:

in_table	The table.
in_rankdir	Initial orientation of a record node. Values can be: TB (Top to bottom) LR (Left to right) RL 'Right to left)

See GRAPHVIZ' documentation for "rankdir": http://www.graphviz.org/doc/info/shapes.html

Returns:

The method returns a string that represents the label.

Definition at line 269 of file DotFull.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.export().

String org.dbview.databaseExporters.dot.DotFull.__createJoinLabel	(	ArrayList< FieldToFieldJoin >	in_relations,
		String	in_rankdir
	)		[private]

This method generates the label that applies to a given join between two tables.

Parameters:

in_relations	List of relations included in the join.
in_rankdir	Initial orientation of a record node. Values can be: TB (Top to bottom) LR (Left to right) RL 'Right to left)

See GRAPHVIZ' documentation for "rankdir": http://www.graphviz.org/doc/info/shapes.html

Returns:

The method returns the DOT's representation of the join.

Definition at line 311 of file DotFull.java.

Referenced by org.dbview.databaseExporters.dot.DotFull.export().

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

(

int

in_table_to_table_relation_type

)

throws Exception [protected, inherited]

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().

String org.dbview.databaseExporters.dot.DotFull.export

(

Hashtable< String, Object >

in_options

)

throws Exception [virtual]

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

Parameters:

in_options

Options. Options may be: "layout"

Returns:

The method returns a string that represents the Graphviz representation.

Exceptions:

Exception

Implements org.dbview.databaseExporters.dot.AbstractDatabaseExporter.

Definition at line 64 of file DotFull.java.

---

Member Data Documentation

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

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, inherited]

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/DotFull.java