com.graphhopper.storage.index.LocationIndex Maven / Gradle / Ivy
/*
* 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.storage.index;
import com.graphhopper.routing.util.EdgeFilter;
import com.graphhopper.storage.Storable;
import com.graphhopper.util.shapes.BBox;
/**
* Provides a way to map real world data "lat,lon" to internal ids/indices of a memory efficient graph
* - often just implemented as an array.
*
* The implementations of findID needs to be thread safe!
*
*
* @author Peter Karich
*/
public interface LocationIndex extends Storable {
/**
* This method returns the closest Snap for the specified location (lat, lon) and only if
* the filter accepts the edge as valid candidate (e.g. filtering away car-only results for bike
* search)
*
*
* @param edgeFilter if a graph supports multiple vehicles we have to make sure that the entry
* node into the graph is accessible from a selected vehicle. E.g. if you have a FOOT-query do:
*
AccessFilter.allEdges(footFlagEncoder);
* @return An object containing the closest node and edge for the specified location. The node id
* has at least one edge which is accepted by the specified edgeFilter. If nothing is found
* the method Snap.isValid will return false.
*/
Snap findClosest(double lat, double lon, EdgeFilter edgeFilter);
/**
* This method explores the LocationIndex with the specified Visitor. It visits only the stored edges (and only once)
* and limited by the queryBBox. Also (a few) more edges slightly outside of queryBBox could be
* returned that you can avoid via doing an explicit BBox check of the coordinates.
*/
void query(BBox queryBBox, Visitor function);
/**
* This interface allows to visit edges stored in the LocationIndex.
*/
@FunctionalInterface
interface Visitor {
void onEdge(int edgeId);
default boolean isTileInfo() {
return false;
}
/**
* This method is called if isTileInfo returns true.
*/
default void onTile(BBox bbox, int depth) {
}
}
}