openlr.location

Class LocationFactory

java.lang.Object

openlr.location.LocationFactory

public final class LocationFactory
extends Object

A factory for creating Location objects.

OpenLR is a trade mark of TomTom International B.V.

email: software@openlr.org

Author:

TomTom International B.V.

Method Summary

Modifier and Type	Method and Description
static Location	createCircleLocation(String idString, double lonDeg, double latDeg, long radius) Instantiates a new circle location.
static Location	createClosedLineLocation(String idString, List<? extends Line> loc) Instantiates a new location with a unique key and the location as a list of lines.
static Location	createGeoCoordinateLocation(String idString, double lonDeg, double latDeg) Instantiates a new geo coordinate location.
static Location	createGridLocationFromBasisCell(String idString, double lowerLeftLonDeg, double lowerLeftLatDeg, double upperRightLonDeg, double upperRightLatDeg, int ncols, int nrows) Instantiates a new grid location.
static Location	createGridLocationFromBasisCell(String idString, GeoCoordinates lowerLeft, GeoCoordinates upperRight, int ncols, int nrows) Creates a new Location object.
static Location	createGridLocationFromGridArea(String idString, double lowerLeftLonDeg, double lowerLeftLatDeg, double upperRightLonDeg, double upperRightLatDeg, int ncols, int nrows) Instantiates a new grid location.
static Location	createGridLocationFromGridArea(String string, GeoCoordinates lowerLeft, GeoCoordinates upperRight, int columns, int rows) Creates a new Location object.
static Location	createLineLocation(String idString, List<? extends Line> loc) Instantiates a new location with a unique key and the location as a list of lines.
static Location	createLineLocationWithOffsets(String idString, List<? extends Line> loc, int pOff, int nOff) Instantiates a new location with a unique key and the location as a list of lines including offset information used to find the precise location on the location path.
static Location	createNodeLocation(String idString, Line l) Instantiates a new point along line location at a network node.
static Location	createNodeLocationWithOrientation(String idString, Line l, Orientation o) Instantiates a new point along line location at a network node.
static Location	createNodeLocationWithSide(String idString, Line l, SideOfRoad s) Instantiates a new point along line location at a network node.
static Location	createNodeLocationWithSideAndOrientation(String idString, Line l, SideOfRoad s, Orientation o) Instantiates a new point along line location at a network node.
static Location	createPoiAccessAtNodeLocation(String idString, Line l, double lonDeg, double latDeg) Instantiates a new poi with access point location at a network node.
static Location	createPoiAccessAtNodeLocationWithOrientation(String idString, Line l, double lonDeg, double latDeg, Orientation o) Instantiates a new poi with access point location at a network node.
static Location	createPoiAccessAtNodeLocationWithSide(String idString, Line l, double lonDeg, double latDeg, SideOfRoad s) Instantiates a new poi with access point location at a network node.
static Location	createPoiAccessAtNodeLocationWithSideAndOrientation(String idString, Line l, double lonDeg, double latDeg, SideOfRoad s, Orientation o) Instantiates a new poi with access point location at a network node.
static Location	createPoiAccessLocation(String idString, Line l, int poff, double lonDeg, double latDeg) Instantiates a new poi with access point location.
static Location	createPoiAccessLocationWithOrientation(String idString, Line l, int poff, double lonDeg, double latDeg, Orientation o) Instantiates a new poi with access point location.
static Location	createPoiAccessLocationWithSide(String idString, Line l, int poff, double lonDeg, double latDeg, SideOfRoad s) Instantiates a new poi with access point location.
static Location	createPoiAccessLocationWithSideAndOrientation(String idString, Line l, int poff, double lonDeg, double latDeg, SideOfRoad s, Orientation o) Instantiates a new poi with access point location.
static Location	createPointAlongLineLocation(String idString, Line l, int poff) Instantiates a new point along line location.
static Location	createPointAlongLineLocationWithOrientation(String idString, Line l, int poff, Orientation o) Instantiates a new point along line location.
static Location	createPointAlongLineLocationWithSide(String idString, Line l, int poff, SideOfRoad s) Instantiates a new point along line location.
static Location	createPointAlongLineLocationWithSideAndOrientation(String idString, Line l, int poff, SideOfRoad s, Orientation o) Instantiates a new point along line location.
static Location	createPolygonLocation(String idString, List<? extends GeoCoordinates> cornerPoints) Instantiates a new polygon location.
static Location	createRectangleLocation(String idString, double lowerLeftLonDeg, double lowerLeftLatDeg, double upperRightLonDeg, double upperRightLatDeg) Instantiates a new rectangle location.
static Location	createRectangleLocation(String string, GeoCoordinates rectangleLL, GeoCoordinates rectangleUR) Creates a new Location object.

