Implement custom bean validation annotations #3 (#8)

Author: glebfox

.DS_Store

@@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 - Support sorting `LocalizedString` values by the user's current locale.
 - Configuration properties to disable the add-on sorting customizations.
+- Bean Validation annotations for `LocalizedString` values, including locale-aware not-null validation.
 
 ### Changed
 

CHANGELOG.md

@@ -134,6 +134,26 @@ If the target `ValuePicker` of `LocalizedStringEditAction` is bound to a require
 
 ![Required Field](/doc/img/required-field.png)
 
+The add-on provides Bean Validation annotations for `LocalizedString` attributes:
+
+* `@LocalizedStringSize`
+* `@LocalizedStringLength`
+* `@LocalizedStringPattern`
+* `@LocalizedStringNotNull`
+* `@LocalizedStringNotEmpty`
+* `@LocalizedStringNotBlank`
+
+For example:
+
+```java
+@LocalizedStringNotBlank
+@LocalizedStringSize(max = 100)
+@Column(name = "NAME")
+private LocalizedString name;
+```
+
+Every stored localized value is validated. `@LocalizedStringNotNull` also checks that a value is stored for every configured application locale. When the edit dialog is used for an entity attribute, these constraints are applied to each locale field separately. Standard `@NotNull` can still be used for the attribute itself when only the `LocalizedString` object reference should be checked.
+
 Additionally, you can add a validator that checks the value of every field in the edit dialog. For example:
 
 ```java

README.md

@@ -17,6 +17,9 @@
 package com.glebfox.jmix.locstr.demo.entity;
 
 import com.glebfox.jmix.locstr.datatype.LocalizedString;
+import com.glebfox.jmix.locstr.validation.constraints.LocalizedStringNotBlank;
+import com.glebfox.jmix.locstr.validation.constraints.LocalizedStringNotNull;
+import com.glebfox.jmix.locstr.validation.constraints.LocalizedStringPattern;
 import io.jmix.core.entity.annotation.JmixGeneratedValue;
 import io.jmix.core.metamodel.annotation.InstanceName;
 import io.jmix.core.metamodel.annotation.JmixEntity;
@@ -34,11 +37,14 @@ public class Product {
     @Id
     private UUID id;
 
+    @LocalizedStringPattern(regexp = "^[a-zA-Z0-9а-яА-Я \\t\\r\\f-]+$")
     @InstanceName
     @Column(name = "NAME", nullable = false)
     @NotNull
+    @LocalizedStringNotNull
     private LocalizedString name;
 
+    @LocalizedStringNotBlank
     @Lob
     @Column(name = "DESCRIPTION")
     private LocalizedString description;

jmix-localized-string-datatype-demo/src/main/java/com/glebfox/jmix/locstr/demo/entity/Product.java

@@ -17,12 +17,11 @@
 package com.glebfox.jmix.locstr.action;
 
 import com.glebfox.jmix.locstr.datatype.LocalizedString;
+import com.glebfox.jmix.locstr.validation.BeanValidatorAdapter;
 import com.glebfox.jmix.locstr.validation.Validator;
 import com.glebfox.jmix.locstr.validation.ValidatorAdapter;
 import com.google.common.base.Preconditions;
 import com.google.common.base.Strings;
-import com.google.common.cache.Cache;
-import com.google.common.cache.CacheBuilder;
 import com.vaadin.flow.component.*;
 import com.vaadin.flow.component.button.Button;
 import com.vaadin.flow.component.button.ButtonVariant;
@@ -37,7 +36,10 @@
 import com.vaadin.flow.shared.Registration;
 import io.jmix.core.CoreProperties;
 import io.jmix.core.MessageTools;
+import io.jmix.core.MetadataTools;
 import io.jmix.core.Messages;
+import io.jmix.core.entity.KeyValueEntity;
+import io.jmix.core.metamodel.model.MetaClass;
 import io.jmix.core.metamodel.model.MetaProperty;
 import io.jmix.core.metamodel.model.MetaPropertyPath;
 import io.jmix.flowui.Dialogs;
@@ -49,6 +51,7 @@
 import io.jmix.flowui.component.PickerComponent;
 import io.jmix.flowui.component.SupportsValidation;
 import io.jmix.flowui.component.UiComponentUtils;
+import io.jmix.flowui.component.validation.bean.BeanPropertyValidator;
 import io.jmix.flowui.data.EntityValueSource;
 import io.jmix.flowui.data.ValueSource;
 import io.jmix.flowui.kit.action.ActionVariant;
@@ -78,13 +81,14 @@ public class LocalizedStringEditAction
     protected Messages messages;
     protected UiComponents uiComponents;
     protected MessageTools messageTools;
+    protected MetadataTools metadataTools;
 
     protected Dialog dialog;
     protected Button saveButton;
     protected Button cancelButton;
 
     protected LinkedHashMap<Locale, String> availableLocales;
-    protected Cache<Locale, HasValueAndElement<?, String>> fieldCache;
+    protected Map<Locale, HasValueAndElement<?, String>> fields = new LinkedHashMap<>();
     protected List<Validator> validators;
 
     protected Boolean multiline;
@@ -145,6 +149,11 @@ public void setMessageTools(MessageTools messageTools) {
         this.messageTools = messageTools;
     }
 
+    @Autowired
+    public void setMetadataTools(MetadataTools metadataTools) {
+        this.metadataTools = metadataTools;
+    }
+
     @Autowired
     public void setDialogs(Dialogs dialogs) {
         this.dialogs = dialogs;
@@ -177,9 +186,9 @@ public boolean isMultiline() {
      *
      * @param multiline {@code true} to use a multi-line text
      *                  input component, {@code false} otherwise
-     * @apiNote this setting is applied before the first time the edit
-     * dialog is opened, as fields are cached. {@link TextArea} is used
-     * for multi-line text input, {@link TextField} otherwise
+     * @apiNote this setting is applied when the edit dialog is opened.
+     * {@link TextArea} is requested from {@link UiComponents} for
+     * multi-line text input, {@link TextField} otherwise
      */
     public void setMultiline(boolean multiline) {
         this.multiline = multiline;
@@ -192,9 +201,9 @@ public void setMultiline(boolean multiline) {
      * @param multiline {@code true} to use a multi-line text
      *                  input component, {@code false} otherwise
      * @return this object
-     * @apiNote this setting is applied before the first time the edit
-     * dialog is opened, as fields are cached. {@link TextArea} is used
-     * for multi-line text input, {@link TextField} otherwise
+     * @apiNote this setting is applied when the edit dialog is opened.
+     * {@link TextArea} is requested from {@link UiComponents} for
+     * multi-line text input, {@link TextField} otherwise
      */
     public LocalizedStringEditAction withMultiline(boolean multiline) {
         setMultiline(multiline);
@@ -786,10 +795,9 @@ public LocalizedStringEditAction withFieldProvider(
     public void execute() {
         checkTarget();
 
-        // Fields are not recreated because they are cached, but
-        // they are correctly initialized with new values
         dialog.removeAll();
         dialog.add(createContent());
+        updateSaveButtonState();
 
         // Clear flag after content is created because fields are
         // initialized with a default value
@@ -846,8 +854,7 @@ protected void addButtonClickShortcut(Button button, Key key, KeyModifier... key
     }
 
     protected void doSave(ClickEvent<Button> event) {
-        Map<Locale, String> localizedValues = getFields().asMap()
-                .entrySet().stream()
+        Map<Locale, String> localizedValues = getFields().entrySet().stream()
                 .collect(Collectors.toMap(Map.Entry::getKey,
                         entry -> entry.getValue().getValue())
                 );
@@ -892,6 +899,7 @@ protected Component createContent() {
         layout.setAlignItems(FlexComponent.Alignment.STRETCH);
         layout.setClassName("localized-string-editor-content");
 
+        fields = new LinkedHashMap<>();
         availableLocales.keySet().stream()
                 .map(locale -> ((Component) getField(locale)))
                 .forEach(layout::add);
@@ -900,12 +908,8 @@ protected Component createContent() {
     }
 
     protected HasValueAndElement<?, String> getField(Locale locale) {
-        HasValueAndElement<?, String> field = getFields().getIfPresent(locale);
-        if (field == null) {
-            field = createField(locale);
-            getFields().put(locale, field);
-        }
-
+        HasValueAndElement<?, String> field = createField(locale);
+        getFields().put(locale, field);
         field.setValue(getInitialValue(locale));
         return field;
     }
@@ -944,20 +948,21 @@ protected void initField(HasValueAndElement<?, String> field,
         }
 
         initRequired(field, metaPropertyPath);
-        initValidators(field, locale);
+        initValidators(field, locale, metaPropertyPath);
     }
 
     protected void onFieldInvalidChanged(PropertyChangeEvent propertyChangeEvent) {
-        saveButton.setEnabled(!hasInvalidFields());
+        updateSaveButtonState();
     }
 
-    protected boolean hasInvalidFields() {
-        return getFields().asMap().entrySet()
+    protected void updateSaveButtonState() {
+        boolean hasInvalidFields = getFields().entrySet()
                 .stream()
                 .anyMatch(entry ->
                         entry.getValue() instanceof HasValidation hasValidation
                                 && hasValidation.isInvalid()
                 );
+        saveButton.setEnabled(!hasInvalidFields);
     }
 
     protected void initMultilineField(HasValueAndElement<?, String> field) {
@@ -971,7 +976,6 @@ protected void initMultilineField(HasValueAndElement<?, String> field) {
     @Nullable
     protected MetaPropertyPath findMetaPropertyPath() {
         ValueSource<LocalizedString> valueSource = target.getValueSource();
-        MetaPropertyPath metaPropertyPath = null;
         return valueSource instanceof EntityValueSource<?, ?> entityValueSource
                 ? entityValueSource.getMetaPropertyPath()
                 : null;
@@ -1024,28 +1028,52 @@ protected void initRequired(HasValueAndElement<?, String> field,
     }
 
     @SuppressWarnings("unchecked")
-    protected void initValidators(HasValueAndElement<?, String> field, Locale locale) {
+    protected void initValidators(HasValueAndElement<?, String> field,
+                                  Locale locale,
+                                  @Nullable MetaPropertyPath metaPropertyPath) {
+        if (field instanceof SupportsValidation<?>) {
+            initBeanValidator((SupportsValidation<String>) field, metaPropertyPath);
+        }
+
         if (validators != null
-                && field instanceof SupportsValidation) {
+                && field instanceof SupportsValidation<?>) {
             validators.forEach(validator ->
                     ((SupportsValidation<String>) field).addValidator(new ValidatorAdapter(validator, locale)));
         }
     }
 
+    protected void initBeanValidator(SupportsValidation<String> field,
+                                     @Nullable MetaPropertyPath metaPropertyPath) {
+        if (metaPropertyPath == null) {
+            return;
+        }
+
+        MetaClass enclosingMetaClass = metadataTools.getPropertyEnclosingMetaClass(metaPropertyPath);
+        Class<?> enclosingJavaClass = enclosingMetaClass.getJavaClass();
+        if (enclosingJavaClass == KeyValueEntity.class) {
+            return;
+        }
+
+        MetaProperty metaProperty = metaPropertyPath.getMetaProperty();
+        if (!LocalizedString.class.isAssignableFrom(metaProperty.getJavaType())) {
+            return;
+        }
+
+        BeanPropertyValidator beanPropertyValidator = applicationContext.getBean(
+                BeanPropertyValidator.class,
+                enclosingJavaClass,
+                metaProperty.getName());
+        field.addValidator(new BeanValidatorAdapter(beanPropertyValidator, availableLocales.keySet()));
+    }
+
     @SuppressWarnings("unchecked")
     protected String getInitialValue(Locale locale) {
         LocalizedString localizedString = ((HasValue<?, LocalizedString>) target).getValue();
         return localizedString != null ? localizedString.getValue(locale) : "";
     }
 
-    protected Cache<Locale, HasValueAndElement<?, String>> getFields() {
-        if (fieldCache == null) {
-            fieldCache = CacheBuilder.newBuilder()
-                    .maximumSize(availableLocales.size())
-                    .build();
-        }
-
-        return fieldCache;
+    protected Map<Locale, HasValueAndElement<?, String>> getFields() {
+        return fields;
     }
 
     protected boolean isMac() {

jmix-localized-string-datatype/src/main/java/com/glebfox/jmix/locstr/action/LocalizedStringEditAction.java

@@ -21,6 +21,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import java.io.Serializable;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
@@ -40,6 +41,15 @@ public String getValue(Locale locale) {
         return values.getOrDefault(locale, "");
     }
 
+    /**
+     * Returns all stored localized values.
+     *
+     * @return unmodifiable map of locale to localized value
+     */
+    public Map<Locale, String> getValues() {
+        return Collections.unmodifiableMap(values);
+    }
+
     public String toJson() {
         try {
             return new ObjectMapper().writeValueAsString(values);

jmix-localized-string-datatype/src/main/java/com/glebfox/jmix/locstr/datatype/LocalizedString.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2024 Gleb Gorelov.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.glebfox.jmix.locstr.validation;
+
+import com.glebfox.jmix.locstr.datatype.LocalizedString;
+import io.jmix.flowui.component.validation.bean.BeanPropertyValidator;
+import org.springframework.lang.Nullable;
+
+import java.util.Collection;
+import java.util.LinkedHashMap;
+import java.util.Locale;
+import java.util.Map;
+
+public record BeanValidatorAdapter(BeanPropertyValidator validator, Collection<Locale> locales)
+        implements io.jmix.flowui.component.validation.Validator<String> {
+
+    @Override
+    public void accept(@Nullable String value) {
+        Map<Locale, String> values = new LinkedHashMap<>();
+        locales.forEach(locale -> values.put(locale, value));
+
+        validator.accept(new LocalizedString(values));
+    }
+}