com.luciad.model

LuciadLightspeedInterface ILcdModelReferenceDecoder

All Known Implementing Classes:

TLcdCompositeModelReferenceDecoder, TLcdEPSGModelReferenceDecoder, TLcdModelReferenceDecoder, TLcdRPCModelReferenceDecoder, TLcdWKTModelReferenceDecoder, TLcyCompositeModelReferenceDecoder

public interface ILcdModelReferenceDecoder

Decodes the ILcdModelReference that is associated with a data source.

Some formats do not include information about the coordinate system that is used in their data files. For these formats, an additional model reference file may be placed next to the data file, providing information about the coordinate system. ILcdModelDecoder implementations for these formats often allow to configure an ILcdModelReferenceDecoder on them, providing the model decoder with the correct coordinate system information.

See Also:

ILcdModelReference, ILcdModel, ILcdModelDecoder, ILcdModelReferenceEncoder

Method Summary

Modifier and Type	Method and Description
ILcdModelReference	decodeModelReference(java.lang.String aDataSourceName) Returns the model reference, associated with the specified data source.

Method Detail

decodeModelReference

ILcdModelReference decodeModelReference(java.lang.String aDataSourceName)
                                 throws java.io.IOException

Returns the model reference, associated with the specified data source.

Parameters:

aDataSourceName - a data source for which to return the model reference; typically a file name or a URL.

Returns:

the ILcdModelReference associated with the data source. While null is allowed, implementors are advised to throw an error instead.

Throws:

java.io.IOException - if the ILcdModelReference cannot be decoded. It is recommended to throw a FileNotFoundException when the source passed does not point to an existing file. This allows to differentiate between missing model reference files and corrupt model reference files.
When the thread on which this method is called is interrupted, it is recommended to stop the decoding and throw an InterruptedIOException. This same exception can also be used if the decoder shows UI to the user, and the user cancels the decoding through the UI.