Methods inherited from class java.lang.Object

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

Method Detail

createLineLocationWithOffsets

public static Location createLineLocationWithOffsets(String idString,
                                                     List<? extends Line> loc,
                                                     int pOff,
                                                     int nOff)

Instantiates a new location with a unique key and the location as a list of lines including offset information used to find the precise location on the location path.

Parameters:

idString - the unique ID

loc - the location as a list of lines

pOff - the distance between the start of the location and the start of the precise location

nOff - the distance between the end of the location and the end of the precise location

Returns:

the location

createLineLocation

public static Location createLineLocation(String idString,
                                          List<? extends Line> loc)

Instantiates a new location with a unique key and the location as a list of lines. The positive and negative offset are treated as 0.

Parameters:

idString - the unique ID

loc - the location as a list of lines

Returns:

the location

createGeoCoordinateLocation

public static Location createGeoCoordinateLocation(String idString,
                                                   double lonDeg,
                                                   double latDeg)
                                            throws InvalidMapDataException

Instantiates a new geo coordinate location.

Parameters:

idString - the id string

lonDeg - the longitude

latDeg - the latitude

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPointAlongLineLocationWithSideAndOrientation

public static Location createPointAlongLineLocationWithSideAndOrientation(String idString,
                                                                          Line l,
                                                                          int poff,
                                                                          SideOfRoad s,
                                                                          Orientation o)
                                                                   throws InvalidMapDataException

Instantiates a new point along line location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

s - the side of road

o - the oroentation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPointAlongLineLocationWithSide

public static Location createPointAlongLineLocationWithSide(String idString,
                                                            Line l,
                                                            int poff,
                                                            SideOfRoad s)
                                                     throws InvalidMapDataException

Instantiates a new point along line location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

s - the side of road

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPointAlongLineLocationWithOrientation

public static Location createPointAlongLineLocationWithOrientation(String idString,
                                                                   Line l,
                                                                   int poff,
                                                                   Orientation o)
                                                            throws InvalidMapDataException

Instantiates a new point along line location.

Parameters:

idString - the id string

l - the lien

poff - the positive offset

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPointAlongLineLocation

public static Location createPointAlongLineLocation(String idString,
                                                    Line l,
                                                    int poff)
                                             throws InvalidMapDataException

Instantiates a new point along line location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createNodeLocationWithSide

public static Location createNodeLocationWithSide(String idString,
                                                  Line l,
                                                  SideOfRoad s)
                                           throws InvalidMapDataException

Instantiates a new point along line location at a network node.

Parameters:

idString - the id string

l - the line

s - the side of road

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createNodeLocationWithOrientation

public static Location createNodeLocationWithOrientation(String idString,
                                                         Line l,
                                                         Orientation o)
                                                  throws InvalidMapDataException

Instantiates a new point along line location at a network node.

Parameters:

idString - the id string

l - the line

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createNodeLocationWithSideAndOrientation

public static Location createNodeLocationWithSideAndOrientation(String idString,
                                                                Line l,
                                                                SideOfRoad s,
                                                                Orientation o)
                                                         throws InvalidMapDataException

Instantiates a new point along line location at a network node.

Parameters:

idString - the id string

l - the line

s - the side of road

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createNodeLocation

