com.graphhopper.routing.util.spatialrules

Interface SpatialRuleLookup

All Known Implementing Classes:

SpatialRuleLookupJTS

public interface SpatialRuleLookup

SpatialRuleLookup defines a container that stores SpatialRules and can lookup a SpatialRule rule depending on the location.

Author:

Robin Boldt

Field Summary

Fields

Modifier and Type	Field and Description
static SpatialRuleLookup	EMPTY

Method Summary

Modifier and Type	Method and Description
org.locationtech.jts.geom.Envelope	getBounds()
int	getSpatialId(SpatialRule rule) This method returns an identification number from 0 to size (exclusive) for the specified rule.
SpatialRule	getSpatialRule(int spatialId) This method returns the SpatialRule for a given Spatial Id.
SpatialRule	lookupRule(double lat, double lon) Return an applicable rule for this location.
SpatialRule	lookupRule(GHPoint point) See lookupRule(double, double) for details.
int	size()

Field Detail

EMPTY

static final SpatialRuleLookup EMPTY

Method Detail

lookupRule

SpatialRule lookupRule(double lat,
                       double lon)

Return an applicable rule for this location. If there is more than one rule for the location, the implementation can decide which rule to return. For example this might be the first occurring or the most relevant, see the implementation JavaDoc.

If the requested location is outside of the supported bounds or no SpatialRule is registered at this location SpatialRule.EMPTY is returned.

lookupRule

SpatialRule lookupRule(GHPoint point)

See lookupRule(double, double) for details.

getSpatialId

int getSpatialId(SpatialRule rule)

This method returns an identification number from 0 to size (exclusive) for the specified rule. The id is fix for a given set of SpatialRules.

getSpatialRule

SpatialRule getSpatialRule(int spatialId)

This method returns the SpatialRule for a given Spatial Id. This can be used when retrieving SpatialRules from a Spatial Id stored in the graph.

size

int size()

Returns:

the number of rules added to this lookup.

getBounds

org.locationtech.jts.geom.Envelope getBounds()

Returns:

the bounds of the SpatialRuleLookup