Closes #2554: Generalize Suggestion box to support controlled vocabul…

…ary values (#2555) Co-authored-by: Filipe Dias Lewandowski Signed-off-by: Daniel Korbel <[email protected]> Co-authored-by: Sylwester Niewczas <[email protected]> Co-authored-by: Krzysztof Mądry <[email protected]>
CeON · Sep 25, 2024 · 2eb0ad6 · 2eb0ad6
1 parent 2e81850
commit 2eb0ad6
Show file tree

Hide file tree

Showing 19 changed files with 402 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -34,3 +34,31 @@ Dataverse is a trademark of President and Fellows of Harvard College and is regi
 [chat.dataverse.org]: http://chat.dataverse.org
 [Dataverse Community Meeting]: https://dataverse.org/events
 [open source]: LICENSE.md
+
+
+# Running integration tests
+
+All tests:
+
+```bash
+./mvnw verify
+```
+
+Single test:
+
+```bash
+./mvnw verify -Dit.test=UserNotificationRepositoryIT -pl dataverse-persistence
+```
+
+
+Integration test dependencies can be started manually in order to execute integration tests through the IDE:
+
+```bash
+./mvnw docker:start -Dtest.solr.port=8984 -pl dataverse-webapp
+```
+
+Once started, all the integration tests can be run through the IDE. When finished, containers can be stopped with:
+
+```bash
+./mvnw docker:stop -pl dataverse-webapp
+```
diff --git a/dataverse-persistence/src/main/resources/Bundle_en.properties b/dataverse-persistence/src/main/resources/Bundle_en.properties
@@ -3108,4 +3108,5 @@ geobox.invalid.longitude=The longitude must be a number between -180 and 180.
 geobox.invalid.latitude=The latitude must be a number between -90 and 90.
 geobox.invalid.latitude.relation=The north latitude must be greater or equal to the south latitude.
 
-validation.nonunique=The field must have a unique value.
+validation.nonunique=The field must have a unique value.
+validation.value.not.allowed.in.controlled.vocabulary=Value "{0}" is not allowed. Please select one from the list.
diff --git a/dataverse-persistence/src/main/resources/Bundle_pl.properties b/dataverse-persistence/src/main/resources/Bundle_pl.properties
@@ -3059,4 +3059,5 @@ geobox.invalid.longitude=D\u0142ugo\u015B\u0107 geograficzna musi zawiera\u0107
 geobox.invalid.latitude=Szeroko\u015B\u0107 geograficzna musi zawiera\u0107 si\u0119 mi\u0119dzy -90 a 90.
 geobox.invalid.latitude.relation=Szeroko\u015B\u0107 p\u00F3\u0142nocna musi by\u0107 nie mniejsza od po\u0142udniowej.
 
-validation.nonunique=Pole musi mie\u0107 tylko jedn\u0105 warto\u015B\u0107.
+validation.nonunique=Pole musi mie\u0107 tylko jedn\u0105 warto\u015B\u0107.
+validation.value.not.allowed.in.controlled.vocabulary=Warto\u015B\u0107 "{0}" jest niedozwolona. Wybierz jedn\u0105 z listy.
diff --git a/...e-webapp/src/main/java/edu/harvard/iq/dataverse/ControlledVocabularyValueServiceBean.java b/...e-webapp/src/main/java/edu/harvard/iq/dataverse/ControlledVocabularyValueServiceBean.java
@@ -30,4 +30,16 @@ public List<ControlledVocabularyValue> findByDatasetFieldTypeId(Long dsftId) {
         return query.getResultList();
 
     }
+    public List<ControlledVocabularyValue> findByDatasetFieldTypeNameAndValueLike(String datasetFieldTypeName, String suggestionSourceFieldValue, int queryLimit) {
+
+        String queryString = "select DISTINCT v from ControlledVocabularyValue as v " +
+                "where UPPER(v.strValue) LIKE CONCAT('%', UPPER(:suggestionSourceFieldValue), '%') " +
+                "and v.datasetFieldType.id = (select d.id from DatasetFieldType as d where d.name = :datasetFieldTypeName)";
+        TypedQuery<ControlledVocabularyValue> query = em.createQuery(queryString, ControlledVocabularyValue.class);
+        query.setParameter("suggestionSourceFieldValue", suggestionSourceFieldValue);
+        query.setParameter("datasetFieldTypeName", datasetFieldTypeName);
+        query.setMaxResults(queryLimit);
+        query.setHint("eclipselink.QUERY_RESULTS_CACHE", "TRUE");
+        return query.getResultList();
+    }
 }
