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

Class LocationReferenceResolvers

java.lang.Object

com.here.platform.location.referencing.javadsl.LocationReferenceResolvers

public class LocationReferenceResolvers
extends Object

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

Constructor Summary

Constructors

Constructor	Description
LocationReferenceResolvers(OptimizedMapLayers optimizedMapLayers)
LocationReferenceResolvers(OptimizedMapLayers optimizedMapLayers, TmcAdjacencyProvider adjacencyProvider)

Method Summary

Modifier and Type	Method	Description
LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation>	extendedTmc()	Creates a resolver for ExtendedTMCLocationReferences.
static LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation>	extendedTmcV2(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).extendedTmc().
static LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation>	extendedTmcV2(Catalog optimizedMap, DataLoaderProvider cacheManager, TmcAdjacencyProvider adjacencyProvider)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers, adjacencyProvider).extendedTmc().
LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation>	olr()	Creates a resolver that resolves OpenLRLocationReferences to ReferencingLocations.
static LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation>	olr(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).olr().
static LocationReferenceResolver<CircleLocationReference,CircleLocation>	olrCircle()	Creates a resolver for CircleLocationReferences.
LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation>	olrClosedLinear()	Creates a resolver for ClosedLinearLocationReferences.
static LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation>	olrClosedLinear(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).olrClosedLinear().
static LocationReferenceResolver<GeoCoordinateLocationReference,GeoCoordinateLocation>	olrGeoCoordinate()	Creates a resolver for GeoCoordinateLocationReference.
static LocationReferenceResolver<GridLocationReference,GridLocation>	olrGrid()	Creates a resolver for GridLocationReferences.
LocationReferenceResolver<LinearLocationReference,LinearLocation>	olrLinear()	Creates a resolver for LinearLocationReferences.
static LocationReferenceResolver<LinearLocationReference,LinearLocation>	olrLinear(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).olrLinear().
LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint>	olrPointAlongLine()	Creates a resolver for PointAlongLineLocationReferences.
static LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint>	olrPointAlongLine(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).olrPointAlongLine().
LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest>	olrPoiWithAccessPoint()	Creates a resolver for POIWithAccessPointLocationReferences.
static LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest>	olrPoiWithAccessPoint(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).olrPoiWithAccessPoint().
static LocationReferenceResolver<PolygonLocationReference,PolygonLocation>	olrPolygon()	Creates a resolver for PolygonLocationReferences.
static LocationReferenceResolver<RectangleLocationReference,RectangleLocation>	olrRectangle()	Creates a resolver for RectangleLocationReferences.
LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation>	tmc()	Creates a resolver for simple TMCLocationReferences.
static LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation>	tmc(Catalog optimizedMap, DataLoaderProvider cacheManager)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers).tmc().
static LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation>	tmc(Catalog optimizedMap, DataLoaderProvider cacheManager, TmcAdjacencyProvider adjacencyProvider)	Deprecated. Prefer new LocationReferenceResolvers(optimizedMapLayers, adjacencyProvider).tmc().

Methods inherited from class java.lang.Object

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

Constructor Details

LocationReferenceResolvers

public LocationReferenceResolvers(OptimizedMapLayers optimizedMapLayers)

LocationReferenceResolvers

public LocationReferenceResolvers(OptimizedMapLayers optimizedMapLayers,
 TmcAdjacencyProvider adjacencyProvider)

Parameters:

adjacencyProvider - Provides information about TMC location adjacency to support creation of references with extent > 1.

Method Details

tmc

public LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation> tmc()

Creates a resolver for simple TMCLocationReferences.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Note that without passing in a valid adjacencyProvider this API only supports resolving references with extent <= 1. To get support for a longer extent an adjacencyProvider needs to be passed in.

Note that this API only supports decoding of references with a valid extendedCountryCode.

extendedTmc

public LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation> extendedTmc()

Creates a resolver for ExtendedTMCLocationReferences.

ExtendedTMCLocationReference have two fields with location reference: tmcLocation or tmcExitEntryLocation.tmcLocation. Per the standard, only one of these two should be defined. This resolver uses the tmcLocation field by default, and falls back to the other in case the former is not present.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Note that without passing in a valid adjacencyProvider this API only supports resolving references with extent <= 1. To get support for a longer extent an adjacencyProvider needs to be passed in.

Note that this API only supports decoding of references with a valid extendedCountryCode.

Note This method has the same behavior as the V2 method of the companion object.

tmc

@Deprecated
public static LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation> tmc(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).tmc().

Creates a resolver for simple TMCLocationReferences.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Note that this resolver only supports decoding of references with extent <= 1 and a valid extendedCountryCode. To get support for a longer extent an adjacencyProvider needs to be passed in.

Parameters:

optimizedMap - An Optimized Map for Location Library instance

tmc

@Deprecated
public static LocationReferenceResolver<TMCLocationReference,BidirectionalLinearLocation> tmc(Catalog optimizedMap,
 DataLoaderProvider cacheManager,
 TmcAdjacencyProvider adjacencyProvider)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers, adjacencyProvider).tmc().

Creates a resolver for simple TMCLocationReferences.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Note that this API only supports decoding of references with a valid extendedCountryCode.

Parameters:

optimizedMap - An Optimized Map for Location Library instance

adjacencyProvider - The adjacencyProvider is needed to decode references with extent > 1.

extendedTmcV2

@Deprecated
public static LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation> extendedTmcV2(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).extendedTmc().

Creates a resolver for ExtendedTMCLocationReferences.

ExtendedTMCLocationReference have two fields with location reference: tmcLocation or tmcExitEntryLocation.tmcLocation. Per the standard, only one of these two should be defined. This resolver uses the tmcLocation field by default, and falls back to the other in case the former is not present.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Note that this resolver only supports decoding of references with extent <= 1 and a valid extendedCountry Code. To get support for a longer extent an adjacencyProvider needs to be passed in. *

Parameters:

optimizedMap - An Optimized Map for Location Library instance

extendedTmcV2

@Deprecated
public static LocationReferenceResolver<ExtendedTMCLocationReference,BidirectionalLinearLocation> extendedTmcV2(Catalog optimizedMap,
 DataLoaderProvider cacheManager,
 TmcAdjacencyProvider adjacencyProvider)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers, adjacencyProvider).extendedTmc().

Creates a resolver for ExtendedTMCLocationReferences.

ExtendedTMCLocationReference have two fields with location reference: tmcLocation or tmcExitEntryLocation.tmcLocation. Per the standard, only one of these two should be defined. This resolver uses the tmcLocation field by default, and falls back to the other in case the former is not present.

TMC resolvers return a BidirectionalLinearLocation because TMC location references can, at the same time, refer to the positive and negative parts of the location.

For details on how TMC works, see the Developer Guide.

Parameters:

optimizedMap - An Optimized Map for Location Library instance.

adjacencyProvider - The adjacencyProvider is needed to decode references with extent > 1.

olrLinear

public LocationReferenceResolver<LinearLocationReference,LinearLocation> olrLinear()

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.

olrLinear

@Deprecated
public static LocationReferenceResolver<LinearLocationReference,LinearLocation> olrLinear(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).olrLinear().

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.

Parameters:

optimizedMap - An Optimized Map for Location Library instance.

olrClosedLinear

@Deprecated
public static LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation> olrClosedLinear(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).olrClosedLinear().

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.

Parameters:

optimizedMap - An Optimized Map for Location Library instance

olrPointAlongLine

public LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint> olrPointAlongLine()

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.

olrClosedLinear

public LocationReferenceResolver<ClosedLinearLocationReference,ClosedLinearLocation> olrClosedLinear()

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.

olrPointAlongLine

@Deprecated
public static LocationReferenceResolver<PointAlongLineLocationReference,AccessPoint> olrPointAlongLine(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).olrPointAlongLine().

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.

Parameters:

optimizedMap - An Optimized Map for Location Library instance.

olrPoiWithAccessPoint

public LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest> olrPoiWithAccessPoint()

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.

olrPoiWithAccessPoint

@Deprecated
public static LocationReferenceResolver<POIWithAccessPointLocationReference,PointOfInterest> olrPoiWithAccessPoint(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).olrPoiWithAccessPoint().

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.

Parameters:

optimizedMap - An Optimized Map for Location Library instance.

olrRectangle

public static LocationReferenceResolver<RectangleLocationReference,RectangleLocation> olrRectangle()

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.

olrGeoCoordinate

public static LocationReferenceResolver<GeoCoordinateLocationReference,GeoCoordinateLocation> olrGeoCoordinate()

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.

olrPolygon

public static LocationReferenceResolver<PolygonLocationReference,PolygonLocation> olrPolygon()

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.

olrCircle

public static LocationReferenceResolver<CircleLocationReference,CircleLocation> olrCircle()

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.

olrGrid

public static LocationReferenceResolver<GridLocationReference,GridLocation> olrGrid()

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
• PointAlongLineLocationReference
• ClosedLinearLocationReference
• POIWithAccessPointLocationReference

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

olr

@Deprecated
public static LocationReferenceResolver<OpenLRLocationReference,ReferencingLocation> olr(Catalog optimizedMap,
 DataLoaderProvider cacheManager)

Deprecated.

Prefer new LocationReferenceResolvers(optimizedMapLayers).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.

Parameters:

optimizedMap - An Optimized Map for Location Library instance