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

Class OlrLocationReferenceCreators

java.lang.Object

com.here.platform.location.referencing.javadsl.OlrLocationReferenceCreators

public class OlrLocationReferenceCreators
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static LocationReferenceCreator<CircleLocation,CircleLocationReference>	circle()	Generates a creator for CircleLocationReference.
LocationReferenceCreator<ClosedLinearLocation,ClosedLinearLocationReference>	closedLinear()	Generates a creator for ClosedLinearLocationReferences.
static LocationReferenceCreator<ClosedLinearLocation,ClosedLinearLocationReference>	closedLinear(DirectedGraph<Vertex,Edge> graph, PropertyMap<Vertex,LineStringHolder<GeoCoordinate>> geometries, PropertyMap<Vertex,Double> lengths, RangeBasedPropertyMap<Vertex,FunctionalClass> functionalClass, RangeBasedPropertyMap<Vertex,FormOfWay> formOfWay)	This is an experimental API.
static LocationReferenceCreator<GeoCoordinateLocation,GeoCoordinateLocationReference>	geoCoordinate()	Generates a creator for GeoCoordinateLocationReference.
static <GC> LocationReferenceCreator<GC,GeoCoordinateLocationReference>	geoCoordinate(GeoCoordinateAdapter<GC> adapter)	Generates a creator for GeoCoordinateLocationReference.
static <GC extends GeoCoordinateHolder> LocationReferenceCreator<GC,GeoCoordinateLocationReference>	geoCoordinateFromHolder()	Generates a creator for GeoCoordinateLocationReference.
static LocationReferenceCreator<GridLocation,GridLocationReference>	grid()	Generates a creator for GridLocationReference.
LocationReferenceCreator<LinearLocation,LinearLocationReference>	linear()	Generates a creator for LinearLocationReferences.
static LocationReferenceCreator<LinearLocation,LinearLocationReference>	linear(DirectedGraph<Vertex,Edge> graph, DirectedGraph<Vertex,Edge> reverseGraph, 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.
LocationReferenceCreator<ReferencingLocation,OpenLRLocationReference>	olr()	Generates a creator for OpenLRLocationReferences from ReferencingLocations.
static LocationReferenceCreator<ReferencingLocation,OpenLRLocationReference>	olr(DirectedGraph<Vertex,Edge> graph, DirectedGraph<Vertex,Edge> reverseGraph, 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.
LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference>	pointAlongLine()	Generates a creator for PointAlongLineLocationReferences.
static LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference>	pointAlongLine(DirectedGraph<Vertex,Edge> graph, DirectedGraph<Vertex,Edge> reverseGraph, 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.
LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference>	poiWithAccessPoint()	Generates a creator for POIWithAccessPointLocationReferences.
static LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference>	poiWithAccessPoint(DirectedGraph<Vertex,Edge> graph, DirectedGraph<Vertex,Edge> reverseGraph, 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 LocationReferenceCreator<PolygonLocation,PolygonLocationReference>	polygon()	Generates a creator for PolygonLocationReference.
static <LR, P> LocationReferenceCreator<LR,PolygonLocationReference>	polygon(LinearRingAdapter<LR,P> linearRingAdapter, GeoCoordinateAdapter<P> pointAdapter)	Generates a creator for PolygonLocationReference.
static <LR extends LinearRingHolder<C>, C extends GeoCoordinateHolder> LocationReferenceCreator<LR,PolygonLocationReference>	polygonFromHolder()	Generates a creator for PolygonLocationReference.
static LocationReferenceCreator<RectangleLocation,RectangleLocationReference>	rectangle()	Generates a creator for RectangleLocationReference.
static <BB> LocationReferenceCreator<BB,RectangleLocationReference>	rectangle(BoundingBoxAdapter<BB> adapter)	Generates a creator for RectangleLocationReference.
static <BB extends BoundingBoxHolder> LocationReferenceCreator<BB,RectangleLocationReference>	rectangleFromHolder()	Generates a creator for RectangleLocationReference.

Methods inherited from class java.lang.Object

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

Constructor Details

OlrLocationReferenceCreators

public OlrLocationReferenceCreators(OlrLayers olrLayers)

OlrLocationReferenceCreators

public OlrLocationReferenceCreators(OptimizedMapLayers optimizedMap)

Method Details

linear

public LocationReferenceCreator<LinearLocation,LinearLocationReference> linear()

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.

closedLinear

public LocationReferenceCreator<ClosedLinearLocation,ClosedLinearLocationReference> closedLinear()

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.

pointAlongLine

public LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference> pointAlongLine()

Generates a creator for PointAlongLineLocationReferences.

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

poiWithAccessPoint

public LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference> poiWithAccessPoint()

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.

rectangle

public static LocationReferenceCreator<RectangleLocation,RectangleLocationReference> rectangle()

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.

rectangle

public static <BB>
LocationReferenceCreator<BB,RectangleLocationReference> rectangle(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

rectangleFromHolder

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

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.

geoCoordinate

public static LocationReferenceCreator<GeoCoordinateLocation,GeoCoordinateLocationReference> geoCoordinate()

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.

geoCoordinate

public static <GC>
LocationReferenceCreator<GC,GeoCoordinateLocationReference> geoCoordinate(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.

geoCoordinateFromHolder

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

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.

polygon

public static LocationReferenceCreator<PolygonLocation,PolygonLocationReference> polygon()

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.

polygon

public static <LR,
P>
LocationReferenceCreator<LR,PolygonLocationReference> polygon(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

polygonFromHolder

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

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.

circle

public static LocationReferenceCreator<CircleLocation,CircleLocationReference> circle()

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.

grid

public static LocationReferenceCreator<GridLocation,GridLocationReference> grid()

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.

linear

public static LocationReferenceCreator<LinearLocation,LinearLocationReference> linear(DirectedGraph<Vertex,Edge> graph,
 DirectedGraph<Vertex,Edge> reverseGraph,
 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.

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.

closedLinear

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

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

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.

pointAlongLine

public static LocationReferenceCreator<AccessPoint,PointAlongLineLocationReference> pointAlongLine(DirectedGraph<Vertex,Edge> graph,
 DirectedGraph<Vertex,Edge> reverseGraph,
 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.

Generates a creator for PointAlongLineLocationReferences.

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

poiWithAccessPoint

public static LocationReferenceCreator<PointOfInterest,POIWithAccessPointLocationReference> poiWithAccessPoint(DirectedGraph<Vertex,Edge> graph,
 DirectedGraph<Vertex,Edge> reverseGraph,
 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.

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.

olr

public static LocationReferenceCreator<ReferencingLocation,OpenLRLocationReference> olr(DirectedGraph<Vertex,Edge> graph,
 DirectedGraph<Vertex,Edge> reverseGraph,
 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.

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.