TLcdCoverageModelDecoder (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.format.coverage.TLcdCoverageModelDecoder

All Implemented Interfaces:

ILcdModelDecoder
```
@LcdService(service=ILcdModelDecoder.class,
            priority=20000)
public final class TLcdCoverageModelDecoder
extends java.lang.Object
implements ILcdModelDecoder
```
Model decoder that can decode LuciadFusion coverages of type IMAGE, ELEVATION, and RASTER.
Input files

File Required Entry point Description

${name}.xml X X The Fusion Coverage description (metadata)

${name}/*.ctr X The Fusion Coverage tile data

Supported file transfer protocols
- The decoder supports decoding the coverages directly when located on the local file system. The decoding is based on the coverage xml description file.
- The decoder also supports decoding coverages from a remote location when denoted with a TLcdCoverageDataSource.
Model structure
This model decoder returns a single ILcdModel.
Model descriptor
All models returned by this model decoder have a TLcdCoverageModelDescriptor. The model descriptor indicates it is suitable for use with the imaging API (ILcdImageModelDescriptor).
Model reference
This model decoder retrieves the model reference from the Fusion Coverage description (metadata) file.
Model elements
A decoded model contains a single element that can be used with the imaging API. Extract the image using ALcdImage.fromDomainObject(Object) if you need access to it.
Performance tips
When connecting to a local tile-store on disk this model decoder needs file system access for performance reasons (e.g. cannot read from a jar).
Known limitations
- This model decoder does not support fusion coverages for which a custom tile format has been used.
Thread safety
- The decoding of models is thread-safe.
- The decoded models are thread-safe for read access.
Sample code

Decode a local coverage
```
    TLcdCoverageModelDecoder modelDecoder = new TLcdCoverageModelDecoder();
    ILcdModel model = modelDecoder.decode("Data/LuciadFusion/Coverages/earth__image.xml");
```
Decode a remote coverage
```
    TLcdCoverageDataSource coverageDataSource = new TLcdCoverageDataSource("http://sampleservices.luciad.com/lts", "92c09725-a9c5-46fb-bffd-d9e23b4abbf2");
    TLcdCoverageModelDecoder modelDecoder = new TLcdCoverageModelDecoder();
    ILcdModel model = modelDecoder.decodeSource(coverageDataSource);
```
Since:

2017.0

File	Required	Entry point	Description
${name}.xml	X	X	The Fusion Coverage description (metadata)
${name}/*.ctr	X		The Fusion Coverage tile data

Constructor Summary

Constructors
Constructor and Description
`TLcdCoverageModelDecoder()` Constructs the coverage model decoder.
`TLcdCoverageModelDecoder(ALfnEnvironment aEnvironment, ALfnTileStoreProvider aTileStoreProvider, TLfnClientFactory aClientFactory)` Constructs a new coverage model decoder instance which uses the specified Fusion environment, client factory and tile store provider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canDecodeSource(ILcdDataSource aDataSource)` Checks whether this model decoder can decode the data source(s), identified by the passed `ILcdDataSource`.
`boolean`	`canDecodeSource(java.lang.String aSource)` Checks whether this model decoder can decode the specified data source.
`ILcdModel`	`decode(java.lang.String aSource)` Creates a new model from the given data source.
`ILcdModel`	`decodeSource(ILcdDataSource aDataSource)` Creates a new model from the given data source.
`java.util.List<ILcdDataSource>`	`discoverDataSources(java.lang.String aTileStoreSource)` Discovers all the coverages of a given Luciad Tile Store source has to offer and returns them as a list of data sources.
`java.lang.String`	`getDisplayName()` Returns a short, displayable name for the format that is decoded by this `ILcdModelDecoder`.
`ILcdTransportFactory`	`getTransportFactory()` Returns the transport factory that will construct the `ILcdTransport` used for communicating with Luciad tile server.
`void`	`setTransportFactory(ILcdTransportFactory aTransportFactory)` Sets the transport factory that will construct the `ILcdTransport` used for communicating with Luciad tile server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdModelDecoder
decodeModelMetadata, decodeModelMetadata

- Constructor Detail
  - TLcdCoverageModelDecoder
```
public TLcdCoverageModelDecoder()
```
    Constructs the coverage model decoder.
  - TLcdCoverageModelDecoder
```
public TLcdCoverageModelDecoder(ALfnEnvironment aEnvironment,
                                ALfnTileStoreProvider aTileStoreProvider,
                                TLfnClientFactory aClientFactory)
```
    Constructs a new coverage model decoder instance which uses the specified Fusion environment, client factory and tile store provider.
    
    Parameters:
    
    aEnvironment - The fusion environment
    
    aTileStoreProvider - The tile store provider
    
    aClientFactory - The client factory
    
    Since:
    
    2018.1
- Method Detail
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Description copied from interface: ILcdModelDecoder
    
    Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.
    
    Specified by:
    
    getDisplayName in interface ILcdModelDecoder
    
    Returns:
    
    the displayable name of this ILcdModelDecoder.
  - getTransportFactory
```
public ILcdTransportFactory getTransportFactory()
```
    Returns the transport factory that will construct the ILcdTransport used for communicating with Luciad tile server.
    
    Returns:
    
    the transport.
    
    See Also:
    
    setTransportFactory(com.luciad.io.transport.ILcdTransportFactory)
  - setTransportFactory
```
public void setTransportFactory(ILcdTransportFactory aTransportFactory)
```
    Sets the transport factory that will construct the ILcdTransport used for communicating with Luciad tile server.
    The default transport factory creates ILcdTransports based on the Apache HttpClient library. This factory uses the proxy configuration from the system-wide proxy selector
    The transports created by the factory should implement ILcdDisposable if they hold any resources (ex. network connections).
    This setter does not affect already decoded models.
    
    Parameters:
    
    aTransportFactory - the transport factory, must not be null
  - canDecodeSource
```
public boolean canDecodeSource(java.lang.String aSource)
```
    Checks whether this model decoder can decode the specified data source. Often this will only be a simple test, for example checking the file extension of a file. For example: Data/LuciadFusion/Coverages/earth__image.xml
    
    Specified by:
    
    canDecodeSource in interface ILcdModelDecoder
    
    Parameters:
    
    aSource - the data source to be verified; typically a file name or a URL.
    
    Returns:
    
    true if this decoder can likely decode the data specified by the source name, false otherwise.
  - canDecodeSource
```
public boolean canDecodeSource(ILcdDataSource aDataSource)
```
    Description copied from interface: ILcdModelDecoder
    
    Checks whether this model decoder can decode the data source(s), identified by the passed ILcdDataSource.
    
    Often this will only be a simple test, for example checking the instance class of aDataSource, or for example checking the file extension if it is a TLcdDataSource.
    
    The default implementation of this method will check if the given ILcdDataSource is a TLcdDataSource. If not, this method returns false. Otherwise, it delegates the source to the ILcdModelDecoder.canDecodeSource(String) method.
    
    Specified by:
    
    canDecodeSource in interface ILcdModelDecoder
    
    Parameters:
    
    aDataSource - the ILcdModelSource to be verified.
    
    Returns:
    
    true if this decoder can likely decode the data specified by aDataSource, false otherwise.
  - decode
```
public ILcdModel decode(java.lang.String aSource)
                 throws java.io.IOException
```
    Description copied from interface: ILcdModelDecoder
    
    Creates a new model from the given data source.
    Specified by:
    
    decode in interface ILcdModelDecoder
    
    Parameters:
    
    aSource - the data source to be decoded; typically a file name or a URL.
    
    Returns:
    
    A model containing the decoded data. While null is allowed, implementors are advised to throw an error instead.
    
    Throws:
    java.io.IOException - for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.
    public ILcdModel decode( String aSourceName ) throws IOException { try (InputStream input = fInputStreamFactory.createInputStream(aSourceName)) { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
    java.io.InterruptedIOException - 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.
  - decodeSource
```
public ILcdModel decodeSource(ILcdDataSource aDataSource)
                       throws java.io.IOException
```
    Description copied from interface: ILcdModelDecoder
    Creates a new model from the given data source.
    
    By default, this method:
    - Throws a NullPointerException when a null data source is passed.
    - Delegates to the ILcdModelDecoder.decode(String) method when a TLcdDataSource is passed.
    - Throws an IOException in other case.
    Specified by:
    
    decodeSource in interface ILcdModelDecoder
    
    Parameters:
    
    aDataSource - the ILcdDataSource to be decoded.
    
    Returns:
    
    a model containing the decoded data. While null is allowed, implementors are advised to throw an error instead.
    
    Throws:
    java.io.IOException - for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.
    public ILcdModel decodeSource(ILcdDataSource aDataSource) throws IOException { try { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
  - discoverDataSources
```
public java.util.List<ILcdDataSource> discoverDataSources(java.lang.String aTileStoreSource)
                                                   throws java.io.IOException
```
    Discovers all the coverages of a given Luciad Tile Store source has to offer and returns them as a list of data sources. If the given source is not a valid LuciadFusion LTS URI, this method will throw an IO exception.
    Once you have the list of data sources, you can select and decode them using decodeSource(com.luciad.model.ILcdDataSource).
    
    Specified by:
    
    discoverDataSources in interface ILcdModelDecoder
    
    Parameters:
    
    aTileStoreSource - the source, which must be a valid LuciadFusion LTS URI, e.g., http://sampleservices.luciad.com/lts.
    
    Returns:
    
    a list of all the coverages as data sources, possibly empty but never null
    
    Throws:
    
    java.io.IOException - if the given source is not a valid LuciadFusion LTS URI, or if something goes wrong connecting to the URI

LuciadLightspeedClass TLcdCoverageModelDecoder

Input files

Supported file transfer protocols

Model structure

Model descriptor

Model reference

Model elements

Performance tips

Known limitations

Thread safety

Sample code

Decode a local coverage

Decode a remote coverage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.model.ILcdModelDecoder

Constructor Detail

TLcdCoverageModelDecoder

TLcdCoverageModelDecoder

Method Detail

getDisplayName

getTransportFactory

setTransportFactory

canDecodeSource

canDecodeSource

decode

decodeSource

discoverDataSources