DBVIEW
org.dbview.utils.dot.SubGraph Class Reference
Collaboration diagram for org.dbview.utils.dot.SubGraph:

List of all members.

Public Member Functions

void addEdge (Edge in_edge)
 SubGraph (String in_name)
void setStyle (String in_style)
void setBackgroundColor (String in_color)
void setLabel (String in_label)
void setNodeStyle (String in_style)
void setNodeColor (String in_color)
void addNode (Node in_node)
String toString ()

Static Public Member Functions

static String generateName (String in_name)

Private Attributes

String __name = null
String __style = null
String __background_color = null
String __label = null
String __node_style = null
String __node_color = null
ArrayList< Node__nodes = new ArrayList<Node>()
ArrayList< Edge__edges = new ArrayList<Edge>()

Detailed Description

This class represents sub graphs.

Author:
Denis Beurive

Definition at line 31 of file SubGraph.java.


Constructor & Destructor Documentation

org.dbview.utils.dot.SubGraph.SubGraph ( String  in_name)

Create a sub graph.

Parameters:
in_nameFriendly name of the sub graph.
Note:
Please note that spaces are replaced by "_".

Definition at line 95 of file SubGraph.java.


Member Function Documentation

void org.dbview.utils.dot.SubGraph.addEdge ( Edge  in_edge)

Add an edge to the subgraph.

Parameters:
in_edgeEdge to add.

Definition at line 77 of file SubGraph.java.

void org.dbview.utils.dot.SubGraph.addNode ( Node  in_node)

Add a node to the sub graph.

Parameters:
in_nodeNode to add to the sub graph.

Definition at line 134 of file SubGraph.java.

static String org.dbview.utils.dot.SubGraph.generateName ( String  in_name) [static]

Create a unique, and valid (no spaces...), name for the sub graph.

Parameters:
in_nameOriginal name.
Returns:
The method returns a unique name.
Exceptions:
Exception

Definition at line 85 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.SubGraph().

void org.dbview.utils.dot.SubGraph.setBackgroundColor ( String  in_color)

Set the background color of the sub graph.

Parameters:
in_colorThe color that must be applied to the background.

Definition at line 110 of file SubGraph.java.

void org.dbview.utils.dot.SubGraph.setLabel ( String  in_label)

Set the label of the sub graph (this is the title).

Parameters:
in_labelThe label to set.

Definition at line 116 of file SubGraph.java.

void org.dbview.utils.dot.SubGraph.setNodeColor ( String  in_color)

Set the background color of all nodes within the sub graph.

Parameters:
in_colorBackground color of all nodes within the sub graph.

Definition at line 128 of file SubGraph.java.

void org.dbview.utils.dot.SubGraph.setNodeStyle ( String  in_style)

Set the style of all nodes within the sub graph.

Parameters:
in_styleName of the style to apply to all nodes.

Definition at line 122 of file SubGraph.java.

void org.dbview.utils.dot.SubGraph.setStyle ( String  in_style)

Set the style of the sub graph.

Parameters:
in_styleName of the style to apply.

Definition at line 104 of file SubGraph.java.

String org.dbview.utils.dot.SubGraph.toString ( )

The method returns the DOT's name of a sub graph, given its friendly name.

Parameters:
in_nameFriendly name of the sub graph.
Returns:
The method returns the DOT's name of the sub graph. Return a string that represents this graph.
The method returns a string that represents this graph.

Definition at line 147 of file SubGraph.java.


Member Data Documentation

Background color for the sub graph.

Definition at line 46 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.setBackgroundColor(), and org.dbview.utils.dot.SubGraph.toString().

ArrayList<Edge> org.dbview.utils.dot.SubGraph.__edges = new ArrayList<Edge>() [private]

The list of edges.

Definition at line 71 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.addEdge(), and org.dbview.utils.dot.SubGraph.toString().

String org.dbview.utils.dot.SubGraph.__label = null [private]

Sub graph's label.

Definition at line 51 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.setLabel(), and org.dbview.utils.dot.SubGraph.toString().

String org.dbview.utils.dot.SubGraph.__name = null [private]

Name of the sub graph.

Definition at line 36 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.SubGraph(), and org.dbview.utils.dot.SubGraph.toString().

Background color of all nodes within the sub graph.

Definition at line 61 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.setNodeColor(), and org.dbview.utils.dot.SubGraph.toString().

Style of all nodes within the sub graph.

Definition at line 56 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.setNodeStyle(), and org.dbview.utils.dot.SubGraph.toString().

ArrayList<Node> org.dbview.utils.dot.SubGraph.__nodes = new ArrayList<Node>() [private]

List of nodes within the sub graph.

Definition at line 66 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.addNode(), and org.dbview.utils.dot.SubGraph.toString().

String org.dbview.utils.dot.SubGraph.__style = null [private]

Style of the sub graph.

Definition at line 41 of file SubGraph.java.

Referenced by org.dbview.utils.dot.SubGraph.setStyle(), and org.dbview.utils.dot.SubGraph.toString().


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