openlr

Interface PhysicalEncoder

public interface PhysicalEncoder

The interface PhysicalEncoder needs to be implemented by all OpenLR physical format encoders. These encoders translate the internal data structure of a location reference into a defined physical format. Each encoder is identified by a data identifier string. Examples for different physical formats might be "xml" or "binary". Physical encoders may support several versions of their format identified by a unique number. Encoder packages implementing this interface also need to register the implementation as a service. The service loader mechanism from Java is used by the OpenLR encoder to collect all implementation of this PhysicalEncoder interface. All implementations will be called during the encoding process. In order to register a service one needs to add a file "openlr.PhysicalEncoder" 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.OpenLRXMLEncoder".

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
LocationReference	encodeData(RawLocationReference rawLocRef) Encode data using the latest version.
LocationReference	encodeData(RawLocationReference rawLocRef, int version) Encode data using a specific version.
Class<?>	getDataClass() Gets the class of the location reference data.
String	getDataFormatIdentifier() Gets the data identifier.
int[]	getSupportedVersions() Gets the supported versions.

Method Detail

encodeData

LocationReference encodeData(RawLocationReference rawLocRef)

Encode data using the latest version.

Parameters:

rawLocRef - the raw loc ref

Returns:

the location reference

encodeData

LocationReference encodeData(RawLocationReference rawLocRef,
                             int version)

Encode data using a specific version.

Parameters:

rawLocRef - the raw loc ref

version - the version

Returns:

the location reference

getSupportedVersions

int[] getSupportedVersions()

Gets the supported versions. A version is defined by a unique number.

Returns:

the supported versions

getDataFormatIdentifier

String getDataFormatIdentifier()

Gets the data identifier.

Returns:

the data identifier

getDataClass

Class<?> getDataClass()

Gets the class of the location reference data.

Returns:

the data class