Namespace: Consultingwerk.BusinessEntityDesigner.Common.Plugins
Class 
AbstractMermaidDiagramPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Common.Plugins.AbstractMermaidDiagramPlugin

Inherits: Progress.Lang.Object
Inherited by: Consultingwerk.BusinessEntityDesigner.Plugins.MermaidDiagramPlugin Consultingwerk.BusinessEntityDesigner.Server.Plugins.MermaidDiagramServerPlugin
ABSTRACT


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AfterGenerateSourceHandler (Object, EventArgs) Event handler for the AfterGenerateSource / AfterRegenerateSource events
LONGCHAR BuildMermaidBody () Generates the content of the Mermaid diagram for the Business Entity
BuildRelations (longchar) Iterates over all relations in the Business Entity and generates the Mermaid code for the diagram
CHARACTER FindOutputFolder () Finds the source folder of the Business Entity Dataset
GenerateMermaidDiagram () Generates a Mermaid diagram for the Business Entity
CHARACTER GetBusinessEntityFullName () Determines the full (qualified) name of the currently generated Business Entity
CHARACTER GetCardinality (character, character) Returns the cardinality of a relation
CHARACTER GetIndexFlags (rowid) Returns a string describing the flags of the index
CHARACTER MapDataType (character, integer) Maps a data type from the Business Entity Designer to a data type that can be used in a Mermaid diagram
ShutdownInternal () Uninitializes the plugin instance and unsubscribes from events
StartupInternal (IBusinessEntityDatasetController) Initializes the plugin instance and subscribes to required events


Method Detail
Top

AfterGenerateSourceHandler (Object, EventArgs)
Purpose: Event handler for the AfterGenerateSource / AfterRegenerateSource events
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

LONGCHAR BuildMermaidBody ()
Purpose: Generates the content of the Mermaid diagram for the Business Entity
Notes: Finds all tables and their fields and generates the Mermaid code for the diagram
Generates the Mermaid code for the relations between tables

Returns LONGCHAR
The content of the Mermaid diagram as a long character string
Top

BuildRelations (longchar)
Purpose: Iterates over all relations in the Business Entity and generates
the Mermaid code for the diagram
Notes: Called by the BuildMermaidContent method

Parameters:
plcContent LONGCHAR
The content of the Mermaid diagram as a long character string
Top

CHARACTER FindOutputFolder ()
Purpose: Finds the source folder of the Business Entity Dataset
Notes: Falls back to the current folder if the source folder is not specified

Returns CHARACTER
The path to the source folder
Top

GenerateMermaidDiagram ()
Purpose: Generates a Mermaid diagram for the Business Entity
Notes:
Finds the Business Entity and constructs the diagram from its tables and fields
Replaces placeholders in the template with the actual values and writes the diagram to a file

Top

CHARACTER GetBusinessEntityFullName ()
Purpose: Determines the full (qualified) name of the currently generated Business Entity
Notes:

Returns CHARACTER
Qualified class name
Top

CHARACTER GetCardinality (character, character)
Purpose: Returns the cardinality of a relation
Notes: Called by the BuildRelations method

Parameters:
pcChildTable CHARACTER
The name of the child table
pcFields CHARACTER
The fields in the relation
Returns CHARACTER
The cardinality of the relation
Top

CHARACTER GetIndexFlags (rowid)
Purpose: Returns a string describing the flags of the index
Notes: Called by the BuildMermaidContent method
"none" if the index has no flags
"primary" if the index is primary
"unique" if the index is unique
"primary, unique" if the index is both primary and unique

Parameters:
prIndex ROWID
The rowid of the index
Returns CHARACTER
A string describing the flags of the index
Top

CHARACTER MapDataType (character, integer)
Purpose: Maps a data type from the Business Entity Designer to a data type that can be used in a Mermaid diagram
Notes: Called by the BuildMermaidContent method

Parameters:
pcType CHARACTER
The data type as a string
piExtent INTEGER
The extent value of the field
Returns CHARACTER
The mapped data type, formatted for Mermaid
Top

ShutdownInternal ()
Purpose: Uninitializes the plugin instance and unsubscribes from events
Notes: Called by derived classes from their Shutdown method

Top

StartupInternal (IBusinessEntityDatasetController)
Purpose: Initializes the plugin instance and subscribes to required events
Notes: Called by derived classes from their Startup method

Parameters:
poController Consultingwerk.BusinessEntityDesigner.Common.IBusinessEntityDatasetController
The reference to the Business Entity Dataset Controller


Temp-Table Detail


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:03:03