Package com.luciad.view.lightspeed.layer

Interface ILspLayerFactory

All Known Implementing Classes:

ALspSingleLayerFactory, TLcyLspCompositeLayerFactory, TLspBingMapsLayerFactory, TLspCompositeLayerFactory, TLspMGCPLayerFactory, TLspNITFLayerFactory, TLspWMSLayerFactory

public interface ILspLayerFactory

A factory that can create one or more ILspLayers for an ILcdModel.

Often a layer factory only creates a single layer for a model. In this case you can use the ALspSingleLayerFactory.

Since:

2012.0

Method Summary

Modifier and Type	Method	Description
boolean	canCreateLayers(ILcdModel aModel)	Determines whether or not this layer factory is capable of creating layers for the given model.
Collection<ILspLayer>	createLayers(ILcdModel aModel)	Creates one or more ILspLayer objects for the given model.

Method Details

canCreateLayers

boolean canCreateLayers(ILcdModel aModel)

Determines whether or not this layer factory is capable of creating layers for the given model. If this method returns false, the result of calling createLayers(com.luciad.model.ILcdModel) with the same parameters is undefined.

Parameters:

aModel - the model for which layers should be created

Returns:

true if this factory can create layers for aModel, or false otherwise

createLayers

Collection<ILspLayer> createLayers(ILcdModel aModel)

Creates one or more ILspLayer objects for the given model.

Note that this method should not be called if canCreateLayers(com.luciad.model.ILcdModel) returns false; the results are undefined in this case.

In most typical scenarios, this method will only create a single ILspLayer instances for a given model. In such cases, the ALspSingleLayerFactory provides a convenient abstract base class for layer factory implementations. An example of when it might be useful to return multiple layers is a model that describes objects moving along a certain trajectory. The layer factory might return one layer which represents the trajectories as polylines, and another which represents the current positions of the objects as point icons.

Parameters:

aModel - the model for which layers should be created

Returns:

a collection of layers representing the given model