openlr.location

Interface Location

All Known Implementing Classes:

CircleLocation, ClosedLineLocation, GeoCoordLocation, GridLocation, InvalidLocation, LineLocation, PoiAccessLocation, PointAlongLocation, PointLocation, PolygonLocation, RectangleLocation

public interface Location

The interface Location defines a location (in a map) which can be encoded using the OpenLR encoder and is also the result of the OpenLR decoding process.

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
GeoCoordinates	getAccessPoint() Gets the access point.
AffectedLines	getAffectedLines() Gets the affected lines.
GeoCoordinates	getCenterPoint() Gets the center point of a circle location.
List<GeoCoordinates>	getCornerPoints() Gets the points defining the corners of an area location.
String	getID() Gets the unique ID.
List<Line>	getLocationLines() Gets the location as a list of lines, if the decoded location is valid.
LocationType	getLocationType() Gets the location type.
GeoCoordinates	getLowerLeftPoint() Gets the lower left corner point of a rectangle or grid location.
int	getNegativeOffset() Gets the remaining negative offset.
int	getNumberOfColumns() Gets the number of columns of a grid location.
int	getNumberOfRows() Gets the number of rows of a grid location.
Orientation	getOrientation() Gets the orientation.
Line	getPoiLine() Gets the line used to define a point location on.
GeoCoordinates	getPointLocation() Gets the point location.
int	getPositiveOffset() Gets the remaining positive offset.
long	getRadius() Gets the radius (in meters) of a circle location.
StatusCode	getReturnCode() Gets the return code (only valid as a result of a decoding process).
SideOfRoad	getSideOfRoad() Gets the side of road.
GeoCoordinates	getUpperRightPoint() Gets the upper right corner point of a rectangle or grid location.
boolean	hasNegativeOffset() Checks for negative offset.
boolean	hasPositiveOffset() Checks for positive offset.
boolean	isValid() Checks if the decoded location is valid.

Method Detail

isValid

boolean isValid()

Checks if the decoded location is valid. If valid, then the decoding process was successful and a location could be matched. Otherwise the exception is reported.

Returns:

true, if the location is valid

getReturnCode

StatusCode getReturnCode()

Gets the return code (only valid as a result of a decoding process).

Returns:

the return code

getLocationLines

List<Line> getLocationLines()

Gets the location as a list of lines, if the decoded location is valid.

Returns:

list of lines if the decoded location is valid, otherwise null

getAffectedLines

AffectedLines getAffectedLines()

Gets the affected lines. Affected lines are fully or partly covered by the area location, if the decoded area location is valid.

Returns:

affected lines if the decoded area location is valid, otherwise null

getID

String getID()

Gets the unique ID.

Returns:

the unique ID

getPoiLine

Line getPoiLine()

Gets the line used to define a point location on.

Returns:

the line used for a point location

getPositiveOffset

int getPositiveOffset()

Gets the remaining positive offset.

Offset values shorten the location reference path down to the desired location and are measured in meters. The positive offset is used to locate the precise start of a location. It defines the distance along the shape of the line between the start of the location reference path, i.e. the start point of the first location line, and the real start of the location.

Returns:

the remaining positive offset

getNegativeOffset

int getNegativeOffset()

Gets the remaining negative offset.

Offset values shorten the location reference path down to the desired location and are measured in meters. The negative offset is used to locate the precise end of the location. It defines the distance along the shape of the line between the end of the location and the end of the location reference path, i.e. the end point of the last line.

Returns:

the remaining negative offset

getLocationType

LocationType getLocationType()

Gets the location type.

Returns:

the location type

getPointLocation

GeoCoordinates getPointLocation()

Gets the point location.

Returns:

the point location

getAccessPoint

GeoCoordinates getAccessPoint()

Gets the access point.

Returns:

the access point

getCornerPoints

List<GeoCoordinates> getCornerPoints()

Gets the points defining the corners of an area location.

Returns:

a list of corner points, if the area location is of type POLYGON, RECTANGLE, or GRID, otherwise null

getLowerLeftPoint

GeoCoordinates getLowerLeftPoint()

Gets the lower left corner point of a rectangle or grid location.

Returns:

the lower left point, if the area location is of type RECTANGLE, or GRID, otherwise null

getUpperRightPoint

GeoCoordinates getUpperRightPoint()

Gets the upper right corner point of a rectangle or grid location.

Returns:

the upper right point, if the area location is of type RECTANGLE, or GRID, otherwise null

getCenterPoint

GeoCoordinates getCenterPoint()

Gets the center point of a circle location.

Returns:

the center point of a circle, otherwise null

getRadius

long getRadius()

Gets the radius (in meters) of a circle location.

Returns:

the radius of a circle, otherwise -1

getNumberOfColumns

int getNumberOfColumns()

Gets the number of columns of a grid location.

Returns:

the number of columns of a grid location , otherwise -1

getNumberOfRows

int getNumberOfRows()

Gets the number of rows of a grid location.

Returns:

the number of rows of a grid location, otherwise -1

hasPositiveOffset

boolean hasPositiveOffset()

Checks for positive offset.

Returns:

true, if successful

hasNegativeOffset

boolean hasNegativeOffset()

Checks for negative offset.

Returns:

true, if successful

getOrientation

Orientation getOrientation()

Gets the orientation.

Returns:

the orientation

getSideOfRoad

SideOfRoad getSideOfRoad()

Gets the side of road.

Returns:

the side of road