com.graphhopper.routing.ev.Surface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphhopper-core Show documentation

GraphHopper is a fast and memory efficient Java road routing engine working seamlessly with OpenStreetMap data.

There is a newer version: 10.0

/*
 *  Licensed to GraphHopper GmbH under one or more contributor
 *  license agreements. See the NOTICE file distributed with this work for
 *  additional information regarding copyright ownership.
 *
 *  GraphHopper GmbH licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except in
 *  compliance with the License. You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.graphhopper.routing.ev;

import com.graphhopper.util.Helper;

import java.util.HashMap;
import java.util.Map;

/**
 * This enum defines the road surface of an edge like unpaved or asphalt. If not tagged the value will be MISSING, which
 * the default and best surface value (as surface is currently often not tagged). All unknown surface tags will get
 * OTHER (the worst surface).
 */
public enum Surface {
    // Order is important to make ordinal roughly comparable
    MISSING,
    PAVED, ASPHALT, CONCRETE, PAVING_STONES, COBBLESTONE,
    UNPAVED, COMPACTED, FINE_GRAVEL, GRAVEL, GROUND, DIRT, GRASS, SAND, WOOD,
    OTHER;

    public static final String KEY = "surface";

    private static final Map SURFACE_MAP = new HashMap<>();

    static {
        for (Surface surface : values()) {
            if (surface == MISSING || surface == OTHER)
                continue;
            SURFACE_MAP.put(surface.toString(), surface);
        }
        SURFACE_MAP.put("metal", PAVED);
        SURFACE_MAP.put("sett", COBBLESTONE);
        SURFACE_MAP.put("unhewn_cobblestone", COBBLESTONE);
        SURFACE_MAP.put("earth", DIRT);
        SURFACE_MAP.put("pebblestone", GRAVEL);
        SURFACE_MAP.put("grass_paver", GRASS);
    }

    public static EnumEncodedValue create() {
        return new EnumEncodedValue<>(KEY, Surface.class);
    }

    @Override
    public String toString() {
        return Helper.toLowerCase(super.toString());
    }

    public static Surface find(String name) {
        if (Helper.isEmpty(name))
            return MISSING;

        int colonIndex = name.indexOf(":");
        if (colonIndex != -1) {
            name = name.substring(0, colonIndex);
        }

        return SURFACE_MAP.getOrDefault(name, OTHER);
    }
}