Package com.luciad.lucy.map.lightspeed

Class TLcyLspCompositeLayerFactory

java.lang.Object

com.luciad.lucy.util.TLcyGenericComposite<ILspLayerFactory>

com.luciad.lucy.map.lightspeed.TLcyLspCompositeLayerFactory

All Implemented Interfaces:

ILspLayerFactory, Iterable<ILspLayerFactory>

public class TLcyLspCompositeLayerFactory
extends TLcyGenericComposite<ILspLayerFactory>
implements ILspLayerFactory

Composite implementation (see composite design pattern) of ILspLayerFactory. It keeps a list of associated ILspLayerFactorys: one can add and remove other ILspLayerFactorys to this ILspLayerFactory. When it is asked to create a layer, it loops over its associated ILspLayerFactorys to find the first one that returns a valid layer (means canCreateLayers does return true). That layer will then be returned.

Since:

2012.0

Field Summary

Fields inherited from class com.luciad.lucy.util.TLcyGenericComposite

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Constructor Summary

Constructors

Constructor	Description
TLcyLspCompositeLayerFactory()	Default constructor.
TLcyLspCompositeLayerFactory(ILcyLucyEnv aLucyEnv)	Construct a TLcyLspCompositeLayerFactory working on the Lucy back-end

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.

Methods inherited from class com.luciad.lucy.util.TLcyGenericComposite

add, add, getList, getPriority, iterator, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

TLcyLspCompositeLayerFactory

public TLcyLspCompositeLayerFactory()

Default constructor. No ILspLayerFactorys are associated.

The created instance will only work on the ILspLayerFactory instances registered to it. If you want to use all registered ILspLayerFactory instances of the Lucy back-end, use TLcyLspCompositeLayerFactory(com.luciad.lucy.ILcyLucyEnv) instead.

See Also:

• TLcyLspCompositeLayerFactory(com.luciad.lucy.ILcyLucyEnv)

TLcyLspCompositeLayerFactory

public TLcyLspCompositeLayerFactory(ILcyLucyEnv aLucyEnv)

Construct a TLcyLspCompositeLayerFactory working on the Lucy back-end

It will use all ILspLayerFactory instances registered to the back-end, and adding and/or removing ILspLayerFactorys to/from this TLcyLspCompositeLayerFactory will respectively add/remove it as service from the back-end.

If you want to create a TLcyLspCompositeLayerFactory which does not use the back-end, use TLcyLspCompositeLayerFactory() instead.

Parameters:

aLucyEnv - The Lucy back-end.

See Also:

• TLcyLspCompositeLayerFactory()
• ILcyLucyEnv.addService(Object, int)
• ILcyLucyEnv.removeService(Object)

Method Details

canCreateLayers

public boolean canCreateLayers(ILcdModel aModel)

Description copied from interface: ILspLayerFactory

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 ILspLayerFactory.createLayers(com.luciad.model.ILcdModel) with the same parameters is undefined.

Specified by:

canCreateLayers in interface ILspLayerFactory

Parameters:

aModel - the model for which layers should be created

Returns:

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

createLayers

public Collection<ILspLayer> createLayers(ILcdModel aModel)

Description copied from interface: ILspLayerFactory

Creates one or more ILspLayer objects for the given model.

Note that this method should not be called if ILspLayerFactory.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.

Specified by:

createLayers in interface ILspLayerFactory

Parameters:

aModel - the model for which layers should be created

Returns:

a collection of layers representing the given model