Package com.luciad.lucy.map

Class TLcyCompositeGXYLayerTypeProvider

java.lang.Object

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

com.luciad.lucy.map.TLcyCompositeGXYLayerTypeProvider

All Implemented Interfaces:

ILcyGXYLayerType, ILcyGXYLayerTypeProvider, Iterable<ILcyGXYLayerTypeProvider>

public class TLcyCompositeGXYLayerTypeProvider
extends TLcyGenericComposite<ILcyGXYLayerTypeProvider>
implements ILcyGXYLayerTypeProvider

Composite (see composite design pattern) implementation of ILcyGXYLayerTypeProvider. It keeps a list of associated ILcyGXYLayerTypeProviders. When it needs to provide a layer type, it will delegate to the first suitable layer type provider.

When creating a new TLcyCompositeGXYLayerTypeProvider using the default constructor (see TLcyCompositeGXYLayerTypeProvider()), the created instance will only work on/with the ILcyGXYLayerTypeProviders registered on this composite instance (see addGXYLayerTypeProvider(ILcyGXYLayerTypeProvider) and removeGXYLayerTypeProvider(ILcyGXYLayerTypeProvider)).

When creating a new TLcyCompositeGXYLayerTypeProvider using the constructor specifying an ILcyLucyEnv instance (see TLcyCompositeGXYLayerTypeProvider(com.luciad.lucy.ILcyLucyEnv), the created instance will work on the Lucy back-end services. It will use all registered ILcyGXYLayerTypeProvider instances of the Lucy back-end, adding and/or removing an ILcyGXYLayerTypeProvider will add/remove the ILcyGXYLayerTypeProvider as service from Lucy, ... .

Retrieving the layer type for an ILcdGXYLayer using the back-end based implementation can be done by creating a new instance of this class:

 //Create a new instance whenever you need it.
 TLcyCompositeGXYLayerTypeProvider provider = new TLcyCompositeGXYLayerTypeProvider( aLucyEnv );
 int layerType = provider.getGXYLayerType( aGXYLayer );
 //There is no need to keep a reference to the composite instance, you can create a new one
 //the next time you would need it
 provider = null;
 

Field Summary

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

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Fields inherited from interface com.luciad.lucy.map.ILcyGXYLayerType

BACKGROUND, EDITABLE, REALTIME, UNKNOWN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addGXYLayerTypeProvider(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider)	Adds the given ILcyGXYLayerTypeProvider to the list of associated providers.
int	getGXYLayerType(ILcdGXYLayer aGXYLayer)	Loops over all its associated ILcyGXYLayerTypeProviders to find the first suitable provider.
ILcyGXYLayerTypeProvider	getGXYLayerTypeProvider(int aIndex)	Returns the layer type provider at the given index.
int	getGXYLayerTypeProviderCount()	Returns the number of associated layer type providers.
void	removeGXYLayerTypeProvider(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider)	Removes the given ILcyGXYLayerTypeProvider from the list of associated providers.

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

TLcyCompositeGXYLayerTypeProvider

public TLcyCompositeGXYLayerTypeProvider()

Default constructor. No ILcyGXYLayerTypeProviders are associated.

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

TLcyCompositeGXYLayerTypeProvider

public TLcyCompositeGXYLayerTypeProvider(ILcyLucyEnv aLucyEnv)

Construct a TLcyCompositeGXYLayerTypeProvider working on the Lucy back-end

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

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

Parameters:

aLucyEnv - The Lucy back-end.

See Also:

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

Method Details

addGXYLayerTypeProvider

public void addGXYLayerTypeProvider(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider)

Adds the given ILcyGXYLayerTypeProvider to the list of associated providers.

If the constructor specifying an ILcyLucyEnv is used, the ILcyGXYLayerTypeProvider will be registered as a service on the Lucy back-end (see ILcyLucyEnv.addService(Object, int)). When calling ILcyLucyEnv.getServices(Class) afterwards, aGXYLayerTypeProvider will only be included in the returned list when the requested class was ILcyGXYLayerTypeProvider.class.
Note: if you want to remove the registered ILcyGXYLayerTypeProvider afterwards, use removeGXYLayerTypeProvider(ILcyGXYLayerTypeProvider) and not ILcyLucyEnv.removeService(Object).

Parameters:

aGXYLayerTypeProvider - The provider to add.

See Also:

• removeGXYLayerTypeProvider(ILcyGXYLayerTypeProvider)

removeGXYLayerTypeProvider

public void removeGXYLayerTypeProvider(ILcyGXYLayerTypeProvider aGXYLayerTypeProvider)

Removes the given ILcyGXYLayerTypeProvider from the list of associated providers. If the given provider was never added, nothing will happen.

If the constructor specifying an ILcyLucyEnv is used, the ILcyGXYLayerTypeProvider will be removed as service from the Lucy back-end (see ILcyLucyEnv.removeService(Object)).
Note: it is only possible to remove ILcyGXYLayerTypeProvider instances which were registered using the addGXYLayerTypeProvider(ILcyGXYLayerTypeProvider) method.

Parameters:

aGXYLayerTypeProvider - The provider to remove.

See Also:

• addGXYLayerTypeProvider(ILcyGXYLayerTypeProvider)

getGXYLayerTypeProviderCount

public int getGXYLayerTypeProviderCount()

Returns the number of associated layer type providers.

Returns:

the number of associated layer type providers.

See Also:

• getGXYLayerTypeProvider(int)

getGXYLayerTypeProvider

public ILcyGXYLayerTypeProvider getGXYLayerTypeProvider(int aIndex)

Returns the layer type provider at the given index.

Parameters:

aIndex - The index of the provider to retrieve. 0 <= aIndex < getGXYLayerTypeProviderCount()

Returns:

the layer type provider at the given index.

See Also:

• getGXYLayerTypeProviderCount()

getGXYLayerType

public int getGXYLayerType(ILcdGXYLayer aGXYLayer)

Loops over all its associated ILcyGXYLayerTypeProviders to find the first suitable provider. Suitable means it does not return ILcyGXYLayerType.UNKNOWN. Providing the layer type is delegated to the first suitable provider.

Specified by:

getGXYLayerType in interface ILcyGXYLayerTypeProvider

Parameters:

aGXYLayer - The layer to provide the layer type of.

Returns:

The layer type returned by the first suitable provider, or ILcyGXYLayerType.UNKNOWN if no such provider could be found.

See Also:

• ILcyGXYLayerType