1 GraphML
Class Ax.graph.GraphML
GraphML is an XML-based file format for graphs. This class lets you use it to generate an ER diagram of a db.
Constructor Summary
| Method | Description |
|---|---|
| JSGraphML(JSConnection conn) | Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram. |
| JSGraphML(JSConnection conn, String bgcolor) | Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram; with the specified background color |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| JSGraphML | addGroup(String name, String bgcolor, String[] tables) | Adds a new group to the graph, composed of the specified tables and with the chosen background color. |
| void | setShowTableColumns(boolean show) | Enables or diasbles the table columns in the graph nodes (tables of the db). |
| void | setShowTableStatistics(boolean show) | Enables or diasbles the table statistics in the graph nodes (tables of the db). |
| String | toString() | Returns the XML document defining the GraphML. |
Method Detail
JSGraphML
-
JSGraphML(JSConnection conn)
- Info:
-
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram. - Parameters:
- conn - connection to get metadata
JSGraphML
-
JSGraphML(JSConnection conn, String bgcolor)
- Info:
-
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram; with the specified background color - Parameters:
- conn - connection to get metadata
- bgcolor - background color
addGroup
-
JSGraphML addGroup(String name, String bgcolor, String[] tables) - Info:
-
Adds a new group to the graph, composed of the specified tables and with the chosen background color. - Parameters:
- name - name of the new group
- bgcolor - background color of the group
- tables - tables to ad to the group
- Returns:
- same object with the group added
setShowTableColumns
-
void setShowTableColumns(boolean show)
- Info:
-
Enables or diasbles the table columns in the graph nodes (tables of the db). - Parameters:
- show - true to show columns, false to hide them
setShowTableStatistics
-
void setShowTableStatistics(boolean show)
- Info:
-
Enables or diasbles the table statistics in the graph nodes (tables of the db). - Parameters:
- show - true to show statistics, false to hide them
toString
-
String toString() - Info:
-
Returns the XML document defining the GraphML. - Returns:
2 GraphViz
Class Ax.graph.GraphViz
Wrapper for server GraphViz processor.
Graphviz (short for Graph Visualization Software) is a package of open-source tools initiated by AT
Constructor Summary
| Method | Description |
|---|---|
| JSGraphViz(String dot) | Creates a new instance of the GraphViz microservice. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| boolean | isReady() | Checks if the GraphViz microservice is ready. |
| boolean | isReady(boolean forceOnlineCheck) | Checks if the GraphViz microservice is ready. |
| boolean | isReady(MicroserviceType arg0) | |
| boolean | isReady(MicroserviceType arg0, boolean arg1) | |
| String | toFOP() | Transforms the graph to a FO document. |
| String | toSVG() | Transforms the graph to SVG format. |
Method Detail
JSGraphViz
-
JSGraphViz(String dot)
- Info:
-
Creates a new instance of the GraphViz microservice. - Parameters:
- dot - DOT language script specifying the graph.
isReady
-
boolean isReady()
- Info:
-
Checks if the GraphViz microservice is ready. - Returns:
isReady
-
boolean isReady(boolean forceOnlineCheck)
- Info:
-
Checks if the GraphViz microservice is ready. - Parameters:
- forceOnlineCheck - to disable or force whether the server is reachable
- Returns:
isReady
-
boolean isReady(MicroserviceType arg0)
- Parameters:
- arg0 -
- Returns:
isReady
-
boolean isReady(MicroserviceType arg0, boolean arg1)
- Parameters:
- arg0 -
- arg1 -
- Returns:
toFOP
-
String toFOP() - Info:
-
Transforms the graph to a FO document. - Returns:
- String containing the resulting FO document in XML
toSVG
-
String toSVG() - Info:
-
Transforms the graph to SVG format. - Returns:
- String containing graph in SVG format
3 Ditaa
Class Ax.graph.Ditaa
Wrapper for server DITAA processor.
Ditaa (Diagrams Through Ascii Art).
Constructor Summary
| Method | Description |
|---|---|
| JSDitaa(String diagram) | Creates a new DITAA graph specified by the diagram. |
Method Summary
| Modifier and Type | Method | Description |
|---|---|---|
| byte[] | toPNG() | Returns the graph as a PNG image. |
Method Detail
JSDitaa
-
JSDitaa(String diagram)
- Info:
-
Creates a new DITAA graph specified by the diagram. - Parameters:
- diagram - diagram representing the graph
toPNG
-
byte[] toPNG()
- Info:
-
Returns the graph as a PNG image. - Returns:
- byte array containing the graph as a PNG