public static Location createNodeLocation(String idString,
                                          Line l)
                                   throws InvalidMapDataException

Instantiates a new point along line location at a network node.

Parameters:

idString - the id string

l - the line

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessLocationWithSideAndOrientation

public static Location createPoiAccessLocationWithSideAndOrientation(String idString,
                                                                     Line l,
                                                                     int poff,
                                                                     double lonDeg,
                                                                     double latDeg,
                                                                     SideOfRoad s,
                                                                     Orientation o)
                                                              throws InvalidMapDataException

Instantiates a new poi with access point location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

lonDeg - the longitude

latDeg - the latitude

s - the side of road

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessLocationWithSide

public static Location createPoiAccessLocationWithSide(String idString,
                                                       Line l,
                                                       int poff,
                                                       double lonDeg,
                                                       double latDeg,
                                                       SideOfRoad s)
                                                throws InvalidMapDataException

Instantiates a new poi with access point location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

lonDeg - the longitude

latDeg - the latitude

s - the side of road

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessLocationWithOrientation

public static Location createPoiAccessLocationWithOrientation(String idString,
                                                              Line l,
                                                              int poff,
                                                              double lonDeg,
                                                              double latDeg,
                                                              Orientation o)
                                                       throws InvalidMapDataException

Instantiates a new poi with access point location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

lonDeg - the longitude

latDeg - the latitude

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessLocation

public static Location createPoiAccessLocation(String idString,
                                               Line l,
                                               int poff,
                                               double lonDeg,
                                               double latDeg)
                                        throws InvalidMapDataException

Instantiates a new poi with access point location.

Parameters:

idString - the id string

l - the line

poff - the positive offset

lonDeg - the longitude

latDeg - the latitude

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessAtNodeLocationWithSideAndOrientation

public static Location createPoiAccessAtNodeLocationWithSideAndOrientation(String idString,
                                                                           Line l,
                                                                           double lonDeg,
                                                                           double latDeg,
                                                                           SideOfRoad s,
                                                                           Orientation o)
                                                                    throws InvalidMapDataException

Instantiates a new poi with access point location at a network node.

Parameters:

idString - the id string

l - the line

lonDeg - the longitude

latDeg - the latitude

s - the side of road

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessAtNodeLocation

public static Location createPoiAccessAtNodeLocation(String idString,
                                                     Line l,
                                                     double lonDeg,
                                                     double latDeg)
                                              throws InvalidMapDataException

Instantiates a new poi with access point location at a network node.

Parameters:

idString - the id string

l - the line

lonDeg - the longitude

latDeg - the latitude

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessAtNodeLocationWithSide

public static Location createPoiAccessAtNodeLocationWithSide(String idString,
                                                             Line l,
                                                             double lonDeg,
                                                             double latDeg,
                                                             SideOfRoad s)
                                                      throws InvalidMapDataException

Instantiates a new poi with access point location at a network node.

Parameters:

idString - the id string

l - the line

lonDeg - the longitude

latDeg - the latitude

s - the side of road

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPoiAccessAtNodeLocationWithOrientation

public static Location createPoiAccessAtNodeLocationWithOrientation(String idString,
                                                                    Line l,
                                                                    double lonDeg,
                                                                    double latDeg,
                                                                    Orientation o)
                                                             throws InvalidMapDataException

Instantiates a new poi with access point location at a network node.

Parameters:

idString - the id string

l - the line

lonDeg - the longitude

latDeg - the latitude

o - the orientation

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createCircleLocation

public static Location createCircleLocation(String idString,
                                            double lonDeg,
                                            double latDeg,
                                            long radius)
                                     throws InvalidMapDataException

Instantiates a new circle location.

Parameters:

idString - the id string

lonDeg - the longitude

latDeg - the latitude

radius - the radius in meters

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createRectangleLocation

public static Location createRectangleLocation(String idString,
                                               double lowerLeftLonDeg,
                                               double lowerLeftLatDeg,
                                               double upperRightLonDeg,
                                               double upperRightLatDeg)
                                        throws InvalidMapDataException

