openlr.encoder

Interface LocationReferenceHolder

public interface LocationReferenceHolder

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
Set<String>	getDataFormatIdentifiers() Gets the data format identifiers.
String	getID() Gets the unique ID.
LocationReference	getLocationReference(String dataID) Gets the location reference with the data identifier dataID.
LocationType	getLocationType() Gets the location type.
List<LocationReferencePoint>	getLRPs() Gets the list of sub routes.
int	getNrOfLRPs() Gets the number of sub routes of this location reference.
int	getNumberOfDataFormats() Gets the number of data formats.
int	getNumberOfValidLR() Gets the number of valid physical location references.
RawLocationReference	getRawLocationReferenceData() Gets the raw location reference data.
StatusCode	getReturnCode() Gets the error being thrown during encoding.
boolean	hasLRPs() Checks for a sub route list.
boolean	isValid() Checks if the location reference is valid.

Method Detail

getDataFormatIdentifiers

Set<String> getDataFormatIdentifiers()

Gets the data format identifiers.

Returns:

the data format identifiers

getNumberOfDataFormats

int getNumberOfDataFormats()

Gets the number of data formats.

Returns:

the number of data formats

getNumberOfValidLR

int getNumberOfValidLR()

Gets the number of valid physical location references.

Returns:

the number of valid physical location references

getID

String getID()

Gets the unique ID.

Returns:

the unique ID

isValid

boolean isValid()

Checks if the location reference is valid. If this location reference was encoded successfully and it contains at least one location reference, 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

getReturnCode

StatusCode getReturnCode()

Gets the error being thrown during encoding. If the location reference is valid then the method will return null.

Returns:

the error if encoding failed, otherwise null

getNrOfLRPs

int getNrOfLRPs()

Gets the number of sub routes of this location reference.

Returns:

the number of sub routes

hasLRPs

boolean hasLRPs()

Checks for a sub route list.

Returns:

true, if a sub route list is available

getLRPs

List<LocationReferencePoint> getLRPs()

Gets the list of sub routes. The concatenation of these sub routes covers the location.

Returns:

the sub route list

getLocationReference

LocationReference getLocationReference(String dataID)

Gets the location reference with the data identifier dataID. If the data identifier does not exist the method will return null.

Parameters:

dataID - the data identifier

Returns:

the location reference

getLocationType

LocationType getLocationType()

Gets the location type.

Returns:

the location type

getRawLocationReferenceData

RawLocationReference getRawLocationReferenceData()

Gets the raw location reference data.

Returns:

the raw location reference data