com.luciad.earth.model

LuciadLightspeedInterface ILcdEarthModelDecoderFactory

All Known Subinterfaces:

ILfnDataSourceModelDecoderFactory

public interface ILcdEarthModelDecoderFactory

A factory to create model decoders.

Since:

10.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BUFFER Key used for an ILcdBuffer property.
static String	KEY_DATA_MODEL_NAME Key used for a String property that represents the (unique) data model name.
static String	KEY_DECODING_BOUNDS Key used for a ILcdBounds property that represents the decoding bounds.
static String	KEY_INPUT_STREAM_FACTORY Key used for an ILcdInputStreamFactory property.
static String	KEY_SEEKABLE_INPUT_STREAM_FACTORY Key used for an ILcdInputStreamFactory property that creates seekable input streams.

Method Summary

Modifier and Type	Method and Description
boolean	canDecodeSource(String aSource) Checks whether this factory's model decoders can decode a source.
ILcdModelDecoder	createModelDecoder(String aSourceName, Map<String,Object> aProperties) Creates a model decoder for a source.
String	getName() Gets the name of this model decoder factory.

Field Detail

KEY_INPUT_STREAM_FACTORY

static final String KEY_INPUT_STREAM_FACTORY

Key used for an ILcdInputStreamFactory property. The factory is used for creating the input streams from which the model is read.

The value of the property is an ILcdInputStreamFactory.

See Also:

Constant Field Values

KEY_BUFFER

static final String KEY_BUFFER

Key used for an ILcdBuffer property. The buffer is can be used for allocating memory segments needed for reading or caching data.

The value of the property is an ILcdBuffer.

See Also:

Constant Field Values

KEY_SEEKABLE_INPUT_STREAM_FACTORY

static final String KEY_SEEKABLE_INPUT_STREAM_FACTORY

Key used for an ILcdInputStreamFactory property that creates seekable input streams. The factory can be used for the same purposes as the factory of KEY_INPUT_STREAM_FACTORY. The only difference is that the factory of this key is guaranteed to create input streams that extend SeekableStream.

See Also:

Constant Field Values

KEY_DATA_MODEL_NAME

static final String KEY_DATA_MODEL_NAME

Key used for a String property that represents the (unique) data model name. When supported, the model decoder will create a model with a data model of this name. This property can be used to share data models across multiple models, as data models are identified solely by their name. The model decoder may reuse an existing instance of the data model or it may create a new one each time.

The value of the property is a String.

Since:

10.1

See Also:

Constant Field Values

KEY_DECODING_BOUNDS

static final String KEY_DECODING_BOUNDS

Key used for a ILcdBounds property that represents the decoding bounds. When supported, the model decoder will create a model constrained by these bounds. Beware that it is silently assumed that the bounds are in the model's reference, so you must make sure to transform the bounds before passing them as property.

The value of the property is a ILcdBounds.

Since:

11.0

See Also:

Constant Field Values

Method Detail

getName

String getName()

Gets the name of this model decoder factory.

Returns:

name

canDecodeSource

boolean canDecodeSource(String aSource)

Checks whether this factory's model decoders can decode a source.

Parameters:

aSource - the source

Returns:

true when decoding is possible, false otherwise

createModelDecoder

ILcdModelDecoder createModelDecoder(String aSourceName,
                                    Map<String,Object> aProperties)

Creates a model decoder for a source. Optionally, properties may be specified to configure the model decoder. The properties are implementation specific.

Parameters:

aSourceName - the source

aProperties - the properties for configuring the model decoder, may be null

Returns:

a model decoder