com.graphhopper.reader.osm.GraphHopperOSM Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graphhopper-reader-osm Show documentation
There is a newer version: 3.0-pre3
Show newest version
/*
 *  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.reader.osm;

import com.graphhopper.GraphHopper;
import com.graphhopper.json.geo.JsonFeatureCollection;
import com.graphhopper.reader.DataReader;
import com.graphhopper.routing.lm.PrepareLandmarks;
import com.graphhopper.routing.util.spatialrules.*;
import com.graphhopper.storage.GraphHopperStorage;
import com.graphhopper.util.shapes.Polygon;

import java.util.List;

/**
 * This class is the simplified entry to all functionality if you import from OpenStreetMap data.
 *
 * @author Peter Karich
 */
public class GraphHopperOSM extends GraphHopper {

    private final JsonFeatureCollection landmarkSplittingFeatureCollection;

    public GraphHopperOSM() {
        this(null);
    }

    public GraphHopperOSM(JsonFeatureCollection landmarkSplittingFeatureCollection) {
        super();
        this.landmarkSplittingFeatureCollection = landmarkSplittingFeatureCollection;
    }

    @Override
    protected DataReader createReader(GraphHopperStorage ghStorage) {
        return initDataReader(new OSMReader(ghStorage));
    }

    public String getOSMFile() {
        return getDataReaderFile();
    }

    /**
     * This file can be an osm xml (.osm), a compressed xml (.osm.zip or .osm.gz) or a protobuf file
     * (.pbf).
     */
    public GraphHopperOSM setOSMFile(String osmFileStr) {
        super.setDataReaderFile(osmFileStr);
        return this;
    }

    @Override
    protected void loadOrPrepareLM() {
        if (!getLMFactoryDecorator().isEnabled() || getLMFactoryDecorator().getPreparations().isEmpty())
            return;

        if (landmarkSplittingFeatureCollection != null && !landmarkSplittingFeatureCollection.getFeatures().isEmpty()) {
            SpatialRuleLookup ruleLookup = SpatialRuleLookupBuilder.buildIndex(landmarkSplittingFeatureCollection, "area", new SpatialRuleLookupBuilder.SpatialRuleFactory() {
                @Override
                public SpatialRule createSpatialRule(final String id, List polygons) {
                    return new DefaultSpatialRule() {
                        @Override
                        public String getId() {
                            return id;
                        }
                    }.setBorders(polygons);
                }
            });
            for (PrepareLandmarks prep : getLMFactoryDecorator().getPreparations()) {
                // the ruleLookup splits certain areas from each other but avoids making this a permanent change so that other algorithms still can route through these regions.
                if (ruleLookup != null && ruleLookup.size() > 0) {
                    prep.setSpatialRuleLookup(ruleLookup);
                }
            }
        }

        super.loadOrPrepareLM();
    }
}