openlr.location

Class LineLocation

java.lang.Object

openlr.location.LineLocation

All Implemented Interfaces:

Location

public class LineLocation
extends Object

Implementation of the location interface for line locations.

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

email: software@openlr.org

Author:

TomTom International B.V.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	id The unique ID.
protected LocationType	locType The loc type.
protected StatusCode	retCode The ret code.

Constructor Summary

Constructors

Modifier	Constructor and Description
	LineLocation(LineLocation l) Instantiates a copy of location l.
protected	LineLocation(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.

Method Summary

Modifier and Type	Method and Description
int	calculateHashCode() Calculate the hash code which can be used to be stored if several hashCode calls are required.
boolean	equals(Object obj)
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.
protected int	getHashCode() Gets the hashCode.
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.
int	hashCode()
boolean	hasNegativeOffset() Checks for negative offset.
boolean	hasPositiveOffset() Checks for positive offset.
boolean	isValid() Checks if the decoded location is valid.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected final String id

The unique ID.

locType

protected final LocationType locType

The loc type.

retCode

protected final StatusCode retCode

The ret code.

Constructor Detail

LineLocation

protected LineLocation(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:

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

idString - the unique ID

LineLocation

public LineLocation(LineLocation l)

Instantiates a copy of location l.

Parameters:

l - the location be copied

Method Detail

getLocationLines

public final List<Line> getLocationLines()

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

Specified by:

getLocationLines in interface Location

Returns:

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

getPositiveOffset

public final 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.

Specified by:

getPositiveOffset in interface Location

Returns:

the remaining positive offset

getNegativeOffset

public final 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.

Specified by:

getNegativeOffset in interface Location

Returns:

the remaining negative offset

hasPositiveOffset

public final boolean hasPositiveOffset()

Checks for positive offset.

Specified by:

hasPositiveOffset in interface Location

Returns:

true, if successful

hasNegativeOffset

public final boolean hasNegativeOffset()

Checks for negative offset.

Specified by:

hasNegativeOffset in interface Location

Returns:

true, if successful

toString

public final String toString()

Overrides:

toString in class Object

calculateHashCode

public final int calculateHashCode()

Calculate the hash code which can be used to be stored if several hashCode calls are required.

Returns:

the int

equals

public final boolean equals(Object obj)

hashCode

public final int hashCode()

getID

public final String getID()

Gets the unique ID.

Specified by:

getID in interface Location

Returns:

the unique ID

getLocationType

public final LocationType getLocationType()

Gets the location type.

Specified by:

getLocationType in interface Location

Returns:

the location type

getReturnCode

public final StatusCode getReturnCode()

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

Specified by:

getReturnCode in interface Location

Returns:

the return code

isValid

public final 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.

Specified by:

isValid in interface Location

Returns:

true, if the location is valid

getHashCode

protected final int getHashCode()

Gets the hashCode. This methods calculates the hashCode and stores it.

Returns:

the hashCode

getPoiLine

public Line getPoiLine()

Gets the line used to define a point location on.

Specified by:

getPoiLine in interface Location

Returns:

the line used for a point location

getAccessPoint

public GeoCoordinates getAccessPoint()

Gets the access point.

Specified by:

getAccessPoint in interface Location

Returns:

the access point

getOrientation

public Orientation getOrientation()

Gets the orientation.

Specified by:

getOrientation in interface Location

Returns:

the orientation

getPointLocation

public GeoCoordinates getPointLocation()

Gets the point location.

Specified by:

getPointLocation in interface Location

Returns:

the point location

getSideOfRoad

public SideOfRoad getSideOfRoad()

Gets the side of road.

Specified by:

getSideOfRoad in interface Location

Returns:

the side of road

getAffectedLines

public AffectedLines getAffectedLines()

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

Specified by:

getAffectedLines in interface Location

Returns:

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

getCornerPoints

public List<GeoCoordinates> getCornerPoints()

Gets the points defining the corners of an area location.

Specified by:

getCornerPoints in interface Location

Returns:

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

getLowerLeftPoint

public GeoCoordinates getLowerLeftPoint()

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

Specified by:

getLowerLeftPoint in interface Location

Returns:

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

getUpperRightPoint

public GeoCoordinates getUpperRightPoint()

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

Specified by:

getUpperRightPoint in interface Location

Returns:

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

getCenterPoint

public GeoCoordinates getCenterPoint()

Gets the center point of a circle location.

Specified by:

getCenterPoint in interface Location

Returns:

the center point of a circle, otherwise null

getRadius

public long getRadius()

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

Specified by:

getRadius in interface Location

Returns:

the radius of a circle, otherwise -1

getNumberOfColumns

public int getNumberOfColumns()

Gets the number of columns of a grid location.

Specified by:

getNumberOfColumns in interface Location

Returns:

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

getNumberOfRows

public int getNumberOfRows()

Gets the number of rows of a grid location.

Specified by:

getNumberOfRows in interface Location

Returns:

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