diff --git a/...edu/harvard/iq/dataverse/dataset/metadata/inputRenderer/SuggestionInputFieldRenderer.java b/...edu/harvard/iq/dataverse/dataset/metadata/inputRenderer/SuggestionInputFieldRenderer.java
@@ -120,8 +120,11 @@ public List<Suggestion> createSuggestions(DatasetField datasetField, String quer
         Map<String, String> suggestionFilteredFields = new HashMap<>();
 
         if (!datasetFieldTypeToSuggestionFilterMapping.isEmpty()) {
-
-            suggestionFilteredFields = findFilterValues(datasetField, datasetFieldTypeToSuggestionFilterMapping);
+            if(suggestionHandler.isDependentOnSiblings()) {
+                suggestionFilteredFields = findFilterValuesInSiblings(datasetField, datasetFieldTypeToSuggestionFilterMapping);
+            } else {
+                suggestionFilteredFields = getFilterValue(datasetField, datasetFieldTypeToSuggestionFilterMapping);
+            }
 
             if (suggestionFilteredFields.isEmpty()){
                 return new ArrayList<>();
@@ -133,7 +136,15 @@ public List<Suggestion> createSuggestions(DatasetField datasetField, String quer
 
     // -------------------- PRIVATE --------------------
 
-    private Map<String, String> findFilterValues(DatasetField datasetField, Map<String, String> datasetFieldTypeToSuggestionFilterMapping) {
+    /**
+     * In this scenario we are using indirectly value from datasetFieldTypeToSuggestionFilterMapping
+     * which comes from datasetField configuration.
+     * This value is used indirectly to filter out suggestions.
+     * This value is the name of other siblings datasetField in datasetField group,
+     * that shares common parent. Method loops over all siblings to find out
+     * the one that have corresponding name, then its value is used to filter out suggestions.
+     */
+    private Map<String, String> findFilterValuesInSiblings(DatasetField datasetField, Map<String, String> datasetFieldTypeToSuggestionFilterMapping) {
         Map<String, String> filteredValues = datasetField.getDatasetFieldParent()
                 .getOrElseThrow(() -> new NullPointerException("datasetfield with type: " + datasetField.getTypeName() + " didn't have any parent required to generate suggestions"))
                 .getDatasetFieldsChildren().stream()
@@ -146,4 +157,22 @@ private Map<String, String> findFilterValues(DatasetField datasetField, Map<Stri
         return filteredValues.containsValue(StringUtils.EMPTY) ? new HashMap<>() : filteredValues;
     }
 
+    /**
+     * In this scenario we are using directly value from datasetFieldTypeToSuggestionFilterMapping
+     * which comes from datasetField configuration.
+     * This value is used directly to filter out suggestions.
+     */
+    private Map<String, String> getFilterValue(DatasetField datasetField, Map<String, String> datasetFieldTypeToSuggestionFilterMapping) {
+        return datasetFieldTypeToSuggestionFilterMapping
+                .entrySet()
+                .stream()
+                .filter(entry -> entry.getKey().equalsIgnoreCase(datasetField.getTypeName()))
+                .findFirst()
+                .map(entry -> {
+                    Map<String, String> filterValues = new HashMap<>();
+                    filterValues.put(entry.getValue(), entry.getKey());
+                    return filterValues;
+                })
+                .orElseGet(HashMap::new);
+    }
 }
diff --git a/...erse/dataset/metadata/inputRenderer/suggestion/ControlledVocabularySuggestionHandler.java b/...erse/dataset/metadata/inputRenderer/suggestion/ControlledVocabularySuggestionHandler.java
@@ -0,0 +1,74 @@
+package edu.harvard.iq.dataverse.dataset.metadata.inputRenderer.suggestion;
+
+import com.google.common.collect.Lists;
+import edu.harvard.iq.dataverse.ControlledVocabularyValueServiceBean;
+import edu.harvard.iq.dataverse.dataset.metadata.inputRenderer.Suggestion;
+
+import javax.ejb.Stateless;
+import javax.inject.Inject;
+import java.util.List;
+import java.util.Map;
+
+import static java.util.stream.Collectors.toList;
+
+/**
+ * This suggestion handler provides suggestions based on controlled vocabulary values.
+ */
+@Stateless
+public class ControlledVocabularySuggestionHandler implements SuggestionHandler {
+
+    public static final String CONTROLLED_VOCABULARY_NAME_COLUMN = "controlledVocabularyName";
+    private ControlledVocabularyValueServiceBean controlledVocabularyValueServiceBean;
+
+    // -------------------- CONSTRUCTORS --------------------
+
+    @Deprecated
+    public ControlledVocabularySuggestionHandler() {
+    }
+
+    @Inject
+    public ControlledVocabularySuggestionHandler(ControlledVocabularyValueServiceBean controlledVocabularyValueServiceBean) {
+        this.controlledVocabularyValueServiceBean = controlledVocabularyValueServiceBean;
+    }
+
+    // -------------------- LOGIC --------------------
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * This implementation always returns class name.
+     */
+    @Override
+    public String getName() {
+        return getClass().getSimpleName();
+    }
+
+
+    /**
+     * This is not dependent on siblings input values. All values will be taken
+     * to build matching suggestions list.
+     */
+    @Override
+    public boolean isDependentOnSiblings() {
+        return false;
+    }
+
+    /**
+     * {@inheritDoc}
+     * <p>
+     * This implementation filers out base on controlled vocabulary (input) name,
+     * a.k.a. dictionary name
+     */
+    @Override
+    public List<String> getAllowedFilters() {
+        return Lists.newArrayList(CONTROLLED_VOCABULARY_NAME_COLUMN);
+    }
+
+    @Override
+    public List<Suggestion> generateSuggestions(Map<String, String> filters, String suggestionSourceFieldValue) {
+        return controlledVocabularyValueServiceBean
+                .findByDatasetFieldTypeNameAndValueLike(filters.get(CONTROLLED_VOCABULARY_NAME_COLUMN), suggestionSourceFieldValue, 10)
+                .stream().map(vocabulary -> new Suggestion(vocabulary.getStrValue(), vocabulary.getIdentifier()))
+                .collect(toList());
+    }
+}
diff --git a/...averse/dataset/metadata/inputRenderer/suggestion/GrantAgencyAcronymSuggestionHandler.java b/...averse/dataset/metadata/inputRenderer/suggestion/GrantAgencyAcronymSuggestionHandler.java
@@ -40,6 +40,17 @@ public String getName() {
         return getClass().getSimpleName();
     }
 
+    /**
+     * This suggestion is dependent on sibling input value.
+     * Only values that match pointed out sibling input value will be taken
+     * to create suggestion.
+     * @see this#getAllowedFilters()
+     */
+    @Override
+    public boolean isDependentOnSiblings() {
+        return !getAllowedFilters().isEmpty();
+    }
+
     /**
      * {@inheritDoc}
      * <p>

diff --git a/.../iq/dataverse/dataset/metadata/inputRenderer/suggestion/GrantAgencySuggestionHandler.java b/.../iq/dataverse/dataset/metadata/inputRenderer/suggestion/GrantAgencySuggestionHandler.java
@@ -40,6 +40,15 @@ public String getName() {
         return getClass().getSimpleName();
     }
 
+    /**
+     * This suggestion is not dependent on siblings.
+     * All values will be taken to mach the suggestion string.
+     */
+    @Override
+    public boolean isDependentOnSiblings() {
+        return !getAllowedFilters().isEmpty();
+    }
+
     /**
      * {@inheritDoc}
      * <p>

diff --git a/...iq/dataverse/dataset/metadata/inputRenderer/suggestion/GrantProgramSuggestionHandler.java b/...iq/dataverse/dataset/metadata/inputRenderer/suggestion/GrantProgramSuggestionHandler.java
@@ -3,12 +3,10 @@
 import com.google.common.collect.Lists;
 import edu.harvard.iq.dataverse.dataset.metadata.inputRenderer.Suggestion;
 import edu.harvard.iq.dataverse.persistence.dataset.suggestion.GrantSuggestion;
-import edu.harvard.iq.dataverse.persistence.dataset.suggestion.GrantSuggestions;
 
 import javax.ejb.Stateless;
 import javax.inject.Inject;
 
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -42,6 +40,17 @@ public String getName() {
         return getClass().getSimpleName();
     }
 
+    /**
+     * This suggestion is dependent on sibling input value.
+     * Only values that match pointed out sibling input value will be taken
+     * to create suggestion.
+     * @see this#getAllowedFilters()
+     */
+    @Override
+    public boolean isDependentOnSiblings() {
+        return !getAllowedFilters().isEmpty();
+    }
+
     /**
      * {@inheritDoc}
      * <p>

diff --git a/.../harvard/iq/dataverse/dataset/metadata/inputRenderer/suggestion/RorSuggestionHandler.java b/.../harvard/iq/dataverse/dataset/metadata/inputRenderer/suggestion/RorSuggestionHandler.java
@@ -35,6 +35,17 @@ public String getName() {
         return getClass().getSimpleName();
     }
 
+    /**
+     * This suggestion is dependent on sibling input value.
+     * Only values that match pointed out sibling input value will be taken
+     * to create suggestion.
+     * @see this#getAllowedFilters()
+     */
+    @Override
+    public boolean isDependentOnSiblings() {
+        return !getAllowedFilters().isEmpty();
+    }
+
     /**
      * {@inheritDoc}
      * <p>

diff --git a/...edu/harvard/iq/dataverse/dataset/metadata/inputRenderer/suggestion/SuggestionHandler.java b/...edu/harvard/iq/dataverse/dataset/metadata/inputRenderer/suggestion/SuggestionHandler.java
@@ -12,6 +12,20 @@ public interface SuggestionHandler {
      */
     String getName();
 
+    /**
+     * @return true if this handler is dependent on siblings input values.
+     * If it is dependant it will use other input values
+     * to filter out while generating suggestions.
+     * Sibling means the group of inputs that shares common parent input.
+     * F.e.: when input grant is parent and have children as follow: grantAgency,
+     * grantRor, grantAcronym it means that whenever one of its children will have value
+     * it will be taken to filter out values during generating suggestions.
+     * Of course its need to be configured via <code>getAllowedFilters() method</code>
+     *
+     * @see this#getAllowedFilters()
+     */
+    boolean isDependentOnSiblings();
+
     /**
      * Returns name of filters that this handler understands
      * and can handle.

diff --git a/...a/edu/harvard/iq/dataverse/validation/field/validators/ControlledVocabularyValidator.java b/...a/edu/harvard/iq/dataverse/validation/field/validators/ControlledVocabularyValidator.java
@@ -0,0 +1,53 @@
+package edu.harvard.iq.dataverse.validation.field.validators;
+
+import edu.harvard.iq.dataverse.ControlledVocabularyValueServiceBean;
+import edu.harvard.iq.dataverse.common.BundleUtil;
+import edu.harvard.iq.dataverse.persistence.dataset.ControlledVocabularyValue;
+import edu.harvard.iq.dataverse.persistence.dataset.ValidatableField;
+import edu.harvard.iq.dataverse.validation.field.FieldValidationResult;
+import org.omnifaces.cdi.Eager;
+
+import javax.enterprise.context.ApplicationScoped;
+import javax.inject.Inject;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Validator for fields that should only contain values from a controlled vocabulary.
+ * The vocabulary is passed in through the parameters.
+ */
+@Eager
+@ApplicationScoped
+public class ControlledVocabularyValidator extends MultiValueValidatorBase {
+
+    @Inject
+    private ControlledVocabularyValueServiceBean vocabularyDao;
+
+    // -------------------- LOGIC --------------------
+
+    @Override
+    public String getName() {
+        return "controlled_vocabulary_validator";
+    }
+
+    @Override
+    public FieldValidationResult validateValue
+            (String value,
+             ValidatableField field,
+             Map<String, Object> params,
+             Map<String, ? extends List<? extends ValidatableField>> fieldIndex) {
+
+        List<ControlledVocabularyValue> matchesFromDb =
+                vocabularyDao.findByDatasetFieldTypeNameAndValueLike(
+                field.getDatasetFieldType().getName(), value, 1
+        );
+        if(matchesFromDb.size() == 1 && matchesFromDb.get(0).getStrValue().equalsIgnoreCase(value)) {
+            return FieldValidationResult.ok();
+        } else {
+            return FieldValidationResult.invalid(
+                    field,
+                    BundleUtil.getStringFromBundle("validation.value.not.allowed.in.controlled.vocabulary", value)
+            );
+        }
+    }
+}
diff --git a/...vard/iq/dataverse/validation/field/validators/RequiredByValueDependantFieldValidator.java b/...vard/iq/dataverse/validation/field/validators/RequiredByValueDependantFieldValidator.java
@@ -26,8 +26,6 @@
  * @see edu.harvard.iq.dataverse.persistence.dataset.ValidatableField
  * @see edu.harvard.iq.dataverse.persistence.dataset.DatasetField
  * @see edu.harvard.iq.dataverse.persistence.dataset.DatasetFieldType#getValidation()
- *
- * @author Filipe Dias Lewandowski, Krzysztof Mądry, Daniel Korbel, Sylwester Niewczas
  */
 @Eager
 @ApplicationScoped

diff --git a/...edu/harvard/iq/dataverse/validation/field/validators/RequiredDependantFieldValidator.java b/...edu/harvard/iq/dataverse/validation/field/validators/RequiredDependantFieldValidator.java
@@ -28,8 +28,6 @@
  * @see edu.harvard.iq.dataverse.persistence.dataset.ValidatableField
  * @see edu.harvard.iq.dataverse.persistence.dataset.DatasetField
  * @see edu.harvard.iq.dataverse.persistence.dataset.DatasetFieldType#getValidation()
- *
- * @author Filipe Dias Lewandowski, Krzysztof Mądry, Daniel Korbel, Sylwester Niewczas
  */
 @Eager
 @ApplicationScoped