Package com.here.platform.location.referencing.javadsl

Class OlrLocationReferenceResolvers

java.lang.Object

com.here.platform.location.referencing.javadsl.OlrLocationReferenceResolvers

public class OlrLocationReferenceResolvers
extends Object

Provides factories for LocationReferenceResolvers to resolve different location reference types into Location Library data model specific representations.

Constructor Summary

Constructors

Constructor	Description
OlrLocationReferenceResolvers(OptimizedMapLayers optimizedMap)
OlrLocationReferenceResolvers(OlrLayers olrLayers)

Method Summary

Modifier and Type	Method	Description
static LocationReferenceResolver<CircleLocationReference,CircleLocation>	circle()	Creates a resolver for CircleLocationReferences.
LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation>	closedLinear()	Creates a resolver for ClosedLinearLocationReferences.
static LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation>	closedLinear(ProximitySearch<GeoCoordinate,Vertex> proximitySearch, DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
static LocationReferenceResolver<GeoCoordinateLocationReference,GeoCoordinateLocation>	geoCoordinate()	Creates a resolver for GeoCoordinateLocationReference.
static LocationReferenceResolver<GridLocationReference,GridLocation>	grid()	Creates a resolver for GridLocationReferences.
LocationReferenceResolver<LinearLocationReference,LinearLocation>	linear()	Creates a resolver for LinearLocationReferences.
static LocationReferenceResolver<LinearLocationReference,LinearLocation>	linear(ProximitySearch<GeoCoordinate,Vertex> proximitySearch, DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation>	olr()	Creates a resolver that resolves OpenLRLocationReferences to ReferencingLocations.
static LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation>	olr(ProximitySearch<GeoCoordinate,Vertex> proximitySearch, DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint>	pointAlongLine()	Creates a resolver for PointAlongLineLocationReferences.
static LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint>	pointAlongLine(ProximitySearch<GeoCoordinate,Vertex> proximitySearch, DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest>	poiWithAccessPoint()	Creates a resolver for POIWithAccessPointLocationReferences.
static LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest>	poiWithAccessPoint(ProximitySearch<GeoCoordinate,Vertex> proximitySearch, DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
static LocationReferenceResolver<PolygonLocationReference,PolygonLocation>	polygon()	Creates a resolver for PolygonLocationReferences.
static LocationReferenceResolver<RectangleLocationReference,RectangleLocation>	rectangle()	Creates a resolver for RectangleLocationReferences.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OlrLocationReferenceResolvers

public OlrLocationReferenceResolvers(OlrLayers olrLayers)

OlrLocationReferenceResolvers

public OlrLocationReferenceResolvers(OptimizedMapLayers optimizedMap)

Method Details

linear

public LocationReferenceResolver<LinearLocationReference,LinearLocation> linear()

Creates a resolver for LinearLocationReferences.

A LinearLocationReference refers to a path in the road network and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

pointAlongLine

public LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint> pointAlongLine()

Creates a resolver for PointAlongLineLocationReferences.

A PointAlongLineLocationReference refers to a point on a road section and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

closedLinear

public LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation> closedLinear()

Creates a resolver for ClosedLinearLocationReferences.

A ClosedLinearLocationReference refers to a closed path in the road network and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

poiWithAccessPoint

public LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest> poiWithAccessPoint()

Creates a resolver for POIWithAccessPointLocationReferences.

A POIWithAccessPointLocationReference refers to an access point on a road section and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

rectangle

public static LocationReferenceResolver<RectangleLocationReference,RectangleLocation> rectangle()

Creates a resolver for RectangleLocationReferences.

A rectangle location reference is based on rectangular shapes and is defined in terms of a pair of geopoints, defining north/south latitude limits, and east/west longitude limits.

This reference type is disconnected from the road network, and does not require a catalog to be resolved.

geoCoordinate

public static LocationReferenceResolver<GeoCoordinateLocationReference,GeoCoordinateLocation> geoCoordinate()

Creates a resolver for GeoCoordinateLocationReference.

OLR's geocoordinates are represented by integer values. This resolver converts them back to WGS84 coordinates.

This reference type is disconnected from the road network, and does not require a catalog to be resolved.

polygon

public static LocationReferenceResolver<PolygonLocationReference,PolygonLocation> polygon()

Creates a resolver for PolygonLocationReferences.

A polygon location is a non-intersecting shape defined by a sequence of geocoordinate pairs. It can be used to represent any complex area in the map, like a low emission zone, or an area where traffic is overloaded.

This reference type is disconnected from the road network, and does not require a catalog to be resolved.

circle

public static LocationReferenceResolver<CircleLocationReference,CircleLocation> circle()

Creates a resolver for CircleLocationReferences.

A circle location is given by a geo-location of the center of the circle and its radius.

Real-world examples include a Wi-Fi hotspot with its signal range, or the center and radius used with a proximity search.

This reference type is disconnected from the road network, and does not require a catalog to be resolved.

grid

public static LocationReferenceResolver<GridLocationReference,GridLocation> grid()

Creates a resolver for GridLocationReferences.

Grid locations are defined in terms of a base rectangle location and a number of rows and columns. The base rectangle is multiplied to the north by the the number of rows and to the east by the number of columns.

Weather reports are a real-world example for this reference type. For instance, average rainfall could be defined for every cell of the grid.

This reference type is disconnected from the road network, and does not require a catalog to be resolved.

GridLocation provides methods to retrieve all the bounding boxes that compose the grid.

olr

public LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation> olr()

Creates a resolver that resolves OpenLRLocationReferences to ReferencingLocations.

This resolver chooses the correct type of ReferencingLocation based on the type the OpenLR reference that is being passed in. For the following reference types an OlrResolverException can be thrown if the reference cannot be resolved:

• LinearLocationReference
• ClosedLinearLocationReference
• PointAlongLineLocationReference
• POIWithAccessPointLocationReference

Specific cases where this can happen are described in the documentation of the exception class.

linear

public static LocationReferenceResolver<LinearLocationReference,LinearLocation> linear(ProximitySearch<GeoCoordinate,Vertex> proximitySearch,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries,
 PropertyMap<Vertex,Double> lengths,
 RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible,
 RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass,
 RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)

This is an experimental API. It may be removed or changed in future versions.

Creates a resolver for LinearLocationReferences.

A LinearLocationReference refers to a path in the road network and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

closedLinear

public static LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation> closedLinear(ProximitySearch<GeoCoordinate,Vertex> proximitySearch,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries,
 PropertyMap<Vertex,Double> lengths,
 RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible,
 RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass,
 RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)

This is an experimental API. It may be removed or changed in future versions.

Creates a resolver for ClosedLinearLocationReferences.

A ClosedLinearLocationReference refers to a closed path in the road network and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

pointAlongLine

public static LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint> pointAlongLine(ProximitySearch<GeoCoordinate,Vertex> proximitySearch,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries,
 PropertyMap<Vertex,Double> lengths,
 RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible,
 RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass,
 RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)

This is an experimental API. It may be removed or changed in future versions.

Creates a resolver for PointAlongLineLocationReferences.

A PointAlongLineLocationReference refers to a point on a road section and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

poiWithAccessPoint

public static LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest> poiWithAccessPoint(ProximitySearch<GeoCoordinate,Vertex> proximitySearch,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries,
 PropertyMap<Vertex,Double> lengths,
 RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible,
 RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass,
 RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)

This is an experimental API. It may be removed or changed in future versions.

Creates a resolver for POIWithAccessPointLocationReferences.

A POIWithAccessPointLocationReference refers to an access point on a road section and thus needs to be resolved against a map. If the reference cannot be resolved an OlrResolverException is thrown. Specific cases where this can happen are described in the documentation of the exception class.

olr

public static LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation> olr(ProximitySearch<GeoCoordinate,Vertex> proximitySearch,
 DirectedGraph<Vertex,Edge> graph,
 PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries,
 PropertyMap<Vertex,Double> lengths,
 RangeBasedPropertyMap<Vertex,Boolean> isRoadAccessible,
 RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass,
 RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)

This is an experimental API. It may be removed or changed in future versions.

Creates a resolver that resolves OpenLRLocationReferences to ReferencingLocations.

This resolver chooses the correct type of ReferencingLocation based on the type the OpenLR reference that is being passed in. For the following reference types an OlrResolverException can be thrown if the reference cannot be resolved:

• LinearLocationReference
• ClosedLinearLocationReference
• PointAlongLineLocationReference
• POIWithAccessPointLocationReference

Specific cases where this can happen are described in the documentation of the exception class.