openlr

Interface PhysicalDecoder

public interface PhysicalDecoder

The interface PhysicalDecoder needs to be implemented by all OpenLR physical format decoders. These decoders translate a defined physical format for OpenLR location references into an internal representation (raw format). Each decoder is identified by a data identifier string. Examples for different physical formats might be "xml" or "binary". Decoder packages implementing this interface also need to register the implementation as a service. The service loader mechanism from Java is used by the OpenLR decoder to collect all implementation of this PhysicalDecoder interface. The decoder will select the required physical decoder to read the physical data. In order to register a service one needs to add a file "openlr.PhysicalDecoder" to the "META-INF/services" directory of the java package. This file must contain the fully qualified path to the implementation class, e.g. "openlr.xml.OpenLRXMLDecoder".

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
RawLocationReference	decodeData(LocationReference data) Decodes the data (physical format) and generates an internal representation of the location reference as a list of location reference points and offset information.
Class<?>	getDataClass() Gets the class of the location reference data.
String	getDataFormatIdentifier() Gets the data identifier.

Method Detail

getDataClass

Class<?> getDataClass()

Gets the class of the location reference data.

Returns:

the data class

decodeData

RawLocationReference decodeData(LocationReference data)
                         throws PhysicalFormatException

Decodes the data (physical format) and generates an internal representation of the location reference as a list of location reference points and offset information.

Parameters:

data - the (physical) data

Returns:

the raw location reference

Throws:

PhysicalFormatException - the physical format exception

getDataFormatIdentifier

String getDataFormatIdentifier()

Gets the data identifier.

Returns:

the data identifier