com.luciad.format.metadata.model

LuciadLightspeedInterface ILcdMetadataDecoder

All Known Implementing Classes:

TLcdECWModelDecoder, TLcdGDALModelDecoder, TLcdISO19139MetadataDecoder, TLcdS57CatalogueModelDecoder, TLcdS57ModelDecoder, TLcdS57UnifiedModelDecoder, TLcdS63CatalogueModelDecoder, TLcdS63ModelDecoder, TLcdS63UnifiedModelDecoder

public interface ILcdMetadataDecoder

This interface defines the ability to decode ISO-19115 metadata from a source name. The source name can be that of an ISO-19139 XML source, or it can be the source name of a data set.

The TLcdISO19139MetadataDecoder is an implementation of this interface which allows decoding ISO-19115 metadata from an ISO-19139 XML source.

This interface is typically also implemented by a model decoder, in which case the model decoder is capable of decoding just the metadata from the model's source name without having to decode the whole model itself. Most formats already have a lot of the metadata information contained in the header, which is then decoded and represented as an ISO-19115 metadata object.

Since:

2014.0

Method Summary

Modifier and Type	Method and Description
boolean	canDecodeMetadata(java.lang.String aSourceName) Tells whether this metadata decoder can likely decode metadata for a given source name.
TLcdISO19115Metadata	decodeMetadata(java.lang.String aSourceName) Decodes the metadata from a given source name as an ISO-19115 metadata object.

Method Detail

canDecodeMetadata

boolean canDecodeMetadata(java.lang.String aSourceName)

Tells whether this metadata decoder can likely decode metadata for a given source name.

• If true, it is likely that decodeMetadata(String) will return a non-null TLcdISO19115Metadata object, but it is not a guarantee. The result is optimistic.
• If false, it is guaranteed that decodeMetadata(String) will return null.

Parameters:

aSourceName - the source name to decode metadata for

Returns:

true if this metadata decoder can decode metadata for the given source name, false otherwise

decodeMetadata

TLcdISO19115Metadata decodeMetadata(java.lang.String aSourceName)
                             throws java.io.IOException

Decodes the metadata from a given source name as an ISO-19115 metadata object. A return value of null indicates that this decoder could not decode the given source name.

Note that even if canDecodeMetadata(String) returns true, this method may yet return null.

Parameters:

aSourceName - the source name to decode metadata from

Returns:

a metadata object, or null if this decoder does not support the source name

Throws:

java.io.IOException