Changeset 5204

Timestamp:

05/16/14 14:46:30 (10 years ago)

Author:

Oliver Schonefeld

Message:

• a first stab at checking the persistent identifiers (use -p to enable)

Location:

CMDIValidator/trunk

Files:

• pom.xml (modified) (1 diff)
• src/main/java/eu/clarin/cmdi/validator/CMDIValidationPlugin.java (added)
• src/main/java/eu/clarin/cmdi/validator/CMDIValidationPluginFactory.java (added)
• src/main/java/eu/clarin/cmdi/validator/CMDIValidator.java (modified) (6 diffs)
• src/main/java/eu/clarin/cmdi/validator/CMDIValidatorFactory.java (modified) (4 diffs)
• src/main/java/eu/clarin/cmdi/validator/CMDIValidatorResultImpl.java (modified) (4 diffs)
• src/main/java/eu/clarin/cmdi/validator/plugins (added)
• src/main/java/eu/clarin/cmdi/validator/plugins/CheckPidPluginFactory.java (added)
• src/main/java/eu/clarin/cmdi/validator/tool/CMDIValidatorTool.java (modified) (9 diffs)
• src/main/java/eu/clarin/cmdi/validator/utils (added)
• src/main/java/eu/clarin/cmdi/validator/utils/LRUCache.java (added)

CMDIValidator/trunk/pom.xml

@@ -4 +4 @@
         <groupId>eu.clarin.cmdi</groupId>
         <artifactId>cmdi-validator</artifactId>
-        <version>0.0.1-SNAPSHOT</version>
+        <version>0.0.2-SNAPSHOT</version>
 
         <properties>

CMDIValidator/trunk/src/main/java/eu/clarin/cmdi/validator/CMDIValidator.java

@@ -4 +4 @@
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.LinkedHashMap;
 import java.util.LinkedHashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
@@ -49 +49 @@
 
 import eu.clarin.cmdi.validator.CMDIValidatorResult.Severity;
+import eu.clarin.cmdi.validator.utils.LRUCache;
 
 
@@ -83 +84 @@
     private final XML11Configuration config;
     private final DocumentBuilder builder;
+    private final List<CMDIValidationPlugin> plugins;
     private final CMDIValidatorResultImpl result;
 
 
-    CMDIValidator(final Processor processor, final SchemaLoader schemaLoader,
-            XsltExecutable schematronExecutable)
+    CMDIValidator(final Processor processor,
+            final SchemaLoader schemaLoader,
+            XsltExecutable schematronExecutable,
+            List<CMDIValidationPlugin> plugins)
             throws CMDIValidatorInitException {
         if (processor == null) {
@@ -215 +219 @@
 
             /*
+             * initialize plugins
+             */
+            if ((plugins != null) && !plugins.isEmpty()) {
+                this.plugins = plugins;
+            } else {
+                this.plugins = null;
+            }
+
+            /*
              * initialize other stuff
              */
@@ -238 +251 @@
             final XdmNode document = parseInstance(stream);
 
-            /*
-             * step 2: perform Schematron validation
-             */
             if (document != null) {
+                /*
+                 * step 2: perform Schematron validation
+                 */
                 if (schematronValidator != null) {
                     validateSchematron(document);
+                }
+
+                /*
+                 * step 3: run plugins, if any
+                 */
+                if (plugins != null) {
+                    for (CMDIValidationPlugin plugin : plugins) {
+                        plugin.validate(document, result);
+                    }
                 }
             } else {
@@ -501 +523 @@
     }  // class ShadowCacheGrammarPool
 
-
-    @SuppressWarnings("serial")
-    private static class LRUCache<A, B> extends LinkedHashMap<A, B> {
-        private final int maxEntries;
-
-
-        public LRUCache(final int maxEntries) {
-            super(maxEntries + 1, 1.0f, true);
-            this.maxEntries = maxEntries;
-        }
-
-
-        @Override
-        protected boolean removeEldestEntry(final Map.Entry<A, B> eldest) {
-            return super.size() > maxEntries;
-        }
-    } // class LRUCache
-
 } // class CMDIValidator

CMDIValidator/trunk/src/main/java/eu/clarin/cmdi/validator/CMDIValidatorFactory.java

@@ -4 +4 @@
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
 
 import javax.xml.transform.stream.StreamSource;
@@ -35 +37 @@
     private final SchemaLoader schemaLoader;
     private final XsltExecutable schematronValidator;
-
+    private final List<CMDIValidationPluginFactory> pluginFactories;
 
     private CMDIValidatorFactory(File cacheDirectory,
-            File schematronSchemaFile, boolean disableSchematron)
+            File schematronSchemaFile, boolean disableSchematron,
+            List<CMDIValidationPluginFactory> pluginFactories)
             throws CMDIValidatorInitException {
         /*
@@ -151 +154 @@
             this.schematronValidator = null;
         }
+
+        /*
+         * store pluginFactories
+         */
+        if ((pluginFactories != null) && !pluginFactories.isEmpty()) {
+            this.pluginFactories = pluginFactories;
+        } else {
+            this.pluginFactories = null;
+        }
     }
 
 
     public CMDIValidator newValidator() throws CMDIValidatorInitException {
-        return new CMDIValidator(processor, schemaLoader, schematronValidator);
+        List<CMDIValidationPlugin> plugins = null;
+        if (pluginFactories != null) {
+            plugins = new ArrayList<CMDIValidationPlugin>(pluginFactories.size());
+            for (CMDIValidationPluginFactory pluginFactory : pluginFactories) {
+                plugins.add(pluginFactory.newInstance(processor));
+            }
+        }
+
+        return new CMDIValidator(processor, schemaLoader,
+                schematronValidator, plugins);
     }
 
 
     public static CMDIValidatorFactory newInstance(File cacheDircetory,
-            File schematronSchemaFile, boolean disableSchematron)
-            throws CMDIValidatorInitException {
-        return new CMDIValidatorFactory(cacheDircetory, schematronSchemaFile,
-                disableSchematron);
+            File schematronSchemaFile,
+            boolean disableSchematron,
+            List<CMDIValidationPluginFactory> pluginFactories)
+            throws CMDIValidatorInitException {
+        return new CMDIValidatorFactory(cacheDircetory,
+                schematronSchemaFile,
+                disableSchematron,
+                pluginFactories);
     }
 