Instantiates a new rectangle location.

Parameters:

idString - the id string

lowerLeftLonDeg - the lower left lon deg

lowerLeftLatDeg - the lower left lat deg

upperRightLonDeg - the upper right lon deg

upperRightLatDeg - the upper right lat deg

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createRectangleLocation

public static Location createRectangleLocation(String string,
                                               GeoCoordinates rectangleLL,
                                               GeoCoordinates rectangleUR)
                                        throws InvalidMapDataException

Creates a new Location object.

Parameters:

string - the string

rectangleLL - the rectangle ll

rectangleUR - the rectangle ur

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createGridLocationFromBasisCell

public static Location createGridLocationFromBasisCell(String idString,
                                                       double lowerLeftLonDeg,
                                                       double lowerLeftLatDeg,
                                                       double upperRightLonDeg,
                                                       double upperRightLatDeg,
                                                       int ncols,
                                                       int nrows)
                                                throws InvalidMapDataException

Instantiates a new grid location.

Parameters:

idString - the id string

lowerLeftLonDeg - the leftmost longitude

lowerLeftLatDeg - the leftmost latitude

upperRightLonDeg - the rightmost longitude

upperRightLatDeg - the rightmost latitude

ncols - the number of columns

nrows - the number of rows

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createGridLocationFromBasisCell

public static Location createGridLocationFromBasisCell(String idString,
                                                       GeoCoordinates lowerLeft,
                                                       GeoCoordinates upperRight,
                                                       int ncols,
                                                       int nrows)
                                                throws InvalidMapDataException

Creates a new Location object.

Parameters:

idString - the id string

lowerLeft - the lower left

upperRight - the upper right

ncols - the ncols

nrows - the nrows

Returns:

the abstract location

Throws:

InvalidMapDataException - the invalid map data exception

createGridLocationFromGridArea

public static Location createGridLocationFromGridArea(String idString,
                                                      double lowerLeftLonDeg,
                                                      double lowerLeftLatDeg,
                                                      double upperRightLonDeg,
                                                      double upperRightLatDeg,
                                                      int ncols,
                                                      int nrows)
                                               throws InvalidMapDataException

Instantiates a new grid location. In this version, the encoding type is passed via a flag: if the parameter encodesLowerLeftCell is true, the encoder will see this, thus knowing, that the basic building block of a grid, i.e. a single cell, is to be encoded and therefore will not first split up the given rectangle into ncols columns and nrows rows before transmission. If, however, the flag is false, the encoder will interpret the given rectangle as the boundary of the grid area location, and thus, before transmission to the receiver side, extract a lower left cell (by splitting the rectangle into ncols columns and nrows rows). Upon receipt, the decoder also sees this flag and will interpret the rectangle information accordingly.

Parameters:

idString - the id string

lowerLeftLonDeg - the lower left lon deg

lowerLeftLatDeg - the lower left lat deg

upperRightLonDeg - the upper right lon deg

upperRightLatDeg - the upper right lat deg

ncols - the number of columns

nrows - the number of rows

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createGridLocationFromGridArea

public static Location createGridLocationFromGridArea(String string,
                                                      GeoCoordinates lowerLeft,
                                                      GeoCoordinates upperRight,
                                                      int columns,
                                                      int rows)
                                               throws InvalidMapDataException

Creates a new Location object.

Parameters:

string - the string

lowerLeft - the lower left

upperRight - the upper right

columns - the columns

rows - the rows

Returns:

the location

Throws:

InvalidMapDataException - the invalid map data exception

createPolygonLocation

public static Location createPolygonLocation(String idString,
                                             List<? extends GeoCoordinates> cornerPoints)

Instantiates a new polygon location.

Parameters:

idString - the id string

cornerPoints - the list of corner points

Returns:

the location

createClosedLineLocation

public static Location createClosedLineLocation(String idString,
                                                List<? extends Line> loc)

Instantiates a new location with a unique key and the location as a list of lines.

Parameters:

idString - the unique ID

loc - the location as a list of lines

Returns:

the location