Merge pull request #22 from phax/diver110

Diver110

phive-api/pom.xml

@@ -22,7 +22,7 @@
   <parent>
     <groupId>com.helger.phive</groupId>
     <artifactId>phive-parent-pom</artifactId>
-    <version>9.0.1-SNAPSHOT</version>
+    <version>9.1.0-SNAPSHOT</version>
   </parent>
   <artifactId>phive-api</artifactId>
   <packaging>bundle</packaging>

phive-result/pom.xml

@@ -22,7 +22,7 @@
   <parent>
     <groupId>com.helger.phive</groupId>
     <artifactId>phive-parent-pom</artifactId>
-    <version>9.0.1-SNAPSHOT</version>
+    <version>9.1.0-SNAPSHOT</version>
   </parent>
   <artifactId>phive-result</artifactId>
   <packaging>bundle</packaging>

phive-ves-engine/pom.xml

@@ -22,7 +22,7 @@
   <parent>
     <groupId>com.helger.phive</groupId>
     <artifactId>phive-parent-pom</artifactId>
-    <version>9.0.1-SNAPSHOT</version>
+    <version>9.1.0-SNAPSHOT</version>
   </parent>
   <artifactId>phive-ves-engine</artifactId>
   <packaging>bundle</packaging>

phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/DefaultVESLoaderSchematron.java

