Merge remote-tracking branch 'remotes/origin/dev' into test-environment

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/check/AbstractVisitor.java

@@ -30,7 +30,7 @@ import java.util.Set;
  * @author Matthias Betz
  *
  */
-public abstract class AbstractVisitor extends Check {
+public abstract class AbstractCheck extends Check {
 
 	@Override
 	public Set<Requirement> appliesToRequirements() {

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/check/Check.java

@@ -49,7 +49,7 @@ import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
  * @author Matthias Betz
  *
  */
-public abstract class Check {
+public abstract non-sealed class Check implements CheckableVisitor {
 
 	private final List<Class<Checkable>> applicableToClasses = new ArrayList<>(2);
 
@@ -67,11 +67,6 @@ public abstract class Check {
 		}
 	}
 
-	/**
-	 * Returns all classes for which the check needs to be executed
-	 * 
-	 * @return a list of classes which the check applies to
-	 */
 	public List<Class<Checkable>> getApplicableToClasses() {
 		return applicableToClasses;
 	}
@@ -108,22 +103,21 @@ public abstract class Check {
 	 *
 	 * @return true if it validates, false otherwise
 	 */
+	@Override
 	public boolean isValidator() {
 		return true;
 	}
 
 	/**
-	 * Checks whether the check can be executed on this checkable, meaning the
-	 * checkable or its content can not have any error of any check dependent on
-	 * this check. <br>
-	 * If the check cannot be executed a CheckResult will be created with the
+	 * Checks whether this Check can execute on the Checkable, meaning the Checkable contains no error from
+	 * this Check's dependencies and is applicable to this Check. <br/>
+	 * If the check cannot be executed due to not fulfilling the dependencies a CheckResult will be created with the
 	 * ResultStatus = DEPENDENCIES_NOT_MET.
 	 *
 	 * @param c   the checkable
-	 * @param crc container for all check results
-	 * @return true if the check can be executed, false if the checkable itself or
-	 *         one of its containing checkables have an error.
+	 * @return true if the check can be executed, false otherwise
 	 */
+	@Override
 	public boolean canExecute(Checkable c) {
 		// ignore objects where this check doesn't apply to
 		if (!canBeApplied(c)) {

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/check/Checkable.java

@@ -74,7 +74,7 @@ public abstract class Checkable implements Serializable {
 	 * @param c the check from which the check method is called with the Checkable
 	 *          instance as parameter.
 	 */
-	public void accept(Check c) {
+	public void accept(CheckableVisitor c) {
 		if (c.canExecute(this)) {
 			c.check(this);
 		}

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/check/CheckableUtilsVisitor.java

+/*-
+ *  Copyright 2020 Beuth Hochschule für Technik Berlin, Hochschule für Technik Stuttgart
+ * 
+ *  This file is part of CityDoctor2.
+ *
+ *  CityDoctor2 is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU Lesser General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  CityDoctor2 is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public License
+ *  along with CityDoctor2.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package de.hft.stuttgart.citydoctor2.check;
+
+import de.hft.stuttgart.citydoctor2.datastructure.AbstractBuilding;
+import de.hft.stuttgart.citydoctor2.datastructure.BoundarySurface;
+import de.hft.stuttgart.citydoctor2.datastructure.BridgeObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Building;
+import de.hft.stuttgart.citydoctor2.datastructure.BuildingPart;
+import de.hft.stuttgart.citydoctor2.datastructure.CityFurniture;
+import de.hft.stuttgart.citydoctor2.datastructure.CityObject;
+import de.hft.stuttgart.citydoctor2.datastructure.GenericCityObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Geometry;
+import de.hft.stuttgart.citydoctor2.datastructure.Installation;
+import de.hft.stuttgart.citydoctor2.datastructure.LandObject;
+import de.hft.stuttgart.citydoctor2.datastructure.LinearRing;
+import de.hft.stuttgart.citydoctor2.datastructure.Opening;
+import de.hft.stuttgart.citydoctor2.datastructure.Polygon;
+import de.hft.stuttgart.citydoctor2.datastructure.ReliefObject;
+import de.hft.stuttgart.citydoctor2.datastructure.TinObject;
+import de.hft.stuttgart.citydoctor2.datastructure.TransportationObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Vegetation;
+import de.hft.stuttgart.citydoctor2.datastructure.WaterObject;
+
+/**
+ *
+ * This class serves as the base for CheckableVisitors which fulfill utility functions, like e.g. collecting all
+ * sub-CityObjects in the datastructure of a CityObject.
+ * </p>
+ * Visitors extending from this class will not change the validated-flag of the visited Checkables.
+ *
+ */
+public abstract non-sealed class CheckableUtilsVisitor implements CheckableVisitor {
+
+	/**
+	 * This function is used for checking of dependencies in {@link Check}. Since UtilsVisitors do not have
+	 * dependencies this function will always return true.
+	 *
+	 * @param c a Checkable
+	 * @return true
+	 */
+	@Override
+	public boolean canExecute(Checkable c) {
+		return true;
+	}
+
+	@Override
+	public final boolean isValidator() {
+		return false;
+	}
+
+	@Override
+	public void check(Checkable checkable) {
+
+	}
+
+	@Override
+	public void check(AbstractBuilding ab) {
+
+	}
+
+	@Override
+	public void check(BoundarySurface bs) {
+
+	}
+
+	@Override
+	public void check(BridgeObject bo) {
+
+	}
+
+	@Override
+	public void check(Building b) {
+
+	}
+
+	@Override
+	public void check(Installation bi) {
+
+	}
+
+	@Override
+	public void check(BuildingPart bp) {
+
+	}
+
+	@Override
+	public void check(CityObject co) {
+
+	}
+
+	@Override
+	public void check(LandObject lo) {
+
+	}
+
+	@Override
+	public void check(Opening o) {
+
+	}
+
+	@Override
+	public void check(TransportationObject to) {
+
+	}
+
+	@Override
+	public void check(Vegetation veg) {
+
+	}
+
+	@Override
+	public void check(WaterObject wo) {
+
+	}
+
+	@Override
+	public void check(Geometry geom) {
+
+	}
+
+	@Override
+	public void check(Polygon poly) {
+
+	}
+
+	@Override
+	public void check(LinearRing ring) {
+
+	}
+
+	@Override
+	public void check(TinObject tin) {
+
+	}
+
+	@Override
+	public void check(ReliefObject relief) {
+
+	}
+
+	@Override
+	public void check(CityFurniture cf) {
+
+	}
+
+	@Override
+	public void check(GenericCityObject gco) {
+
+	}
+
+}

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/check/CheckableVisitor.java

+package de.hft.stuttgart.citydoctor2.check;
+
+import de.hft.stuttgart.citydoctor2.datastructure.AbstractBuilding;
+import de.hft.stuttgart.citydoctor2.datastructure.BoundarySurface;
+import de.hft.stuttgart.citydoctor2.datastructure.BridgeObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Building;
+import de.hft.stuttgart.citydoctor2.datastructure.BuildingPart;
+import de.hft.stuttgart.citydoctor2.datastructure.CityFurniture;
+import de.hft.stuttgart.citydoctor2.datastructure.CityObject;
+import de.hft.stuttgart.citydoctor2.datastructure.GenericCityObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Geometry;
+import de.hft.stuttgart.citydoctor2.datastructure.Installation;
+import de.hft.stuttgart.citydoctor2.datastructure.LandObject;
+import de.hft.stuttgart.citydoctor2.datastructure.LinearRing;
+import de.hft.stuttgart.citydoctor2.datastructure.Opening;
+import de.hft.stuttgart.citydoctor2.datastructure.Polygon;
+import de.hft.stuttgart.citydoctor2.datastructure.ReliefObject;
+import de.hft.stuttgart.citydoctor2.datastructure.TinObject;
+import de.hft.stuttgart.citydoctor2.datastructure.TransportationObject;
+import de.hft.stuttgart.citydoctor2.datastructure.Vegetation;
+import de.hft.stuttgart.citydoctor2.datastructure.WaterObject;
+
+public sealed interface CheckableVisitor permits Check, CheckableUtilsVisitor {
+
+    /**
+     * Returns whether a Checkable should be flagged as validated after accepting this Visitor.
+     */
+    boolean isValidator();
+
+    boolean canExecute(Checkable c);
+
+    void check(Checkable checkable);
+
+    void check(AbstractBuilding ab);
+
+    void check(BoundarySurface bs);
+
+    void check(BridgeObject bo);
+
+    void check(Building b);
+
+    void check(Installation bi);
+
+    void check(BuildingPart bp);
+
+    void check(CityObject co);
+
+    void check(LandObject lo);
+
+    void check(Opening o);
+
+    void check(TransportationObject to);
+
+    void check(Vegetation veg);
+
+    void check(WaterObject wo);
+
+    void check(Geometry geom);
+
+    void check(Polygon poly);
+
+    void check(LinearRing ring);
+
+    void check(TinObject tin);
+
+    void check(ReliefObject relief);
+
+    void check(CityFurniture cf);
+
+    void check(GenericCityObject gco);
+
+}

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/AbstractBuilding.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import org.apache.logging.log4j.LogManager;
@@ -160,7 +160,7 @@ public abstract class AbstractBuilding extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/AbstractBuildingSubdivision.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import org.apache.logging.log4j.LogManager;
@@ -136,7 +136,7 @@ public abstract class AbstractBuildingSubdivision extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/AbstractFurniture.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
-
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -30,7 +29,7 @@ public abstract class AbstractFurniture extends CityObject {
     private org.citygml4j.core.model.construction.AbstractFurniture af;
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/AbstractRoom.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import org.citygml4j.core.model.core.AbstractCityObject;
@@ -32,7 +32,7 @@ public abstract class AbstractRoom extends CityObject {
 
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/AbstractTunnel.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -143,7 +143,7 @@ public abstract class AbstractTunnel extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/BoundarySurface.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -145,7 +145,7 @@ public class BoundarySurface extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/BridgeConstructiveElement.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -95,7 +95,7 @@ public class BridgeConstructiveElement extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/BridgeObject.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -191,7 +191,7 @@ public class BridgeObject extends CityObject {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/Building.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import org.citygml4j.core.model.building.BuildingInstallation;
 import org.citygml4j.core.model.building.BuildingInstallationProperty;
 import org.citygml4j.core.model.core.AbstractSpaceBoundaryProperty;
@@ -45,7 +45,7 @@ public class Building extends AbstractBuilding {
     }
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/BuildingUnit.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
-import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
-import org.citygml4j.core.util.geometry.GeometryFactory;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 
 import java.io.Serial;
 import java.util.ArrayList;
@@ -16,7 +14,7 @@ public class BuildingUnit extends AbstractBuildingSubdivision {
     private final List<Storey> storeys = new ArrayList<>();
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         for (Storey storey : storeys) {
             storey.accept(c);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/CityDoctorModel.java

@@ -18,8 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.AbstractVisitor;
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableUtilsVisitor;
 import de.hft.stuttgart.citydoctor2.check.CheckError;
 import de.hft.stuttgart.citydoctor2.exceptions.CityDoctorWriteException;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
@@ -147,7 +146,7 @@ public class CityDoctorModel {
         folder.mkdirs();
         createFeatureStream().forEach(co -> {
             Map<Lod, Set<Polygon>> polygonMap = new EnumMap<>(Lod.class);
-            Check c = new AbstractVisitor() {
+            CheckableUtilsVisitor c = new CheckableUtilsVisitor() {
 
                 @Override
                 public void check(Geometry geom) {

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/CityFurniture.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -21,7 +21,7 @@ public class CityFurniture extends CityObject {
     private org.citygml4j.core.model.cityfurniture.CityFurniture cgmlCityFurniture;
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/CityObject.java

@@ -18,7 +18,7 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.visitors.GmlGeometryRebuilder;
 import de.hft.stuttgart.citydoctor2.utils.visitors.UnsetGeometriesVisitor;
@@ -185,7 +185,7 @@ public abstract class CityObject extends GmlElement {
     public abstract FeatureType getFeatureType();
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/ConcretePolygon.java

@@ -18,8 +18,8 @@
  */
 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
 import de.hft.stuttgart.citydoctor2.check.Checkable;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.math.Vector3d;
 import de.hft.stuttgart.citydoctor2.tesselation.JoglTesselator;
 import de.hft.stuttgart.citydoctor2.tesselation.TesselatedPolygon;
@@ -180,7 +180,7 @@ public class ConcretePolygon extends Polygon {
 	 * citydoctor2.check.Check)
 	 */
 	@Override
-	public void accept(Check c) {
+	public void accept(CheckableVisitor c) {
 		super.accept(c);
 		if (c.canExecute(this)) {
 			c.check(this);

CityDoctorParent/CityDoctorModel/src/main/java/de/hft/stuttgart/citydoctor2/datastructure/GenericCityObject.java

 package de.hft.stuttgart.citydoctor2.datastructure;
 
-import de.hft.stuttgart.citydoctor2.check.Check;
+import de.hft.stuttgart.citydoctor2.check.CheckableVisitor;
 import de.hft.stuttgart.citydoctor2.parser.ParserConfiguration;
 import de.hft.stuttgart.citydoctor2.utils.CityGmlUtils;
 import javafx.scene.paint.Color;
@@ -33,7 +33,7 @@ public class GenericCityObject extends CityObject {
     private final List<BoundarySurface> boundarySurfaceList = new ArrayList<>();
 
     @Override
-    public void accept(Check c) {
+    public void accept(CheckableVisitor c) {
         super.accept(c);
         if (c.canExecute(this)) {
             c.check(this);