Data model visualization #4739 by Ki10V01T · Pull Request #5004 · jmix-framework/jmix

Ki10V01T · 2025-12-29T17:33:30Z

Unimplemented features: 1. Permissions for view 2. Download button 3. Mermaid 4. Separation by Data store 5. JavaDocs 6. Locales

2. Locales creation is completed (need to check) 3. DataStore verification has been completed, no edits are required.

2. Displaying system entities ability has been added 3. Is nullable, Is mandatory fields has been centered 4. Similar to Base64 algorithm encoding for PlantUML has been added

…ng filter filed input (need to discuss) 2. Search by like 3. RegExp support for search 4. Displaying intermediate tables for many-to-many relationships (LINKED_TABLE.LINKED_COLUMN) 5. Timeouts for ping diagram server

Ki10V01T · 2025-12-29T17:35:36Z

Known issues:

I had to implement details and hide the textField inside it to make the urlQueryParameter facet work correctly. This caused the markup to shift (this needs to be discussed).
Flex-grow for the Is Nullable and Is Mandatory columns doesn't work. Because of this, they are slightly wider than necessary.

glebfox · 2025-12-30T07:46:25Z

jmix-translations/content/io/jmix/datatools/messages.properties

+
+io.jmix.datatools.datamodel.app/EngineType=Engine type
+io.jmix.datatools.datamodel.app/EngineType.MERMAID=Mermaid
+io.jmix.datatools.datamodel.app/EngineType.PLANTUML=Plantuml


Looks like it's called PlantUML

glebfox · 2025-12-30T07:46:56Z

jmix-translations/content/io/jmix/datatools/messages_ru.properties

+io.jmix.datatools.datamodel.entity/AttributeModel=Модель атрибутов
+io.jmix.datatools.datamodel.entity/AttributeModel.attributeName=Название атрибута
+io.jmix.datatools.datamodel.entity/AttributeModel.columnName=Название колонки
+io.jmix.datatools.datamodel.entity/AttributeModel.dbType=БД тип


Тип БД

glebfox · 2025-12-30T07:49:41Z

jmix-translations/content/io/jmix/datatools/messages_ru.properties

+io.jmix.datatools.datamodel.entity/AttributeModel.javaType=Java тип
+
+io.jmix.datatools.datamodel.entity/EntityModel.attributes=Атрибуты
+io.jmix.datatools.datamodel.entity/EntityModel.id=Идентификатор


Usually, ID doesn't require translation.

glebfox · 2025-12-30T07:50:32Z

jmix-translations/content/io/jmix/datatools/messages_ru.properties

+io.jmix.datatools.datamodel.entity/AttributeModel.dbType=БД тип
+io.jmix.datatools.datamodel.entity/AttributeModel.id=Идентификатор
+io.jmix.datatools.datamodel.entity/AttributeModel.isMandatory=Обязательный?
+io.jmix.datatools.datamodel.entity/AttributeModel.isNullable=Нулевой?


Any other options for translation?

glebfox · 2025-12-30T08:03:46Z

jmix-datatools/datatools/src/main/java/io/jmix/datatools/datamodel/entity/package-info.java

+ * limitations under the License.
+ */
+
+@NonNullApi


No need for entity package, because you can get/set nulls for any attribute.

glebfox · 2025-12-30T09:09:14Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+        }
+
+        dataModelManager.setFilteredModels(entityModelsDl.getContainer().getItems());
+        UI.getCurrent().getPage().open("datatl/data-diagram");


Add a comment, that you use UI.getCurrent().getPage().open intentionally to open a new browser tab.

May need some delegate here so that a TabbedMode can open a new application tab instead.

As for the DataTools add-on, everything is ready. All that remains is to implement mutual support from the private repository.

glebfox · 2025-12-30T09:10:09Z

...datatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/DataModelListView.java

