refactor: convert the binary flag "hazmat" into a separate encoded value

Author: aoles

ors-engine/src/main/java/com/graphhopper/routing/ev/HazmatAccess.java

@@ -0,0 +1,13 @@
+package com.graphhopper.routing.ev;
+
+public class HazmatAccess {
+    public static final String KEY = "hazmat_access";
+
+    private HazmatAccess() {
+        // do not instantiate
+    }
+
+    public static BooleanEncodedValue create() {
+        return new SimpleBooleanEncodedValue(KEY, false);
+    }
+}

ors-engine/src/main/java/org/heigit/ors/config/profile/BuildProperties.java

@@ -139,6 +139,9 @@ private void handleHeavyVehicle(ExtendedStorageProperties storage) {
         if (encodedValues.getHgvAccess() == null) {
             encodedValues.setHgvAccess(true);
         }
+        if (encodedValues.getHazmatAccess() == null) {
+            encodedValues.setHazmatAccess(true);
+        }
     }
     private void handleWayCategory() {
         if (encodedValues.getHighway() == null) {

ors-engine/src/main/java/org/heigit/ors/config/profile/EncodedValuesProperties.java

@@ -39,6 +39,8 @@ public class EncodedValuesProperties {
     private Boolean goodsAccess;
     @JsonProperty("hgv_access")
     private Boolean hgvAccess;
+    @JsonProperty("hazmat_access")
+    private Boolean hazmatAccess;
 
     public EncodedValuesProperties() {
     }
@@ -52,7 +54,8 @@ public boolean isEmpty() {
         return osmWayId == null &&
                 ford == null && highway == null &&
                 waySurface == null && wayType == null &&
-                agriculturalAccess == null && busAccess == null && deliveryAccess == null && forestryAccess == null && goodsAccess == null && hgvAccess == null;
+                agriculturalAccess == null && busAccess == null && deliveryAccess == null && forestryAccess == null && goodsAccess == null && hgvAccess == null &&
+                hazmatAccess == null;
     }
 
     @JsonIgnore
@@ -91,6 +94,9 @@ public String toString() {
         if (Boolean.TRUE.equals(hgvAccess)) {
             out.add(HgvAccess.KEY);
         }
+        if (Boolean.TRUE.equals(hazmatAccess)) {
+            out.add(HazmatAccess.KEY);
+        }
         return String.join(",", out);
     }
 
@@ -106,6 +112,7 @@ public void merge(EncodedValuesProperties other) {
         forestryAccess = ofNullable(this.forestryAccess).orElse(other.forestryAccess);
         goodsAccess = ofNullable(this.goodsAccess).orElse(other.goodsAccess);
         hgvAccess = ofNullable(this.hgvAccess).orElse(other.hgvAccess);
+        hazmatAccess = ofNullable(this.hazmatAccess).orElse(other.hazmatAccess);
     }
 }
 

ors-engine/src/main/java/org/heigit/ors/routing/graphhopper/extensions/OrsTagParserFactory.java

@@ -27,6 +27,7 @@ public TagParser create(String name, PMap configuration) {
                 case ForestryAccess.KEY -> new VehicleAccessParser(ForestryAccess.create(), HeavyVehicleAttributes.FORESTRY);
                 case GoodsAccess.KEY -> new VehicleAccessParser(GoodsAccess.create(), HeavyVehicleAttributes.GOODS);
                 case HgvAccess.KEY -> new VehicleAccessParser(HgvAccess.create(), HeavyVehicleAttributes.HGV);
+                case HazmatAccess.KEY -> new HazmatAccessParser();
                 default -> throw e;
             };
         }

ors-engine/src/main/java/org/heigit/ors/routing/graphhopper/extensions/edgefilters/HeavyVehicleEdgeFilter.java

@@ -43,6 +43,8 @@ public class HeavyVehicleEdgeFilter implements EdgeFilter {
     private BooleanEncodedValue forestryAccessEnc = null;
     private BooleanEncodedValue goodsAccessEnc = null;
     private BooleanEncodedValue hgvAccessEnc = null;
+    private BooleanEncodedValue hazmatAccessEnc = null;
+
 
     public HeavyVehicleEdgeFilter(int vehicleType, VehicleParameters vehicleParams, GraphHopperStorage graphStorage) {
         this(vehicleType, vehicleParams, GraphStorageUtils.getGraphExtension(graphStorage, HeavyVehicleAttributesGraphStorage.class));
@@ -59,6 +61,8 @@ public HeavyVehicleEdgeFilter(int vehicleType, VehicleParameters vehicleParams,
             goodsAccessEnc = encodingManager.getBooleanEncodedValue(GoodsAccess.KEY);
         if (encodingManager.hasEncodedValue(HgvAccess.KEY))
             hgvAccessEnc = encodingManager.getBooleanEncodedValue(HgvAccess.KEY);
+        if (encodingManager.hasEncodedValue(HazmatAccess.KEY))
+            hazmatAccessEnc = encodingManager.getBooleanEncodedValue(HazmatAccess.KEY);
     }
 
     public HeavyVehicleEdgeFilter(int vehicleType, VehicleParameters vehicleParams, HeavyVehicleAttributesGraphStorage hgvStorage) {
@@ -105,12 +109,11 @@ public boolean accept(EdgeIteratorState iter) {
         if (!acceptVehicleType(iter))
             return false;
 
-        int edgeId = EdgeIteratorStateHelper.getOriginalEdge(iter);
-
-        if (hasHazmat && isVehicleType(gsHeavyVehicles.getEdgeVehicleType(edgeId), HeavyVehicleAttributes.HAZMAT)) {
+        if (hasHazmat && !(hazmatAccessEnc == null || iter.get(hazmatAccessEnc)) ) {
             return false;
         }
 
+        int edgeId = EdgeIteratorStateHelper.getOriginalEdge(iter);
         if (restCount != 0) {
             if (restCount == 1) {
                 double value = gsHeavyVehicles.getEdgeRestrictionValue(edgeId, indexValues[0]);
@@ -140,8 +143,4 @@ private boolean acceptVehicleType(EdgeIteratorState edge) {
             default -> true;
         };
     }
-
-    private boolean isVehicleType(int vt, int vehicleType) {
-        return (vt & vehicleType) == vehicleType;
-    }
 }

ors-engine/src/main/java/org/heigit/ors/routing/graphhopper/extensions/util/parsers/HazmatAccessParser.java

@@ -0,0 +1,45 @@
+package org.heigit.ors.routing.graphhopper.extensions.util.parsers;
+
+import com.graphhopper.reader.ReaderWay;
+import com.graphhopper.routing.ev.*;
+import com.graphhopper.routing.util.parsers.TagParser;
+import com.graphhopper.storage.IntsRef;
+
+import java.util.List;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+public class HazmatAccessParser implements TagParser {
+    private final BooleanEncodedValue hazmatAccessEnc;
+    private final Pattern patternHazmat;
+
+    public HazmatAccessParser() {
+        this(HazmatAccess.create());
+    }
+
+    public HazmatAccessParser(BooleanEncodedValue hazmatAccessEnc) {
+        this.hazmatAccessEnc = hazmatAccessEnc;
+        patternHazmat = Pattern.compile("^hazmat(:[B-E])?$");
+    }
+
+    @Override
+    public void createEncodedValues(EncodedValueLookup encodedValueLookup, List<EncodedValue> list) {
+        list.add(hazmatAccessEnc);
+    }
+
+    @Override
+    public IntsRef handleWayTags(IntsRef edgeFlags, ReaderWay way, boolean b, IntsRef relationFlags) {
+        boolean hasHazmatRestriction = way.getTags().entrySet().stream().anyMatch(this::isHazmatRestriction);
+
+        hazmatAccessEnc.setBool(false, edgeFlags, !hasHazmatRestriction);
+
+        return edgeFlags;
+    }
+
+    private boolean isHazmatRestriction(Map.Entry<String, Object> entry) {
+        String key = entry.getKey();
+        String value = entry.getValue().toString();
+
+        return patternHazmat.matcher(key).matches() && "no".equals(value);
+    }
+}