Added ford annotation for DataFlagEncoder (graphhopper#973)

* Added ford annotation for DataFlagEncoder

* Added Translation

* Changed method naming

Author: boldtrn

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

@@ -24,10 +24,7 @@
 import com.graphhopper.routing.util.spatialrules.SpatialRuleLookup;
 import com.graphhopper.routing.util.spatialrules.TransportationMode;
 import com.graphhopper.routing.weighting.GenericWeighting;
-import com.graphhopper.util.ConfigMap;
-import com.graphhopper.util.EdgeIteratorState;
-import com.graphhopper.util.Helper;
-import com.graphhopper.util.PMap;
+import com.graphhopper.util.*;
 import com.graphhopper.util.shapes.GHPoint;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -77,6 +74,7 @@ public class DataFlagEncoder extends AbstractFlagEncoder {
     private final Map<String, Integer> transportModeMap = new HashMap<>();
     private final int transportModeTunnelValue;
     private final int transportModeBridgeValue;
+    private final int transportModeFordValue;
     private long bit0;
     private EncodedDoubleValue carFwdMaxspeedEncoder;
     private EncodedDoubleValue carBwdMaxspeedEncoder;
@@ -141,6 +139,7 @@ public DataFlagEncoder(int speedBits, double speedFactor, int maxTurnCosts) {
         }
         transportModeTunnelValue = transportModeMap.get("tunnel");
         transportModeBridgeValue = transportModeMap.get("bridge");
+        transportModeFordValue = transportModeMap.get("ford");
 
         List<String> surfaceList = Arrays.asList("_default", "asphalt", "unpaved", "paved", "gravel",
                 "ground", "dirt", "grass", "concrete", "paving_stones", "sand", "compacted", "cobblestone", "mud", "ice");
@@ -273,9 +272,9 @@ int getAccessValue(ReaderWay way) {
             }
         }
 
-        if (spatialRuleLookupEnabled() && accessValue == 0) {
+        if (isSpatialRuleLookupEnabled() && accessValue == 0) {
             // TODO Fix transportation mode when adding other forms of transportation
-            switch (getSpatialRule(way).getAccessValue(way.getTag("highway", ""), TransportationMode.MOTOR_VEHICLE, AccessValue.ACCESSIBLE)){
+            switch (getSpatialRule(way).getAccessValue(way.getTag("highway", ""), TransportationMode.MOTOR_VEHICLE, AccessValue.ACCESSIBLE)) {
                 case ACCESSIBLE:
                     accessValue = accessMap.get("yes");
                     break;
@@ -325,7 +324,7 @@ public long handleWayTags(ReaderWay way, long allowed, long relationFlags) {
 
             // MAXSPEED
             double maxSpeed = parseSpeed(way.getTag("maxspeed"));
-            if (spatialRuleLookupEnabled() && maxSpeed < 0) {
+            if (isSpatialRuleLookupEnabled() && maxSpeed < 0) {
                 // TODO What if no maxspeed is set, but only forward and backward, and both are higher than the usually allowed?
                 maxSpeed = getSpatialRule(way).getMaxSpeed(way.getTag("highway", ""), maxSpeed);
             }
@@ -413,7 +412,7 @@ public long handleWayTags(ReaderWay way, long allowed, long relationFlags) {
             flags = accessEncoder.setValue(flags, getAccessValue(way));
 
 
-            if(spatialRuleLookupEnabled()){
+            if (isSpatialRuleLookupEnabled()) {
                 GHPoint estimatedCenter = way.getTag("estimated_center", null);
                 if (estimatedCenter != null) {
                     SpatialRule rule = spatialRuleLookup.lookupRule(estimatedCenter);
@@ -427,7 +426,7 @@ public long handleWayTags(ReaderWay way, long allowed, long relationFlags) {
         }
     }
 
-    private boolean spatialRuleLookupEnabled(){
+    private boolean isSpatialRuleLookupEnabled() {
         if (spatialRules > 0) {
             if (spatialRuleLookup == null)
                 throw new IllegalStateException("This encoder was asked to store spatial IDs for every edge, " +
@@ -631,6 +630,10 @@ public boolean isTransportModeBridge(EdgeIteratorState edge) {
         return transportModeEncoder.getValue(edge.getFlags()) == this.transportModeBridgeValue;
     }
 
+    public boolean isTransportModeFord(long flags) {
+        return transportModeEncoder.getValue(flags) == this.transportModeFordValue;
+    }
+
     public String getTransportModeAsString(EdgeIteratorState edge) {
         int val = getTransportMode(edge);
         for (Entry<String, Integer> e : transportModeMap.entrySet()) {
@@ -842,6 +845,16 @@ public DataFlagEncoder setSpatialRuleLookup(SpatialRuleLookup spatialRuleLookup)
         return this;
     }
 
+    @Override
+    public InstructionAnnotation getAnnotation(long flags, Translation tr) {
+        if (isTransportModeFord(flags)) {
+            return new InstructionAnnotation(1, tr.tr("way_contains_ford"));
+        }
+
+        return super.getAnnotation(flags, tr);
+    }
+
+
     @Override
     protected String getPropertiesString() {
         return super.getPropertiesString() +

core/src/main/resources/com/graphhopper/util/ar.txt

@@ -50,6 +50,7 @@ roundabout_exit=في الدوران ، أتخذ مخرج   %1$s
 roundabout_exit_onto=في الدوران ، أتخذ مخرج   %1$s من خلال %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/ast.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na rotonda, toma la salida %1$s
 roundabout_exit_onto=Na rotonda, toma la salida %1$s haza %2$s
 total_ascend=%1$s d'ascensu total
 total_descend=%1$s de descensu total
+way_contains_ford=
 web.start_label=Principiu
 web.intermediate_label=Intermediu
 web.end_label=Final

core/src/main/resources/com/graphhopper/util/bg.txt

@@ -50,6 +50,7 @@ roundabout_exit=На кръговото кръстовище използвай
 roundabout_exit_onto=На кръговото кръстовище използвай изход %1$s по %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/ca.txt

@@ -50,6 +50,7 @@ roundabout_exit=A la rotonda, agafa la %1$s sortida
 roundabout_exit_onto=A la rotonda, agafa la sortida %1$s cap a %2$s
 total_ascend=%1$s pujada total
 total_descend=%1$s baixada total
+way_contains_ford=
 web.start_label=Punt d'inici
 web.intermediate_label=Punt intermig
 web.end_label=Punt final

core/src/main/resources/com/graphhopper/util/cs_CZ.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na kruhovém objezdu použijte %1$s. výjezd
 roundabout_exit_onto=Na kruhovém objezdu použijte %1$s. výjezd, směrem na %2$s
 total_ascend=Celkové stoupání %1$s
 total_descend=Celkové klesání %1$s
+way_contains_ford=
 web.start_label=Start
 web.intermediate_label=Zastávka
 web.end_label=Cíl

core/src/main/resources/com/graphhopper/util/da_DK.txt

@@ -50,6 +50,7 @@ roundabout_exit=I rundkørslen, tag udkørsel %1$s
 roundabout_exit_onto=I rundskørslen, ta udkørsel %1$s ind på %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/de_DE.txt

@@ -50,6 +50,7 @@ roundabout_exit=Im Kreisverkehr Ausfahrt %1$s nehmen
 roundabout_exit_onto=Im Kreisverkehr Ausfahrt %1$s auf %2$s nehmen
 total_ascend=%1$s Gesamtaufstieg
 total_descend=%1$s Gesamtabstieg
+way_contains_ford=es liegt eine Furt auf dem Weg
 web.start_label=Start
 web.intermediate_label=Zwischenziel
 web.end_label=Ziel

core/src/main/resources/com/graphhopper/util/el.txt

@@ -50,6 +50,7 @@ roundabout_exit=Στον κυκλικό κόμβο βγείτε στην έξο
 roundabout_exit_onto=Στον κυκλικό κόμβο βγείτε στην έξοδο %1$s στην %2$s
 total_ascend=%1$s συνολική ανάβαση
 total_descend=%1$s συνολική κατάβαση
+way_contains_ford=
 web.start_label=Αφετηρία
 web.intermediate_label=Ενδιάμεσο σημείο
 web.end_label=Προορισμός

core/src/main/resources/com/graphhopper/util/en_US.txt

@@ -50,6 +50,7 @@ roundabout_exit=At roundabout, take exit %1$s
 roundabout_exit_onto=At roundabout, take exit %1$s onto %2$s
 total_ascend=%1$s total ascend
 total_descend=%1$s total descend
+way_contains_ford=there is ford along the way
 web.start_label=Start
 web.intermediate_label=Intermediate
 web.end_label=End

core/src/main/resources/com/graphhopper/util/es.txt

@@ -50,6 +50,7 @@ roundabout_exit=En la rotonda, toma la %1$sª salida
 roundabout_exit_onto=En la rotonda, toma la %1$sª salida hacia %2$s
 total_ascend=Ascender %1$s en total
 total_descend=Descender %1$s en total
+way_contains_ford=
 web.start_label=Punto de partida
 web.intermediate_label=Punto intermedio
 web.end_label=Punto de finalización

core/src/main/resources/com/graphhopper/util/fa.txt

@@ -50,6 +50,7 @@ roundabout_exit=در میدان خروجی  %1$s را انتخاب کنید
 roundabout_exit_onto=در میدان خروجی  %1$s به %2$s را انتخاب کنید
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/fi.txt

@@ -50,6 +50,7 @@ roundabout_exit=Liikenneympyrästä poistu %1$s. liittymästä
 roundabout_exit_onto=Liikenneympyrästä poistu %1$s. liittymästä suuntaan %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/fil.txt

@@ -50,6 +50,7 @@ roundabout_exit=Sa rotonda, lumabas sa exit %1$s
 roundabout_exit_onto=Sa rotonda, lumabas sa exit papunta %1$s %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/fr_CH.txt

@@ -50,6 +50,7 @@ roundabout_exit=Au giratoire, prenez la %1$s sortie
 roundabout_exit_onto=Au giratoire, prenez la %1$s sortie vers %2$s
 total_ascend=%1$s de dénivelé positif
 total_descend=%1$s de dénivelé négatif
+way_contains_ford=
 web.start_label=Départ
 web.intermediate_label=Point intermédiaire
 web.end_label=Arrivée

core/src/main/resources/com/graphhopper/util/fr_FR.txt

@@ -50,6 +50,7 @@ roundabout_exit=Au rond-point, prenez la %1$s sortie
 roundabout_exit_onto=Au rond-point, prenez la %1$s sortie vers %2$s
 total_ascend=%1$s de dénivelé positif
 total_descend=%1$s de dénivelé négatif
+way_contains_ford=
 web.start_label=Départ
 web.intermediate_label=Point intermédiaire
 web.end_label=Arrivée

core/src/main/resources/com/graphhopper/util/gl.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na rotonda tome a saída %1$s
 roundabout_exit_onto=Na rotonda, tome a saída %1$s cara %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/he.txt

@@ -50,6 +50,7 @@ roundabout_exit=בכיכר, יש לצאת ביציאה %1$s
 roundabout_exit_onto=בכיכר, יש לצאת ביציאה %1$s לתוך %2$s
 total_ascend=עלייה כוללת של %1$s
 total_descend=ירידה כוללת של %1$s
+way_contains_ford=
 web.start_label=התחלה
 web.intermediate_label=אמצע
 web.end_label=סוף

core/src/main/resources/com/graphhopper/util/hr_HR.txt

@@ -50,6 +50,7 @@ roundabout_exit=Sa kružnog toka izađite na izlaz %1$s
 roundabout_exit_onto=Sa kružnog toka izađite na izlaz %1$s na %2$s
 total_ascend=%1$s ukupni uspon
 total_descend=
+way_contains_ford=
 web.start_label=Početak
 web.intermediate_label=Posrednik
 web.end_label=Kraj

core/src/main/resources/com/graphhopper/util/hsb.txt

@@ -50,6 +50,7 @@ roundabout_exit=we kružnym wobchadźe %1$s. wujězd wzać
 roundabout_exit_onto=we kružnym wobchadźe %1$s. wujězd na %2$s wzać
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/hu_HU.txt

@@ -50,6 +50,7 @@ roundabout_exit=Hagyja el a körförgalmat, kihajtó %1$s
 roundabout_exit_onto=Hagyja el a körförgalmat, kihajtó %1$s, aztán hajtson rá %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/it.txt

@@ -50,6 +50,7 @@ roundabout_exit=Nella rotatoria, prendere l'uscita %1$s
 roundabout_exit_onto=Nella rotatoria, prendere l'uscita %1$s su %2$s
 total_ascend=%1$s di dislivello positivo
 total_descend=%1$s di dislivello negativo
+way_contains_ford=
 web.start_label=Partenza
 web.intermediate_label=Punto intermedio
 web.end_label=Arrivo

core/src/main/resources/com/graphhopper/util/ja.txt

@@ -50,6 +50,7 @@ roundabout_exit=円形交差点の出口%1$sへ
 roundabout_exit_onto=円形交差点の出口%1$sから%2$sへ
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/ko.txt

@@ -50,6 +50,7 @@ roundabout_exit=로터리에서 %1$s 진출
 roundabout_exit_onto=로터리에서 %1$s 진출 후 %2$s 이동
 total_ascend=%1$s 오르막길
 total_descend=%1$s 내리막길
+way_contains_ford=
 web.start_label=출발
 web.intermediate_label=경유
 web.end_label=도착

core/src/main/resources/com/graphhopper/util/lt_LT.txt

@@ -50,6 +50,7 @@ roundabout_exit=Žiede išvažiuokite %1$s išvažiavime
 roundabout_exit_onto=Žiede išvažiuokite %1$s išvažiavime į  %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/ne.txt

@@ -50,6 +50,7 @@ roundabout_exit=घुम्तीमा %1$s नम्बर को मोड
 roundabout_exit_onto=घुम्तीमा %1$s नम्बर को मोडबाट निस्केर %2$s मा जानुहोस
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/nl.txt

@@ -50,6 +50,7 @@ roundabout_exit=neem afslag %1$s op de rotonde
 roundabout_exit_onto=neem afslag %1$s naar %2$s op de rotonde 
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/pl_PL.txt

@@ -50,6 +50,7 @@ roundabout_exit=Zjedź z ronda %1$s zjazdem
 roundabout_exit_onto=Zjedź z ronda %1$s zjazdem na %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/pt_BR.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na rotatória, saia na %1$s saída
 roundabout_exit_onto=Na rotatória, saia na %1$s saida em direção a %2$s
 total_ascend=subida de %1$s
 total_descend=descida de %1$s
+way_contains_ford=
 web.start_label=Inicio
 web.intermediate_label=Intermediário
 web.end_label=Fim

core/src/main/resources/com/graphhopper/util/pt_PT.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na rotunda, saia na %1$s saída
 roundabout_exit_onto=Na rotunda, saia na %1$s saida em direção a %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/ro.txt

@@ -50,6 +50,7 @@ roundabout_exit=În sensul giratoriu folosiți ieșirea %1$s
 roundabout_exit_onto=În sensul giratoriu folosiți ieșirea %1$s către %2$s
 total_ascend=urcare %1$s
 total_descend=coborâre %1$s
+way_contains_ford=
 web.start_label=Pornire
 web.intermediate_label=Intermediar
 web.end_label=Sfârșit

core/src/main/resources/com/graphhopper/util/ru.txt

@@ -50,6 +50,7 @@ roundabout_exit=У кольца используйте съезд %1$s
 roundabout_exit_onto=У кольца используйте съезд %1$s на %2$s
 total_ascend=подъём на %1$s
 total_descend=спуск на %1$s
+way_contains_ford=
 web.start_label=Начало
 web.intermediate_label=Промежуточная точка
 web.end_label=Конец

core/src/main/resources/com/graphhopper/util/sk.txt

@@ -50,6 +50,7 @@ roundabout_exit=Na kruhovom objazde, ho opustite cez %1$s. výjazd
 roundabout_exit_onto=Na kruhovom objazde, ho opustite cez %1$s. výjazd na %2$s
 total_ascend=%1$s celkové stúpanie
 total_descend=%1$s celkové klesanie
+way_contains_ford=
 web.start_label=Začiatok
 web.intermediate_label=Bod trasy
 web.end_label=Koniec

core/src/main/resources/com/graphhopper/util/sl_SI.txt

@@ -50,6 +50,7 @@ roundabout_exit=V krožišču izberite izhod %1$s
 roundabout_exit_onto=V krožišču izberite izhod %1$s na %2$s
 total_ascend=Skupni vzpon: %1$s
 total_descend=Skupni spust: %1$s
+way_contains_ford=
 web.start_label=Začetna točka
 web.intermediate_label=Vmesna točka
 web.end_label=Končna točka

core/src/main/resources/com/graphhopper/util/sv_SE.txt

@@ -50,6 +50,7 @@ roundabout_exit=I rondellen, ta avfart %1$s
 roundabout_exit_onto=I rondellen, ta avfart %1$s in på %2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/tr.txt

@@ -50,6 +50,7 @@ roundabout_exit=kavşaktan %1$s cıkışa gir
 roundabout_exit_onto=kavşaktan %1$s cıkıştan %2$s sokağa gir
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/uk.txt

@@ -50,6 +50,7 @@ roundabout_exit=На кільці використовуйте з’їзд %1$s
 roundabout_exit_onto=На кільці використовуйте з’їзд %1$s на %2$s
 total_ascend=%1$s загалом підйому
 total_descend=%1$s загалом спуску
+way_contains_ford=
 web.start_label=Початок
 web.intermediate_label=Проміжна точка
 web.end_label=Кінець

core/src/main/resources/com/graphhopper/util/vi_VI.txt

@@ -50,6 +50,7 @@ roundabout_exit=Tại vòng xoay, rẽ lối rẽ %1$s
 roundabout_exit_onto=Tại vòng xoay, rẽ lối rẽ %1$s vào đường %2$s
 total_ascend=Đi tiếp %1$s nữa
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=

core/src/main/resources/com/graphhopper/util/zh_CN.txt

@@ -50,6 +50,7 @@ roundabout_exit=在环岛内，使用%1$s出口出环岛
 roundabout_exit_onto=在环岛内，使用%1$s出口出环岛，进入%2$s
 total_ascend=
 total_descend=
+way_contains_ford=
 web.start_label=
 web.intermediate_label=
 web.end_label=