@@ -44,14 +44,17 @@
  */
 public class DefaultVESLoaderSchematron implements IVESLoaderSchematron
 {
+  public static final String RESOURCE_TYPE_SCH = "sch";
+  public static final String RESOURCE_TYPE_XSLT = "xslt";
+
   private static final Logger LOGGER = LoggerFactory.getLogger (DefaultVESLoaderSchematron.class);
 
   @Nonnull
   public IValidationExecutor <IValidationSourceXML> loadSchematron (@Nonnull final IRepoStorageBase aRepo,
                                                                     @Nonnull final VesSchematronType aSCH,
                                                                     @Nonnull final ErrorList aErrorList)
   {
-    final RepoStorageKey aSCHKey = VESLoader.wrapKey (aSCH.getResource ());
+    final RepoStorageKey aSCHKey = VESLoader.createRepoStorageKey (aSCH.getResource ());
 
     // Read referenced Item
     final RepoStorageItem aSCHItem = aRepo.read (aSCHKey);
@@ -74,7 +77,7 @@ public IValidationExecutor <IValidationSourceXML> loadSchematron (@Nonnull final
     final String sResourceType = aSCH.getResource ().getType ();
     switch (sResourceType)
     {
-      case "sch":
+      case RESOURCE_TYPE_SCH:
       {
         // Resolve Schematron Engine
         final String sEngine = aSCH.getEngine ();
@@ -110,7 +113,7 @@ public IValidationExecutor <IValidationSourceXML> loadSchematron (@Nonnull final
         }
         break;
       }
-      case "xslt":
+      case RESOURCE_TYPE_XSLT:
       {
         // Indicate a potential error
         if (StringHelper.hasText (aSCH.getEngine ()))

phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/DefaultVESLoaderXSD.java

@@ -23,6 +23,7 @@
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import javax.annotation.concurrent.Immutable;
 import javax.xml.validation.Schema;
 
 import org.slf4j.Logger;
@@ -42,6 +43,7 @@
 import com.helger.commons.io.resource.IReadableResource;
 import com.helger.commons.io.resource.inmemory.ReadableResourceInputStream;
 import com.helger.commons.io.stream.NonBlockingByteArrayOutputStream;
+import com.helger.commons.lang.EnumHelper;
 import com.helger.commons.string.StringHelper;
 import com.helger.commons.string.ToStringGenerator;
 import com.helger.diver.repo.IRepoStorageBase;
@@ -68,25 +70,49 @@
  */
 public class DefaultVESLoaderXSD implements IVESLoaderXSD
 {
+  public static final String RESOURCE_TYPE_ZIP = "zip";
+  public static final String RESOURCE_TYPE_XSD = "xsd";
+
   private static final Logger LOGGER = LoggerFactory.getLogger (DefaultVESLoaderXSD.class);
 
   /**
    * Catalog entry type
    *
    * @author Philip Helger
    */
-  private enum ECatalogType
+  public enum ECatalogType implements IHasID <String>
   {
-    PUBLIC,
-    SYSTEM
+    PUBLIC ("public"),
+    SYSTEM ("system");
+
+    private final String m_sID;
+
+    ECatalogType (@Nonnull @Nonempty final String sID)
+    {
+      m_sID = sID;
+    }
+
+    @Nonnull
+    @Nonempty
+    public String getID ()
+    {
+      return m_sID;
+    }
+
+    @Nullable
+    public static ECatalogType getFromIDOrNull (@Nullable final String sID)
+    {
+      return EnumHelper.getFromIDOrNull (ECatalogType.class, sID);
+    }
   }
 
   /**
    * Represent a single XML catalog entry
    *
    * @author Philip Helger
    */
-  private static final class CatalogEntry implements IHasID <String>
+  @Immutable
+  public static final class CatalogEntry implements IHasID <String>
   {
     private final ECatalogType m_eType;
     private final String m_sID;
@@ -136,12 +162,13 @@ public String toString ()
   @Nullable
   private static final String _unifyPath (@Nullable final String x)
   {
+    // Converty any "\" to "/"
     String ret = FilenameHelper.getPathUsingUnixSeparator (x);
     if (ret != null)
     {
       // Make absolute to simply LS resource resolving
       if (!ret.startsWith ("/"))
-        ret = "/" + ret;
+        ret = '/' + ret;
     }
     return ret;
   }
@@ -151,7 +178,7 @@ public IValidationExecutor <IValidationSourceXML> loadXSD (@Nonnull final IRepoS
                                                              @Nonnull final VesXsdType aXSD,
                                                              @Nonnull final ErrorList aErrorList)
   {
-    final RepoStorageKey aXSDKey = VESLoader.wrapKey (aXSD.getResource ());
+    final RepoStorageKey aXSDKey = VESLoader.createRepoStorageKey (aXSD.getResource ());
 
     // Read referenced Item
     final RepoStorageItem aXSDItem = aRepo.read (aXSDKey);
@@ -176,12 +203,14 @@ public IValidationExecutor <IValidationSourceXML> loadXSD (@Nonnull final IRepoS
           final VesXsdCatalogItemPublicType aPublic = (VesXsdCatalogItemPublicType) aItem;
           aEntry = new CatalogEntry (ECatalogType.PUBLIC,
                                      aPublic.getUri (),
-                                     VESLoader.wrapKey (aPublic.getResource ()));
+                                     VESLoader.createRepoStorageKey (aPublic.getResource ()));
         }
         else
         {
           final VesXsdCatalogItemSystemType aSystem = (VesXsdCatalogItemSystemType) aItem;
-          aEntry = new CatalogEntry (ECatalogType.SYSTEM, aSystem.getId (), VESLoader.wrapKey (aSystem.getResource ()));
+          aEntry = new CatalogEntry (ECatalogType.SYSTEM,
+                                     aSystem.getId (),
+                                     VESLoader.createRepoStorageKey (aSystem.getResource ()));
         }
         if (aCatalogEntries.containsKey (aEntry.getID ()))
         {
@@ -204,7 +233,7 @@ public IValidationExecutor <IValidationSourceXML> loadXSD (@Nonnull final IRepoS
     final String sResourceType = aXSD.getResource ().getType ();
     switch (sResourceType)
     {
-      case "xsd":
+      case RESOURCE_TYPE_XSD:
       {
         // Indicate a potential error
         if (StringHelper.hasText (aXSD.getMain ()))
@@ -239,7 +268,7 @@ public IValidationExecutor <IValidationSourceXML> loadXSD (@Nonnull final IRepoS
         aExecutorXSD = ValidationExecutorXSD.create (aRepoRes);
         break;
       }
-      case "zip":
+      case RESOURCE_TYPE_ZIP:
       {
         final String sMainUnified = _unifyPath (aXSD.getMain ());
         if (StringHelper.hasNoText (sMainUnified))
@@ -258,7 +287,7 @@ public IValidationExecutor <IValidationSourceXML> loadXSD (@Nonnull final IRepoS
         long nUnzippedLed = 0;
         final byte [] aBuffer = new byte [4096];
         boolean bFoundMain = false;
-        try (ZipInputStream aZIS = new ZipInputStream (aRepoRes.getInputStream ()))
+        try (final ZipInputStream aZIS = new ZipInputStream (aRepoRes.getInputStream ()))
         {
           ZipEntry aEntry = null;
           while ((aEntry = aZIS.getNextEntry ()) != null)

phive-ves-engine/src/main/java/com/helger/phive/ves/engine/load/LoadedVES.java

@@ -20,6 +20,8 @@
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
+import javax.annotation.concurrent.Immutable;
+import javax.annotation.concurrent.NotThreadSafe;
 
 import com.helger.commons.ValueEnforcer;
 import com.helger.commons.annotation.Nonempty;
@@ -42,22 +44,18 @@
 import com.helger.phive.api.executorset.ValidationExecutorSet;
 import com.helger.phive.api.result.ValidationResultList;
 import com.helger.phive.api.source.IValidationSource;
+import com.helger.phive.ves.model.v1.EVESSyntax;
 import com.helger.xml.namespace.MapBasedNamespaceContext;
 
 /**
  * This class represents a single Loaded VES.
  *
  * @author Philip Helger
  */
+@NotThreadSafe
 public final class LoadedVES
 {
-  public enum EVESSyntax
-  {
-    XSD,
-    SCHEMATRON,
-    EDIFACT
-  }
-
+  @Immutable
   public static final class Header
   {
     private final VESID m_aVESID;
@@ -110,6 +108,7 @@ public EVESSyntax getVESSyntax ()
    *
    * @author Philip Helger
    */
+  @Immutable
   public static final class Status
   {
     private final XMLOffsetDateTime m_aStatusLastMod;
@@ -136,12 +135,12 @@ public XMLOffsetDateTime getStatusLastModification ()
       return m_aStatusLastMod;
     }
 
-    public boolean isDTValidNow ()
+    public boolean isDateTimeValidNow ()
     {
-      return isDTValidAt (PDTFactory.getCurrentXMLOffsetDateTime ());
+      return isDateTimeValidAt (PDTFactory.getCurrentXMLOffsetDateTime ());
     }
 
-    public boolean isDTValidAt (@Nonnull final XMLOffsetDateTime aDT)
+    public boolean isDateTimeValidAt (@Nonnull final XMLOffsetDateTime aDT)
     {
       if (m_aValidFrom != null)
       {
@@ -171,7 +170,7 @@ public boolean isExplicitlyDeprecated ()
 
     public boolean isOverallValid ()
     {
-      return isDTValidNow () && !isExplicitlyDeprecated ();
+      return isDateTimeValidNow () && !isExplicitlyDeprecated ();
     }
 
     @Nonnull
@@ -187,6 +186,7 @@ public static Status createUndefined ()
    *
    * @author Philip Helger
    */
+  @NotThreadSafe
   public static final class OutputType
   {
     private final ICommonsMap <String, EErrorLevel> m_aCustomErrorLevels = new CommonsHashMap <> ();
@@ -202,6 +202,7 @@ public void addCustomErrorLevel (@Nonnull final String sID, @Nonnull final EErro
    *
    * @author Philip Helger
    */
+  @NotThreadSafe
   public static final class Requirement
   {
     private final VESID m_aRequiredVESID;
@@ -262,12 +263,18 @@ public boolean isStopOnError ()
     m_aStatus = aStatus;
   }
 
+  /**
+   * @return The header of the loaded VES. Never <code>null</code>.
+   */
   @Nonnull
   public Header getHeader ()
   {
     return m_aHeader;
   }
 
+  /**
+   * @return The status information of the loaded VES. Never <code>null</code>.
+   */
   @Nonnull
   public Status getStatus ()
   {
@@ -297,11 +304,18 @@ void setEagerRequires (@Nonnull final Requirement aRequirement, @Nonnull final L
     m_aRequiresLoader = null;
   }
 
+  /**
+   * @return <code>true</code> if a validation executor is present,
+   *         <code>false</code> if not.
+   */
   public boolean hasExecutor ()
   {
     return m_aExecutor != null;
   }
 
+  /**
+   * @return The contained validation executor. May be <code>null</code>.
+   */
   @Nullable
   public IValidationExecutor <? extends IValidationSource> getExecutor ()
   {
@@ -319,7 +333,7 @@ private LoadedVES _getLoadedVESRequiresNotNull ()
     LoadedVES ret = m_aLoadedRequires;
     if (ret == null)
     {
-      // TODO do something with the error list
+      // TODO do something better with the error list
       final ErrorList aErrorList = new ErrorList ();
       m_aLoadedRequires = ret = m_aRequiresLoader.deferredLoad (aErrorList);
       if (ret == null)
@@ -353,12 +367,16 @@ private ICommonsList <IValidationExecutor <IValidationSource>> _getValidationExe
 
   private boolean _isRecursivelyValid ()
   {
+    // Local status first, because in case of failure, this is a quicker break
+    if (!m_aStatus.isOverallValid ())
+      return false;
+
     // No requirement
     if (m_aRequires == null)
-      return m_aStatus.isOverallValid ();
+      return true;
 
     // Requirement present
-    return _getLoadedVESRequiresNotNull ()._isRecursivelyValid () && m_aStatus.isOverallValid ();
+    return _getLoadedVESRequiresNotNull ()._isRecursivelyValid ();
   }
 
   public void applyValidation (@Nonnull final IValidationSource aValidationSource,
@@ -369,7 +387,7 @@ public void applyValidation (@Nonnull final IValidationSource aValidationSource,
     ValueEnforcer.notNull (aValidationResultList, "ValidationResultList");
     ValueEnforcer.notNull (aLocale, "Locale");
 
-    if (m_aExecutor == null)
+    if (!hasExecutor ())
       throw new VESLoadingException ("The loaded VES has no Executor Set and can therefore not be used for validating objects");
 
     final boolean bIsValid = _isRecursivelyValid ();