introduce required encoded values (graphhopper#1805)

* initial version of required encoded values

* exception no longer possible

* minor changes

Author: karussell

core/files/changelog.txt

@@ -1,4 +1,5 @@
 1.0
+    add required EncodedValues like road_class to EncodingManager if not added from user
     removed PathNative,PathBidirRef,Path4CH,EdgeBasedPathCH and moved path extraction code out of Path class, added PathExtractor,BidirPathExtractor(+subclasses for CH) instead, #1730
     conditional turn restrictions now supported, #1683
     added new `curbside` feature, #1697

core/src/main/java/com/graphhopper/routing/util/DataFlagEncoder.java

@@ -91,13 +91,6 @@ public void createEncodedValues(List<EncodedValue> registerNewEncodedValue, Stri
         // TODO support different vehicle types, currently just roundabout and fwd&bwd for one vehicle type
         super.createEncodedValues(registerNewEncodedValue, prefix, index);
 
-        for (String key : Arrays.asList(RoadClass.KEY, RoadEnvironment.KEY, RoadAccess.KEY, MaxSpeed.KEY)) {
-            if (!encodedValueLookup.hasEncodedValue(key))
-                throw new IllegalStateException("To use DataFlagEncoder and the GenericWeighting you need to add " +
-                        "the encoded value " + key + " before this '" + toString() + "' flag encoder. Order is important! " +
-                        "E.g. use the config: graph.encoded_values: " + key);
-        }
-
         // workaround to init AbstractWeighting.avSpeedEnc variable that GenericWeighting does not need
         avgSpeedEnc = new UnsignedDecimalEncodedValue("fake", 1, 1, false);
         roadEnvironmentEnc = getEnumEncodedValue(RoadEnvironment.KEY, RoadEnvironment.class);

core/src/main/java/com/graphhopper/routing/util/EncodingManager.java

@@ -108,7 +108,7 @@ public static EncodingManager create(EncodedValueFactory evFactory, FlagEncoderF
             throw new IllegalStateException("Cannot load properties to fetch EncodingManager configuration at: "
                     + dir.getLocation());
 
-        EncodingManager.Builder builder = new EncodingManager.Builder(false);
+        EncodingManager.Builder builder = new EncodingManager.Builder();
         String encodedValuesStr = properties.get("graph.encoded_values");
         if (!Helper.isEmpty(encodedValuesStr))
             builder.addAll(evFactory, encodedValuesStr);
@@ -144,15 +144,14 @@ public void releaseParsers() {
 
     public static class Builder {
         private EncodingManager em;
+        List<AbstractFlagEncoder> flagEncoderList = new ArrayList<>();
+        List<EncodedValue> encodedValueList = new ArrayList<>();
+        List<TagParser> tagParsers = new ArrayList<>();
+        List<TurnCostParser> turnCostParsers = new ArrayList<>();
+        List<RelationTagParser> relationTagParsers = new ArrayList<>();
 
         public Builder() {
-            this(true);
-        }
-
-        private Builder(boolean addRoundabout) {
             em = new EncodingManager();
-            if (addRoundabout)
-                add(new OSMRoundaboutParser());
         }
 
         /**
@@ -186,67 +185,46 @@ public Builder setEnableInstructions(boolean enable) {
          * For backward compatibility provide a way to add multiple FlagEncoders
          */
         public Builder addAll(FlagEncoderFactory factory, String flagEncodersStr) {
+            check();
             for (FlagEncoder fe : parseEncoderString(factory, flagEncodersStr)) {
-                add(fe);
+                flagEncoderList.add((AbstractFlagEncoder) fe);
             }
             return this;
         }
 
         public Builder addAll(EncodedValueFactory factory, String encodedValueString) {
-            em.add(this, factory, encodedValueString);
+            check();
+            em.add(encodedValueList, factory, encodedValueString);
             return this;
         }
 
         public Builder addAll(TagParserFactory factory, String tagParserString) {
-            em.add(this, factory, tagParserString);
+            check();
+            em.add(tagParsers, factory, tagParserString);
             return this;
         }
 
         public Builder addTurnCostParser(TurnCostParser parser) {
-            List<EncodedValue> list = new ArrayList<>();
-            parser.createTurnCostEncodedValues(em, list);
-            for (EncodedValue ev : list) {
-                ev.init(em.turnCostConfig);
-                if (em.encodedValueMap.containsKey(ev.getName()))
-                    throw new IllegalArgumentException("Already defined: " + ev.getName() + ". Please note that " +
-                            "EncodedValues for edges and turn cost are in the same namespace.");
-                em.encodedValueMap.put(ev.getName(), ev);
-            }
-            em.turnCostParsers.put(parser.getName(), parser);
+            check();
+            turnCostParsers.add(parser);
             return this;
         }
 
         public Builder addRelationTagParser(RelationTagParser tagParser) {
-            List<EncodedValue> list = new ArrayList<>();
-            tagParser.createRelationEncodedValues(em, list);
-            for (EncodedValue ev : list) {
-                ev.init(em.relationConfig);
-            }
-            em.relationTagParsers.add(tagParser);
-
-            // add as "edge" TagParser
-            add(tagParser, true);
+            check();
+            relationTagParsers.add(tagParser);
             return this;
         }
 
         public Builder add(FlagEncoder encoder) {
             check();
-            if (encoder instanceof BikeCommonFlagEncoder && !em.hasEncodedValue(getKey("bike", RouteNetwork.EV_SUFFIX))) {
-                addRelationTagParser(new OSMBikeNetworkTagParser());
-            } else if (encoder instanceof FootFlagEncoder && !em.hasEncodedValue(getKey("foot", RouteNetwork.EV_SUFFIX))) {
-                addRelationTagParser(new OSMFootNetworkTagParser());
-            }
-
-            em.addEncoder((AbstractFlagEncoder) encoder);
+            flagEncoderList.add((AbstractFlagEncoder) encoder);
             return this;
         }
 
         public Builder add(EncodedValue encodedValue) {
             check();
-            if (!em.edgeEncoders.isEmpty())
-                throw new IllegalArgumentException("Always add shared EncodedValues before FlagEncoders to ensure they can be loaded first");
-
-            em.addEncodedValue(encodedValue, false);
+            encodedValueList.add(encodedValue);
             return this;
         }
 
@@ -255,34 +233,115 @@ public Builder add(EncodedValue encodedValue) {
          * createEncodedValues.
          */
         public Builder add(TagParser tagParser) {
-            return add(tagParser, false);
+            check();
+            tagParsers.add(tagParser);
+            return this;
         }
 
-        private Builder add(TagParser tagParser, boolean encValBoundToFlagEncoder) {
+        private void check() {
+            if (em == null)
+                throw new IllegalStateException("Cannot call method after Builder.build() was called");
+        }
+
+        private void _addEdgeTagParser(TagParser tagParser, boolean withNamespace, boolean insert) {
             List<EncodedValue> list = new ArrayList<>();
             tagParser.createEncodedValues(em, list);
             for (EncodedValue ev : list) {
-                em.addEncodedValue(ev, encValBoundToFlagEncoder);
+                em.addEncodedValue(ev, withNamespace);
             }
-            em.edgeTagParsers.add(tagParser);
-            return this;
+            if (insert)
+                em.edgeTagParsers.add(0, tagParser);
+            else
+                em.edgeTagParsers.add(tagParser);
         }
 
-        private void check() {
-            if (em == null)
-                throw new IllegalStateException("Cannot call method after Builder.build() was called");
+        private void _addRelationTagParser(RelationTagParser tagParser) {
+            List<EncodedValue> list = new ArrayList<>();
+            tagParser.createRelationEncodedValues(em, list);
+            for (EncodedValue ev : list) {
+                ev.init(em.relationConfig);
+            }
+            em.relationTagParsers.add(tagParser);
+
+            // for simplicity add into edge-EncodedValue
+            _addEdgeTagParser(tagParser, true, false);
+        }
+
+        private void _addTurnCostParser(TurnCostParser parser) {
+            List<EncodedValue> list = new ArrayList<>();
+            parser.createTurnCostEncodedValues(em, list);
+            for (EncodedValue ev : list) {
+                ev.init(em.turnCostConfig);
+                if (em.encodedValueMap.containsKey(ev.getName()))
+                    throw new IllegalArgumentException("Already defined: " + ev.getName() + ". Please note that " +
+                            "EncodedValues for edges and turn cost are in the same namespace.");
+                em.encodedValueMap.put(ev.getName(), ev);
+            }
+            em.turnCostParsers.put(parser.getName(), parser);
         }
 
         public EncodingManager build() {
             check();
-            if (em.encodedValueMap.isEmpty())
-                throw new IllegalStateException("No EncodedValues found");
 
-            for (AbstractFlagEncoder encoder : em.edgeEncoders) {
+            for (RelationTagParser tagParser : relationTagParsers) {
+                _addRelationTagParser(tagParser);
+            }
+
+            List<SpatialRuleParser> insertLater = new ArrayList<>();
+            for (TagParser tagParser : tagParsers) {
+                if (SpatialRuleParser.class.isAssignableFrom(tagParser.getClass())) {
+                    insertLater.add((SpatialRuleParser) tagParser);
+                } else {
+                    _addEdgeTagParser(tagParser, false, false);
+                }
+            }
+
+            for (EncodedValue ev : encodedValueList) {
+                em.addEncodedValue(ev, false);
+            }
+
+            if (!em.encodedValueMap.containsKey(RoadAccess.KEY))
+                _addEdgeTagParser(new OSMRoadAccessParser(), false, true);
+            if (!em.encodedValueMap.containsKey(MaxSpeed.KEY))
+                _addEdgeTagParser(new OSMMaxSpeedParser(), false, true);
+            if (!em.encodedValueMap.containsKey(RoadEnvironment.KEY))
+                _addEdgeTagParser(new OSMRoadEnvironmentParser(), false, true);
+            if (!em.encodedValueMap.containsKey(RoadClassLink.KEY))
+                _addEdgeTagParser(new OSMRoadClassLinkParser(), false, true);
+            if (!em.encodedValueMap.containsKey(RoadClass.KEY))
+                _addEdgeTagParser(new OSMRoadClassParser(), false, true);
+            if (!em.encodedValueMap.containsKey(Roundabout.KEY))
+                _addEdgeTagParser(new OSMRoundaboutParser(), false, true);
+
+            // TODO can we avoid this hack without complex dependency management?
+            // ensure that SpatialRuleParser come after required EncodedValues like max_speed or road_access
+            for (SpatialRuleParser srp : insertLater) {
+                _addEdgeTagParser(srp, false, true);
+            }
+
+            for (AbstractFlagEncoder encoder : flagEncoderList) {
+                if (encoder instanceof BikeCommonFlagEncoder && !em.hasEncodedValue(getKey("bike", RouteNetwork.EV_SUFFIX))) {
+                    _addRelationTagParser(new OSMBikeNetworkTagParser());
+                } else if (encoder instanceof FootFlagEncoder && !em.hasEncodedValue(getKey("foot", RouteNetwork.EV_SUFFIX))) {
+                    _addRelationTagParser(new OSMFootNetworkTagParser());
+                }
+
+                em.addEncoder(encoder);
+            }
+
+            for (TurnCostParser parser : turnCostParsers) {
+                _addTurnCostParser(parser);
+            }
+
+            // FlagEncoder can demand TurnCostParsers => add them after the explicitly added ones
+            for (AbstractFlagEncoder encoder : flagEncoderList) {
                 if (encoder.supports(TurnWeighting.class) && !em.turnCostParsers.containsKey(encoder.toString()))
-                    addTurnCostParser(new OSMTurnRelationParser(encoder.toString(), encoder.getMaxTurnCosts()));
+                    _addTurnCostParser(new OSMTurnRelationParser(encoder.toString(), encoder.getMaxTurnCosts()));
             }
 
+            if (em.encodedValueMap.isEmpty())
+                throw new IllegalStateException("No EncodedValues found");
+
             EncodingManager tmp = em;
             em = null;
             return tmp;
@@ -315,7 +374,7 @@ static List<FlagEncoder> parseEncoderString(FlagEncoderFactory factory, String e
         return resultEncoders;
     }
 
-    private void add(Builder builder, EncodedValueFactory factory, String evList) {
+    private void add(List<EncodedValue> returnList, EncodedValueFactory factory, String evList) {
         if (!evList.equals(toLowerCase(evList)))
             throw new IllegalArgumentException("Use lower case for EncodedValues: " + evList);
 
@@ -325,14 +384,14 @@ private void add(Builder builder, EncodedValueFactory factory, String evList) {
                 continue;
 
             EncodedValue evObject = factory.create(entry);
-            builder.add(evObject);
             PMap map = new PMap(entry);
             if (!map.has("version"))
                 throw new IllegalArgumentException("encoded value must have a version specified but it was " + entry);
+            returnList.add(evObject);
         }
     }
 
-    private void add(Builder builder, TagParserFactory factory, String tpList) {
+    private void add(List<TagParser> returnList, TagParserFactory factory, String tpList) {
         if (!tpList.equals(toLowerCase(tpList)))
             throw new IllegalArgumentException("Use lower case for TagParser: " + tpList);
 
@@ -343,7 +402,7 @@ private void add(Builder builder, TagParserFactory factory, String tpList) {
 
             PMap map = new PMap(entry);
             TagParser tp = factory.create(entry, map);
-            builder.add(tp);
+            returnList.add(tp);
         }
     }
 
@@ -398,13 +457,13 @@ private void addEncoder(AbstractFlagEncoder encoder) {
         edgeEncoders.add(encoder);
     }
 
-    private void addEncodedValue(EncodedValue ev, boolean encValBoundToFlagEncoder) {
+    private void addEncodedValue(EncodedValue ev, boolean withNamespace) {
         if (encodedValueMap.containsKey(ev.getName()))
             throw new IllegalStateException("EncodedValue " + ev.getName() + " already exists " + encodedValueMap.get(ev.getName()) + " vs " + ev);
-        if (!encValBoundToFlagEncoder && ev.getName().contains(SPECIAL_SEPARATOR))
-            throw new IllegalArgumentException("EncodedValue " + ev.getName() + " must not contain '" + SPECIAL_SEPARATOR + "'");
-        if (encValBoundToFlagEncoder && !ev.getName().contains(SPECIAL_SEPARATOR))
-            throw new IllegalArgumentException("EncodedValue " + ev.getName() + " must contain '" + SPECIAL_SEPARATOR + "' as reserved for a single profile");
+        if (!withNamespace && ev.getName().contains(SPECIAL_SEPARATOR))
+            throw new IllegalArgumentException("EncodedValue " + ev.getName() + " must not contain namespace character '" + SPECIAL_SEPARATOR + "'");
+        if (withNamespace && !ev.getName().contains(SPECIAL_SEPARATOR))
+            throw new IllegalArgumentException("EncodedValue " + ev.getName() + " must contain namespace character '" + SPECIAL_SEPARATOR + "'");
         ev.init(edgeConfig);
         encodedValueMap.put(ev.getName(), ev);
     }

core/src/main/java/com/graphhopper/routing/util/parsers/OSMTurnRelationParser.java

@@ -82,8 +82,6 @@ DecimalEncodedValue getTurnCostEnc() {
     @Override
     public void createTurnCostEncodedValues(EncodedValueLookup lookup, List<EncodedValue> registerNewEncodedValue) {
         String accessKey = getKey(name, "access");
-        if (!lookup.hasEncodedValue(accessKey))
-            throw new IllegalArgumentException("Add TurnCostParsers to EncodingManager after everything else");
         accessEnc = lookup.getEncodedValue(accessKey, BooleanEncodedValue.class);
         registerNewEncodedValue.add(turnCostEnc = TurnCost.create(name, maxTurnCosts));
     }
@@ -100,7 +98,7 @@ private EdgeExplorer getInExplorer(Graph graph) {
         return cachedInExplorer == null ? cachedInExplorer = graph.createEdgeExplorer(DefaultEdgeFilter.inEdges(accessEnc)) : cachedInExplorer;
     }
 
-    EdgeExplorer getOutExplorer(Graph graph) {
+    private EdgeExplorer getOutExplorer(Graph graph) {
         return cachedOutExplorer == null ? cachedOutExplorer = graph.createEdgeExplorer(DefaultEdgeFilter.outEdges(accessEnc)) : cachedOutExplorer;
     }
 

core/src/main/java/com/graphhopper/routing/util/parsers/SpatialRuleParser.java

@@ -27,6 +27,9 @@
 
 import java.util.List;
 
+/**
+ * This parser stores the spatialId in the edgeFlags based on previously defined areas.
+ */
 public class SpatialRuleParser implements TagParser {
 
     private final IntEncodedValue spatialRuleEnc;

core/src/main/java/com/graphhopper/util/GHUtility.java

@@ -631,12 +631,6 @@ public static EdgeIteratorState setProperties(EdgeIteratorState edge, FlagEncode
         return edge;
     }
 
-    public static EncodingManager.Builder addDefaultEncodedValues(EncodingManager.Builder builder) {
-        return builder.add(new OSMRoadClassParser()).add(new OSMRoadClassLinkParser()).
-                add(new OSMRoadEnvironmentParser()).add(new OSMMaxSpeedParser()).add(new OSMRoadAccessParser()).
-                add(new OSMSurfaceParser());
-    }
-
     public static void updateDistancesFor(Graph g, int node, double lat, double lon) {
         NodeAccess na = g.getNodeAccess();
         na.setNode(node, lat, lon);

core/src/test/java/com/graphhopper/GraphHopperAPITest.java

@@ -115,7 +115,7 @@ public void testDisconnected179() {
     public void testDoNotInterpolateTwice1645() {
         String loc = "./target/issue1645";
         Helper.removeDir(new File(loc));
-        EncodingManager em = new EncodingManager.Builder().add(new OSMRoadEnvironmentParser()).add(new CarFlagEncoder()).build();
+        EncodingManager em = new EncodingManager.Builder().add(new CarFlagEncoder()).build();
         GraphHopperStorage graph = GraphBuilder.start(em).setRAM(loc, true).set3D(true).create();
 
         // we need elevation

core/src/test/java/com/graphhopper/reader/dem/EdgeElevationInterpolatorTest.java

@@ -55,8 +55,7 @@ public abstract class EdgeElevationInterpolatorTest {
     @Before
     public void setUp() {
         graph = new GraphHopperStorage(new RAMDirectory(),
-                encodingManager = new EncodingManager.Builder().add(new CarFlagEncoder()).add(new FootFlagEncoder()).
-                        add(new OSMRoadEnvironmentParser()).build(),
+                encodingManager = new EncodingManager.Builder().add(new CarFlagEncoder()).add(new FootFlagEncoder()).build(),
                 true).create(100);
         roadEnvEnc = encodingManager.getEnumEncodedValue(RoadEnvironment.KEY, RoadEnvironment.class);
         edgeElevationInterpolator = createEdgeElevationInterpolator();

core/src/test/java/com/graphhopper/routing/PathTest.java

@@ -49,7 +49,7 @@ public class PathTest {
     private final BooleanEncodedValue carManagerRoundabout = carManager.getBooleanEncodedValue(Roundabout.KEY);
     private final BooleanEncodedValue carAccessEnc = encoder.getAccessEnc();
     private final DecimalEncodedValue carAvSpeedEnv = encoder.getAverageSpeedEnc();
-    private final EncodingManager dataFlagManager = GHUtility.addDefaultEncodedValues(new EncodingManager.Builder()).add(dataFlagEncoder).build();
+    private final EncodingManager dataFlagManager = new EncodingManager.Builder().add(dataFlagEncoder).build();
     private final IntsRef edgeFlags = dataFlagManager.createEdgeFlags();
     private final EncodingManager mixedEncoders = EncodingManager.create(new CarFlagEncoder(), new FootFlagEncoder());
     private final BooleanEncodedValue mixedManagerRoundabout = mixedEncoders.getBooleanEncodedValue(Roundabout.KEY);

core/src/test/java/com/graphhopper/routing/util/CarFlagEncoderTest.java

@@ -44,7 +44,6 @@
 public class CarFlagEncoderTest {
     final CarFlagEncoder encoder = createEncoder();
     private final EncodingManager em = new EncodingManager.Builder().
-            add(new OSMRoadAccessParser()).
             add(encoder).
             add(new BikeFlagEncoder()).add(new FootFlagEncoder()).build();