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

Class LocationReferenceCreators

java.lang.Object

com.here.platform.location.referencing.javadsl.LocationReferenceCreators

public class LocationReferenceCreators
extends Object

Provides LocationReferenceCreators factories to create different location reference types from Location Library data model specific representations.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference>	extendedTmc()	Generates a creator for ExtendedTMCLocationReferences.
LocationReferenceCreator<ReferencingLocation,OpenLRLocationReference>	olr()	Generates a creator for OpenLRLocationReferences from ReferencingLocations.
static LocationReferenceCreator<CircleLocation,CircleLocationReference>	olrCircle()	Generates a creator for CircleLocationReference.
LocationReferenceCreator<ClosedLinearLocation,ClosedLinearLocationReference>	olrClosedLinear()	Generates a creator for ClosedLinearLocationReferences.
static LocationReferenceCreator<GeoCoordinateLocation,GeoCoordinateLocationReference>	olrGeoCoordinate()	Generates a creator for GeoCoordinateLocationReference.
static <GC> LocationReferenceCreator<GC,GeoCoordinateLocationReference>	olrGeoCoordinate(GeoCoordinateAdapter<GC> adapter)	Generates a creator for GeoCoordinateLocationReference.
static <GC extends GeoCoordinateHolder> LocationReferenceCreator<GC,GeoCoordinateLocationReference>	olrGeoCoordinateFromHolder()	Generates a creator for GeoCoordinateLocationReference.
static LocationReferenceCreator<GridLocation,GridLocationReference>	olrGrid()	Generates a creator for GridLocationReference.
LocationReferenceCreator<LinearLocation,LinearLocationReference>	olrLinear()	Generates a creator for LinearLocationReferences.
LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference>	olrPointAlongLine()	Generates a creator for PointAlongLineLocationReferences.
LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference>	olrPoiWithAccessPoint()	Generates a creator for POIWithAccessPointLocationReferences.
static LocationReferenceCreator<PolygonLocation,PolygonLocationReference>	olrPolygon()	Generates a creator for PolygonLocationReference.
static <LR, P> LocationReferenceCreator<LR,PolygonLocationReference>	olrPolygon(LinearRingAdapter<LR,P> linearRingAdapter, GeoCoordinateAdapter<P> pointAdapter)	Generates a creator for PolygonLocationReference.
static <LR extends LinearRingHolder<C>, C extends GeoCoordinateHolder> LocationReferenceCreator<LR,PolygonLocationReference>	olrPolygonFromHolder()	Generates a creator for PolygonLocationReference.
static LocationReferenceCreator<RectangleLocation,RectangleLocationReference>	olrRectangle()	Generates a creator for RectangleLocationReference.
static <BB> LocationReferenceCreator<BB,RectangleLocationReference>	olrRectangle(BoundingBoxAdapter<BB> adapter)	Generates a creator for RectangleLocationReference.
static <BB extends BoundingBoxHolder> LocationReferenceCreator<BB,RectangleLocationReference>	olrRectangleFromHolder()	Generates a creator for RectangleLocationReference.
LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage>	piecewiseExtendedTmc()	Generates a creator for PiecewiseTmcCoverage.
LocationReferenceCreator<LinearLocation,TMCLocationReference>	tmc()	Generates a creator for simple TMCLocationReferences.

Methods inherited from class java.lang.Object

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

Constructor Details

LocationReferenceCreators

public LocationReferenceCreators(OptimizedMapLayers optimizedMapLayers)

LocationReferenceCreators

public LocationReferenceCreators(OptimizedMapLayers optimizedMapLayers,
 TmcAdjacencyProvider adjacencyProvider)

Parameters:

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

Method Details

tmc

public LocationReferenceCreator<LinearLocation,TMCLocationReference> tmc()

Generates a creator for simple TMCLocationReferences.

This reference creator takes a LinearLocation and returns a simple TMC location reference. The simple TMC reference will have preciseTMCInfo populated to match the LinearLocation that was passed in. The resolution of the produced PreciseTMCInformation is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.

Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded in TMC. In such cases the creator will throw a TmcCreatorException.

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

Note that without passing in a valid adjacencyProvider this API only supports creating references with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

extendedTmc

public LocationReferenceCreator<LinearLocation,ExtendedTMCLocationReference> extendedTmc()

Generates a creator for ExtendedTMCLocationReferences.

This reference creator takes a LinearLocation and returns an extended TMC location reference. The extended TMC reference will have preciseTMCInfo populated to match the LinearLocation that was passed in. The resolution of the produced PreciseTMCInformation is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.

This creator will always return ExtendedTMCLocationReferences that contain a tmcLocation, not a tmcExitEntryLocation.

Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded in TMC. In such cases the creator will throw a TmcCreatorException.

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

Note that this method has the same behavior as the corresponding V2 static method.

Note that without passing in a valid adjacencyProvider this API only supports creating references with extent < 1. If no adjacencyProvider is given, the creator will fail with a NoLinearAvailableException if the given location is not fully covered by the same location code.

piecewiseExtendedTmc

public LocationReferenceCreator<LinearLocation,PiecewiseTmcCoverage> piecewiseExtendedTmc()