+        try {
+            pattern = Pattern.compile(userInput, Pattern.CASE_INSENSITIVE);
+        } catch (PatternSyntaxException pse) {
+            entityNameFilter.setErrorMessage("Regular expression syntax is invalid");


MUST be a localized message!

glebfox · 2025-12-30T09:10:16Z

...datatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/DataModelListView.java

+
+    protected void applyLoadContextWithFiltering(List<String> findedEntityNames) {
+        if (findedEntityNames.isEmpty()) {
+            entityNameFilter.setErrorMessage("Entities not found");


MUST be a localized message!

glebfox · 2025-12-30T09:11:04Z

...ls-flowui/src/main/resources/io/jmix/datatoolsflowui/view/datamodel/data-model-list-view.xml

@@ -0,0 +1,75 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<view xmlns="http://jmix.io/schema/flowui/view"


Something went wrong:

glebfox · 2025-12-30T09:21:57Z

...ls-flowui/src/main/resources/io/jmix/datatoolsflowui/view/datamodel/data-model-list-view.xml

+    <layout alignItems="STRETCH"
+            expand="contentBox"
+            classNames="jmix-data-model-list-view-layout">
+            <hbox id="buttonsPanel" classNames="buttons-panel">


I still think that the Search button is redundant.

<details> is unnecessary complication and breaks layout (see the screenshot above). A simple placeholder will do the trick + you have tooltip for detailed info.

2. Flex-grow has been fixed

… of the search button

…ould appear when rendering a diagram

glebfox · 2026-01-30T09:22:33Z

jmix-translations/content/io/jmix/datatools/messages.properties

+
+io.jmix.datatools.datamodel.app/EngineType=Engine type
+io.jmix.datatools.datamodel.app/EngineType.MERMAID=Mermaid
+io.jmix.datatools.datamodel.app/EngineType.PLANTUML=Plantuml


glebfox · 2026-01-30T09:29:09Z

jmix-datatools/datatools/src/main/java/io/jmix/datatools/datamodel/engine/PlantUMLEncoder.java

+ * in a Base64-like format for further sending as a URL parameter
 */
-public interface TransferProgressNotifier {
+public interface PlantUMLEncoder {


PlantUmlEncoder

glebfox · 2026-01-30T09:34:06Z

jmix-datatools/datatools/src/main/java/io/jmix/datatools/datamodel/engine/PlantUMLEncoder.java


-    Registration addTransferProgressListener(TransferProgressListener listener);
+    /**
+     * Provides encoding in a base64-like format


Format JavaDoc (everywhere).

Missing blank line before params

Missing dots

See: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

glebfox · 2026-01-30T09:40:34Z

jmix-datatools/datatools/src/main/java/io/jmix/datatools/datamodel/entity/package-info.java

+ * limitations under the License.
+ */
+
+@Internal


Internal looks redundunt.

glebfox · 2026-01-30T09:41:16Z

...ols/datatools/src/main/java/io/jmix/datatools/datamodel/engine/impl/PlantUMLEncoderImpl.java

+
+import java.nio.charset.StandardCharsets;
+
+public class PlantUMLEncoderImpl implements PlantUMLEncoder {


PlantUmlEncoderImpl

glebfox · 2026-01-30T10:41:34Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+    }
+
+    @Subscribe("entityModelsDataGrid")
+    public void onEntityModelsDataGridItemClick(final ItemClickEvent<EntityModel> event) {


DataGrid provides the Selection listener. You must use it instead. Currently removing selection doesn't clear attributes

glebfox · 2026-01-30T10:43:08Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+        }
+    }
+
+    private class EntityNameUrlQueryParametersBinder extends AbstractUrlQueryParametersBinder {


System checkbox also must be included into URL query params

glebfox · 2026-01-30T10:44:31Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+    @Subscribe
+    public void onInit(final InitEvent event) {
+        entityNameFilterQueryParameters.registerBinder(new EntityNameUrlQueryParametersBinder());
+        setDataStoreNames();


dataStoreNames can be initialized in the load delegate, before they are used

glebfox · 2026-01-30T10:47:48Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+    }
+
+    @Subscribe("entityNameFilter")
+    public void onEntityNameFilterComponentValueChange(final AbstractField.ComponentValueChangeEvent<TypedTextField<String>, String> event) {


It's better to subscribe to `TypedValueChange``

Strings.isNullOrEmpty(event.getValue())

glebfox · 2026-01-30T10:49:26Z

...tatools-flowui/src/main/java/io/jmix/datatoolsflowui/view/datamodel/EntityModelListView.java

+    protected void initEntityNameFilterTooltip() {
+        JmixButton helperButton = createHelperButton();
+        Tooltip tooltip = entityNameFilter.getTooltip();
+        helperButton.addClickListener(e -> tooltip.setOpened(!tooltip.isOpened()));


Still unclear why we handle button clicks if tooltip is shown by hover

Dmitry Panov added 4 commits December 18, 2025 00:09

Data model visualization task completed.

f1a4e07

Unimplemented features: 1. Permissions for view 2. Download button 3. Mermaid 4. Separation by Data store 5. JavaDocs 6. Locales

1. Download button has been removed

2984df4

2. Locales creation is completed (need to check) 3. DataStore verification has been completed, no edits are required.

1. Facets implementing has been started

20536ba

2. Displaying system entities ability has been added 3. Is nullable, Is mandatory fields has been centered 4. Similar to Base64 algorithm encoding for PlantUML has been added

Ki10V01T requested review from Gavrilov-Ivan, glebfox and knstvk December 29, 2025 17:33

Ki10V01T self-assigned this Dec 29, 2025

Ki10V01T added the in: datatools label Dec 29, 2025

glebfox requested changes Dec 30, 2025

View reviewed changes

Dmitry Panov added 5 commits December 30, 2025 13:16

1. Details has been removed from View

2c98305

2. Flex-grow has been fixed

Implement all changes except the tabbed mode delegate and the removal…

8d9444d

… of the search button

Changing the logic of determining of entity systemicity

182e619

Tabbed mod 1/2 support has been added

cd9dfe4

Fix for a potential bug when working with multiple dataStore s that c…

2b83c5f

…ould appear when rendering a diagram

glebfox requested changes Jan 30, 2026

View reviewed changes

Ki10V01T removed their assignment Jan 31, 2026

		@@ -0,0 +1,75 @@
		<?xml version="1.0" encoding="UTF-8" standalone="no"?>
		<view xmlns="http://jmix.io/schema/flowui/view"


		import java.nio.charset.StandardCharsets;

		public class PlantUMLEncoderImpl implements PlantUMLEncoder {

Conversation

Ki10V01T commented Dec 29, 2025

Uh oh!

Ki10V01T commented Dec 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants