RawLocationReference (data 1.4.3 API)

java.lang.Object
- openlr.rawLocRef.RawLocationReference

Direct Known Subclasses:

RawCircleLocRef, RawClosedLineLocRef, RawGeoCoordLocRef, RawGridLocRef, RawInvalidLocRef, RawLineLocRef, RawPointLocRef, RawPolygonLocRef, RawRectangleLocRef
```
public abstract class RawLocationReference
extends Object
```
A raw location reference represents an intermediate format of a location reference used by the encoder and decoder. This format is the exchange format between a specific physical format (e.g. binary) and the data format used for encoding and decoding.
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 id.

protected LocationType locType
The loc type.

protected StatusCode returnCode
The return code.

Fields
Modifier and Type	Field and Description
`protected String`	`id` The id.
`protected LocationType`	`locType` The loc type.
`protected StatusCode`	`returnCode` The return code.

Constructor Summary

Constructors
Constructor and Description
`RawLocationReference(String idValue, LocationType lt)` Instantiates a new raw location reference.
`RawLocationReference(String idValue, LocationType lt, StatusCode rc)` Instantiates a new raw location reference.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract int`	`calculateHashCode()` Calculate the hash code which can be used to be stored if several hashCode calls are required.
`abstract boolean`	`equals(Object obj)`
`GeoCoordinates`	`getCenterPoint()` Gets the center point of a circle location.
`List<GeoCoordinates>`	`getCornerPoints()` Gets the points defining the corners of an area location.
`GeoCoordinates`	`getGeoCoordinates()` Gets the geo coordinates.
`protected int`	`getHashCode()` Gets the hash code.
`String`	`getID()` Gets the unique id stored in the location reference data.
`List<LocationReferencePoint>`	`getLocationReferencePoints()` Gets the location reference points.
`LocationType`	`getLocationType()` Gets the location type.
`GeoCoordinates`	`getLowerLeftPoint()` Gets the leftmost corner point of a rectangle or grid location.
`int`	`getNumberOfColumns()` Gets the number of columns of a grid location.
`int`	`getNumberOfRows()` Gets the number of rows of a grid location.
`Offsets`	`getOffsets()` Gets the offset information.
`Orientation`	`getOrientation()` Gets the orientation.
`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 rightmost corner point of a rectangle or grid location.
`abstract int`	`hashCode()`
`boolean`	`hasID()` Checks if the location reference data contains an unique id.
`boolean`	`isValid()` Checks if the location reference is valid.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - locType
```
protected final LocationType locType
```
    The loc type.
  - id
```
protected final String id
```
    The id.
  - returnCode
```
protected final StatusCode returnCode
```
    The return code.
- Constructor Detail
  - RawLocationReference
```
public RawLocationReference(String idValue,
                            LocationType lt,
                            StatusCode rc)
```
    Instantiates a new raw location reference.
    
    Parameters:
    
    idValue - the id value
    
    lt - the location type
    
    rc - the return code
  - RawLocationReference
```
public RawLocationReference(String idValue,
                            LocationType lt)
```
    Instantiates a new raw location reference.
    
    Parameters:
    
    idValue - the id value
    
    lt - the location type
- Method Detail
  - getID
```
public final String getID()
```
    Gets the unique id stored in the location reference data. If no id is stored the method will return null.
    
    Returns:
    
    the id or null if no id is available
  - hasID
```
public final boolean hasID()
```
    Checks if the location reference data contains an unique id.
    
    Returns:
    
    true, if the location reference data contains an id
  - getLocationType
```
public final LocationType getLocationType()
```
    Gets the location type.
    
    Returns:
    
    the location type
  - getReturnCode
```
public final StatusCode getReturnCode()
```
    Gets the return code (only valid as a result of a decoding process).
    
    Returns:
    
    the return code
  - isValid
```
public final boolean isValid()
```
    Checks if the location reference is valid. If this location reference was encoded successfully and it contains a location reference object, then the location reference is valid. It is invalid if an error occurred during encoding and the exception stored within the location reference indicates what went wrong.
    
    Returns:
    
    true, if the location reference is valid, otherwise false
  - calculateHashCode
```
public abstract int calculateHashCode()
```
    Calculate the hash code which can be used to be stored if several hashCode calls are required.
    
    Returns:
    
    the int
  - equals
```
public abstract boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public abstract int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getHashCode
```
protected final int getHashCode()
```
    Gets the hash code.
    
    Returns:
    
    the hash code
  - getLocationReferencePoints
```
public List<LocationReferencePoint> getLocationReferencePoints()
```
    Gets the location reference points.
    
    Returns:
    
    the location reference points or null if data was not decoded before
  - getOffsets
```
public Offsets getOffsets()
```
    Gets the offset information.
    
    Returns:
    
    the offset information or null if data was not decoded before
  - getGeoCoordinates
```
public GeoCoordinates getGeoCoordinates()
```
    Gets the geo coordinates.
    
    Returns:
    
    the geo coordinates
  - getSideOfRoad
```
public SideOfRoad getSideOfRoad()
```
    Gets the side of road.
    
    Returns:
    
    the side of road
  - getOrientation
```
public Orientation getOrientation()
```
    Gets the orientation.
    
    Returns:
    
    the orientation
  - getCornerPoints
```
public 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
```
public GeoCoordinates getLowerLeftPoint()
```
    Gets the leftmost corner point of a rectangle or grid location. If there are two possibilities, gets the upper one of them.
    
    Returns:
    
    the leftmost point, if the area location is of type RECTANGLE, or GRID, otherwise null
  - getUpperRightPoint
```
public GeoCoordinates getUpperRightPoint()
```
    Gets the rightmost corner point of a rectangle or grid location. If there are two possibilities, gets the lower one of them.
    
    Returns:
    
    the rightmost 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.
    
    Returns:
    
    the center point of a circle, otherwise null
  - getRadius
```
public long getRadius()
```
    Gets the radius (in meters) of a circle location.
    
    Returns:
    
    the radius of a circle, otherwise -1
  - getNumberOfColumns
```
public int getNumberOfColumns()
```
    Gets the number of columns of a grid 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.
    
    Returns:
    
    the number of rows of a grid location, otherwise -1

Class RawLocationReference

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

locType

id

returnCode

Constructor Detail

RawLocationReference

RawLocationReference

Method Detail

getID

hasID

getLocationType

getReturnCode

isValid

calculateHashCode

equals

hashCode

getHashCode

getLocationReferencePoints

getOffsets

getGeoCoordinates

getSideOfRoad

getOrientation

getCornerPoints

getLowerLeftPoint

getUpperRightPoint

getCenterPoint

getRadius

getNumberOfColumns

getNumberOfRows