Generates a creator for PiecewiseTmcCoverage.

Because TMC relies on pre-coded, shared location tables, it is possible that a LinearLocation can not be encoded or not fully encoded in TMC.

This reference creator takes a LinearLocation and returns the potentially piecewise TMC coverage for those parts of the given LinearLocation that can be encoded into TMC.

The extended TMC references will have preciseTMCInfo populated to match the LinearLocation that was passed in. The resolution of the produced preciseTMCInfo is 100m. The rounding is done in such a way that the TMC reference covers the full linear location, so it might be up to 100m longer at each end.

This creator will always return PiecewiseTmcCoverages that contain TMCLocationReferences, not TMCExitEntryLocationReferences.

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

Note that without passing in a valid adjacencyProvider this API only supports creating references with extent < 1. If no adjacencyProvider is given, the creator will create multiple location references, one reference for each location code on the path.

Note that this method has the same behavior as the corresponding V2 static method.

olrLinear

public LocationReferenceCreator<LinearLocation,LinearLocationReference> olrLinear()

Generates a creator for LinearLocationReferences.

As a LinearLocationReference refers to a path in the road network, you need to create this reference against a map.

olrClosedLinear

public LocationReferenceCreator<ClosedLinearLocation,ClosedLinearLocationReference> olrClosedLinear()

Generates a creator for ClosedLinearLocationReferences.

A ClosedLinearLocationReference refers to a closed path in the road network and thus needs to be created against a map.

olrPointAlongLine

public LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference> olrPointAlongLine()

Generates a creator for PointAlongLineLocationReferences.

A PointAlongLineLocationReference refers to a point on a road section and thus needs to be created against a map.

olrPoiWithAccessPoint

public LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference> olrPoiWithAccessPoint()

Generates a creator for POIWithAccessPointLocationReferences.

A POIWithAccessPointLocationReference refers to an access point on a road section and thus needs to be created against a map.

olrRectangle

public static LocationReferenceCreator<RectangleLocation,RectangleLocationReference> olrRectangle()

Generates a creator for RectangleLocationReference.

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 created.

olrRectangle

public static <BB>
LocationReferenceCreator<BB,RectangleLocationReference> olrRectangle(BoundingBoxAdapter<BB> adapter)

Generates a creator for RectangleLocationReference.

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 created.

Parameters:

adapter - Adapter to extract north/south latitudes and east/west longitudes from BB

olrRectangleFromHolder

public static <BB extends BoundingBoxHolder>
LocationReferenceCreator<BB,RectangleLocationReference> olrRectangleFromHolder()

Generates a creator for RectangleLocationReference.

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 created.

olrGeoCoordinate

public static LocationReferenceCreator<GeoCoordinateLocation,GeoCoordinateLocationReference> olrGeoCoordinate()

Generates a creator for GeoCoordinateLocationReference.

This creator converts WGS84 coordinates to OLR geocoordinates represented by integer values.

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

olrGeoCoordinate

public static <GC>
LocationReferenceCreator<GC,GeoCoordinateLocationReference> olrGeoCoordinate(GeoCoordinateAdapter<GC> adapter)

Generates a creator for GeoCoordinateLocationReference.

This creator converts WGS84 coordinates to OLR geocoordinates represented by integer values.

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

olrGeoCoordinateFromHolder

public static <GC extends GeoCoordinateHolder>
LocationReferenceCreator<GC,GeoCoordinateLocationReference> olrGeoCoordinateFromHolder()

Generates a creator for GeoCoordinateLocationReference.

This creator converts WGS84 coordinates to OLR geocoordinates represented by integer values.

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

olrPolygon

public static LocationReferenceCreator<PolygonLocation,PolygonLocationReference> olrPolygon()

Generates a creator for PolygonLocationReference.

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 created.

olrPolygon

public static <LR,
P>
LocationReferenceCreator<LR,PolygonLocationReference> olrPolygon(LinearRingAdapter<LR,P> linearRingAdapter,
 GeoCoordinateAdapter<P> pointAdapter)

Generates a creator for PolygonLocationReference.

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 created.

Parameters:

linearRingAdapter - Adapter to obtain points from a linear ring

pointAdapter - Adapter to extract latitude and longitude for P

olrPolygonFromHolder

public static <LR extends LinearRingHolder<C>,
C extends GeoCoordinateHolder>
LocationReferenceCreator<LR,PolygonLocationReference> olrPolygonFromHolder()

Generates a creator for PolygonLocationReference.

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 created.

olrCircle

public static LocationReferenceCreator<CircleLocation,CircleLocationReference> olrCircle()

Generates a creator for CircleLocationReference.

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 created.

olrGrid

public static LocationReferenceCreator<GridLocation,GridLocationReference> olrGrid()

Generates a creator for GridLocationReference.

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 created.

olr

public LocationReferenceCreator<ReferencingLocation,OpenLRLocationReference> olr()

Generates a creator for OpenLRLocationReferences from ReferencingLocations.

This creator chooses the correct type of OpenLR reference depending on the actual subtype of ReferencingLocation that is being passed in.