Changeset 5545

Timestamp:

08/08/14 14:35:42 (10 years ago)

Author:

Twan Goosen

Message:

Completed the pre-publication validator. Created tests. Tweaked the confirmation dialogue in case of warnings.
Fixes #607

Location:

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src

Files:

• main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/Application.properties (modified) (1 diff)
• main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/dialog/ConfirmationDialog.java (modified) (1 diff)
• main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BrowseEditableCollectionsPanel.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/virtualcollectionregistry/service/impl/ReferenceValidator.java (modified) (1 diff)
• main/java/eu/clarin/cmdi/virtualcollectionregistry/service/impl/VirtualCollectionPrePublicationValidator.java (modified) (3 diffs)
• main/webapp/css/vcr.css (modified) (2 diffs)
• test/java/eu/clarin/cmdi/virtualcollectionregistry/service/impl/VirtualCollectionPrePublicationValidatorTest.java (added)

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/Application.properties

@@ -26 +26 @@
   change!
 collections.publishwarningsconfirm: WARNING: The collection "${name}" does not \
-  meet all recommended criteria. The following warnings apply:\n {0}\n\
-  Would you still like to publish the collection?
-
+  meet all recommended criteria for published collection!\n\n\
+  The following warning(s) apply:\n{0}\n\
+  Publication of the collection in its current state is not recommended. Would \
+  you still like to publish the collection?

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/dialog/ConfirmationDialog.java

@@ -90 +90 @@
 
     @Override
-    protected Content createContent(String id) {
+    protected Panel createContent(String id) {
         Content content = new Content(id);
-        content.add(new AttributeAppender("class",
-                new Model<String>("confirmationDialog"), " "));
+        content.add(new AttributeAppender("class", getCssClass(), " "));
         return content;
+    }
+
+    protected Model<String> getCssClass() {
+        return Model.of("confirmationDialog");
     }
 

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/BrowseEditableCollectionsPanel.java

@@ -224 +224 @@
         public void showDialogue(AjaxRequestTarget target, IModel<VirtualCollection> vc, List<String> warnings) {
             this.vcId = vc.getObject().getId();
+            StringBuilder sb = new StringBuilder();
+            for (String warning : warnings) {
+                sb.append(" -").append(warning).append("\n");
+            }
             super.show(target,
-                    new StringResourceModel("collections.publishwarningsconfirm", vc, new Object[]{warnings}));
+                    new StringResourceModel("collections.publishwarningsconfirm", vc, new Object[]{sb}));
+        }
+
+        @Override
+        protected Model<String> getCssClass() {
+            return Model.of("longConfirmationDialog");
         }
 
@@ -319 +328 @@
         editPublishedDialog = new EditPublishedCollectionDialog("editPublishedCollectionDialog", table);
         add(editPublishedDialog);
-        
+
         confirmPublishCollectionDialog = new ConfirmPublishCollectionDialog("confirmPublishCollectionDialog", table);
         add(confirmPublishCollectionDialog);

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/service/impl/ReferenceValidator.java

@@ -54 +54 @@
         return validatable.isValid();
     }
+    
+    public static boolean isPid(CharSequence uri) {
+        return HANDLE_PATTERN.matcher(uri).matches();
+    }
 
 }

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/service/impl/VirtualCollectionPrePublicationValidator.java

@@ -18 +18 @@
 
 import eu.clarin.cmdi.virtualcollectionregistry.VirtualCollectionRegistryUsageException;
+import eu.clarin.cmdi.virtualcollectionregistry.model.Resource;
 import eu.clarin.cmdi.virtualcollectionregistry.model.VirtualCollection;
 import eu.clarin.cmdi.virtualcollectionregistry.service.VirtualCollectionValidator;
+import java.util.ArrayList;
+import java.util.List;
+import org.apache.wicket.util.string.Strings;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.stereotype.Service;
@@ -25 +29 @@
 /**
  * A virtual collection validator performing "soft" validation that should occur
- * before publication.
+ * before publication. Validated collections are <em>assumed</em> to be valid
+ * according to the 'minimal' validator applied on creation and update of the
+ * collection.
  *
  * @author twagoo
@@ -32 +38 @@
 @Qualifier("publication-soft")
 public class VirtualCollectionPrePublicationValidator implements VirtualCollectionValidator {
-    
+
     @Override
     public void validate(VirtualCollection vc) throws VirtualCollectionRegistryUsageException {
-//        throw new VirtualCollectionRegistryUsageException("Test", Arrays.asList("First warning", "Second warning", "Third warning"));
+        final List<String> warnings = new ArrayList<>();
+
+        switch (vc.getType()) {
+            case EXTENSIONAL:
+                validateResources(vc, warnings);
+                break;
+            case INTENSIONAL:
+                validateGeneratedBy(vc, warnings);
+                break;
+        }
+
+        if (Strings.isEmpty(vc.getDescription())) {
+            warnings.add("The collection has no description");
+        }
+
+        if (vc.getPurpose() == null) {
+            warnings.add("The purpose has not been specified");
+        }
+
+        if (vc.getPurpose() == VirtualCollection.Purpose.FUTURE_USE) {
+            warnings.add("The reproducibility of the collection has been marked 'future use'");
+        }
+
+        if (vc.getReproducibility() == null) {
+            warnings.add("The degree of reproducibility has not been specified");
+        }
+
+        if (vc.getCreators().isEmpty()) {
+            warnings.add("No creators have been specified for the collection");
+        }
+
+        if (!warnings.isEmpty()) {
+            throw new VirtualCollectionRegistryUsageException("Collection is not fit for publication", warnings);
+        }
     }
-    
+
+    private void validateResources(VirtualCollection vc, List<String> warnings) {
+        int nonPidCount = 0;
+        for (Resource resource : vc.getResources()) {
+            if (!ReferenceValidator.isPid(resource.getRef())) {
+                nonPidCount++;
+            }
+        }
+        if (nonPidCount == 0) {
+            return;
+        }
+
+        if (nonPidCount == 1) {
+            warnings.add(String.format("One resource is not referenced through a persistent identifier", nonPidCount));
+        } else {
+            warnings.add(String.format("%d resources are not referenced through a persistent identifier", nonPidCount));
+        }
+    }
+
+    private void validateGeneratedBy(VirtualCollection vc, List<String> warnings) {
+        final String queryUri = vc.getGeneratedBy().getURI();
+        if (!ReferenceValidator.isPid(queryUri)) {
+            warnings.add("The query URI is not a persistent identifer");
+        }
+    }
+
 }

VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/webapp/css/vcr.css

@@ -550 +550 @@
 }
 
+div.modalDialog div.modalDialogContent p {
+    margin: 1em;
+}
+
 div.modalDialog div.modalDialogButtons {
     border-top: 1px solid #BBBBBB;
@@ -559 +563 @@
 div.confirmationDialog {
     text-align: center;
+}
+
+div.longConfirmationDialog {
+    text-align: left;
 }