openlr

Interface LocationReference

public interface LocationReference

The interface LocationReference defines an OpenLR location reference. A location reference describes in a map-agnostic way a location in a digital map. The reference can be used to exchange the information about a location between several maps. These maps might differ to some extent. This interface holds an identification of the location/location reference, the reference itself as an abstract field and if no location reference could be generated the object holds the exception. As there might be several formats for location references this object identifies itself with a data identifier and data class information.

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
Class<?>	getDataClass() Gets the class of the location reference.
String	getDataIdentifier() Gets the unique data identifier.
String	getID() Gets the unique location/location reference ID.
Object	getLocationReferenceData() Gets the location reference data.
LocationType	getLocationType() Gets the location type.
StatusCode	getReturnCode() Gets the return code (only valid after an encoding process)
int	getVersion() Gets the version.
boolean	isValid() Checks if the location reference is valid.
void	toStream(OutputStream os) Writes the location reference data to the provided stream.

Method Detail

getLocationType

LocationType getLocationType()

Gets the location type.

Returns:

the location type

getLocationReferenceData

Object getLocationReferenceData()

Gets the location reference data. As there might be several formats for location references the return value is an object. The class of this object can be identified using the getDataClass() method.

Returns:

the location reference data

getID

String getID()

Gets the unique location/location reference 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 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

getReturnCode

StatusCode getReturnCode()

Gets the return code (only valid after an encoding process)

Returns:

the return code

getDataClass

Class<?> getDataClass()

Gets the class of the location reference.

Returns:

the class of the location reference

getDataIdentifier

String getDataIdentifier()

Gets the unique data identifier. This identifier specifies the location reference format being used. The value "xml" might indicate that the location reference data represents a XML document and the value "binary" might indicate that the location reference is stored in a binary array.

Returns:

the data identifier

toStream

void toStream(OutputStream os)
       throws IOException,
              OpenLRProcessingException

Writes the location reference data to the provided stream.

Parameters:

os - the output stream to write

Throws:

IOException - if storing the data failed

OpenLRProcessingException - the open lr processing exception

getVersion

int getVersion()

Gets the version.

Returns:

the version