@@ -169 +194 @@
     public static CMDIValidatorFactory newInstance()
             throws CMDIValidatorInitException {
-        return new CMDIValidatorFactory(null, null, false);
+        return new CMDIValidatorFactory(null, null, false, null);
     }
 

CMDIValidator/trunk/src/main/java/eu/clarin/cmdi/validator/CMDIValidatorResultImpl.java

@@ -7 +7 @@
 
 
-final class CMDIValidatorResultImpl implements CMDIValidatorResult {
+public final class CMDIValidatorResultImpl implements CMDIValidatorResult {
     private static class MessageImpl implements CMDIValidatorResult.Message {
         private Severity severity;
@@ -147 +147 @@
 
 
-    void setFile(File file) {
-        this.file = file;
-    }
-
-
-    void reportInfo(int line, int col, String message) {
+    public void reportInfo(int line, int col, String message) {
         reportInfo(line, col, message, null);
     }
 
 
-    void reportInfo(int line, int col, String message, Throwable cause) {
+    public void reportInfo(int line, int col, String message, Throwable cause) {
         entries.add(new MessageImpl(Severity.INFO, line, col, message, cause));
     }
 
 
-    void reportWarning(int line, int col, String message) {
+    public void reportWarning(int line, int col, String message) {
         reportWarning(line, col, message, null);
     }
 
 
-    void reportWarning(int line, int col, String message, Throwable cause) {
+    public void reportWarning(int line, int col, String message, Throwable cause) {
         switch (highestSeverity) {
         case WARNING:
@@ -180 +175 @@
 
 
-    void reportError(int line, int col, String message) {
+    public void reportError(int line, int col, String message) {
         reportError(line, col, message, null);
     }
 
 
-    void reportError(int line, int col, String message, Throwable cause) {
+    public void reportError(int line, int col, String message, Throwable cause) {
         switch (highestSeverity) {
         case ERROR:
@@ -196 +191 @@
 
 
+    void setFile(File file) {
+        this.file = file;
+    }
+
+
     void reset() {
         this.entries.clear();

CMDIValidator/trunk/src/main/java/eu/clarin/cmdi/validator/tool/CMDIValidatorTool.java

@@ -5 +5 @@
 import java.io.File;
 import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Locale;
 import java.util.concurrent.TimeUnit;
@@ -11 +13 @@
 import net.java.truevfs.access.TVFS;
 import net.java.truevfs.kernel.spec.FsSyncException;
-
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.CommandLineParser;
@@ -23 +24 @@
 import org.slf4j.LoggerFactory;
 
+import eu.clarin.cmdi.validator.CMDIValidationPluginFactory;
 import eu.clarin.cmdi.validator.CMDIValidator;
 import eu.clarin.cmdi.validator.CMDIValidatorEngine;
@@ -32 +34 @@
 import eu.clarin.cmdi.validator.CMDIValidatorResult.Message;
 import eu.clarin.cmdi.validator.CMDIValidatorResult.Severity;
+import eu.clarin.cmdi.validator.plugins.CheckPidPluginFactory;
 
 
@@ -48 +51 @@
     private static final char OPT_NO_SCHEMATRON         = 'S';
     private static final char OPT_SCHEMATRON_FILE       = 's';
+    private static final char OPT_CHECK_PIDS            = 'p';
     private static final Logger logger =
             LoggerFactory.getLogger(CMDIValidatorTool.class);
@@ -66 +70 @@
         boolean disableSchematron = false;
         File schematronFile       = null;
+        boolean checkPids         = false;
 
         /*
@@ -136 +141 @@
                 }
                 schematronFile = new File(name);
+            }
+            if (line.hasOption(OPT_CHECK_PIDS)) {
+                checkPids = true;
             }
 
@@ -170 +178 @@
                     logger.info("using Schematron schema from file: {}", schematronFile);
                 }
+
+                List<CMDIValidationPluginFactory> pluginFactories =
+                        new ArrayList<CMDIValidationPluginFactory>();
+                if (checkPids) {
+                    logger.info("performing PID checking");
+                    pluginFactories.add(new CheckPidPluginFactory());
+                }
+
                 final CMDIValidatorFactory factory =
                         CMDIValidatorFactory.newInstance(schemaCacheDir,
-                                schematronFile, disableSchematron);
+                                schematronFile,
+                                disableSchematron,
+                                pluginFactories);
 
                 /*
@@ -360 +378 @@
                 .create(OPT_SCHEMATRON_FILE));
         options.addOptionGroup(g3);
+        options.addOption(OptionBuilder
+                .withDescription("check if persistent identifiers resolve correctly")
+                .withLongOpt("check-pids")
+                .create(OPT_CHECK_PIDS));
         return options;
     }