com.luciad.lucy.map.asynchronous

LuciadLightspeedClass TLcyCompositeAsynchronousPaintHintProvider

java.lang.Object

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

com.luciad.lucy.map.asynchronous.TLcyCompositeAsynchronousPaintHintProvider

All Implemented Interfaces:

ILcyAsynchronousPaintHintProvider, ILcdGXYAsynchronousPaintHintProvider, Iterable<ILcyAsynchronousPaintHintProvider>

public class TLcyCompositeAsynchronousPaintHintProvider
extends TLcyGenericComposite<ILcyAsynchronousPaintHintProvider>
implements ILcyAsynchronousPaintHintProvider, ILcdGXYAsynchronousPaintHintProvider

Composite (see composite design pattern) implementation of ILcyAsynchronousPaintHintProvider. It keeps a list of associated ILcyAsynchronousPaintHintProviders. When it needs to provide an asynchronous paint hint, it will delegate to the first suitable paint hint provider.

When creating a new TLcyCompositeAsynchronousPaintHintProvider using the default constructor (see TLcyCompositeAsynchronousPaintHintProvider()), the created instance will only work on/with the ILcyAsynchronousPaintHintProviders registered on this composite instance (see addAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider) and removeAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider)).

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

Retrieving the paint hint for an ILcdLayer 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.
 TLcyCompositeAsynchronousPaintHintProvider provider = new TLcyCompositeAsynchronousPaintHintProvider( aLucyEnv );
 TLcyAsynchronousPaintHint paintHint = provider.getAsynchronousPaintHint( aLayer );
 //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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider aPaintHintProvider) Adds the given ILcyAsynchronousPaintHintProvider to the list of associated providers.
TLcyAsynchronousPaintHint	getAsynchronousPaintHint(ILcdLayer aLayer) Loops over all its associated ILcyAsynchronousPaintHintProviders to find the first suitable provider.
ILcyAsynchronousPaintHintProvider	getAsynchronousPaintHintProvider(int aIndex) Returns the layer type provider at the given index.
int	getAsynchronousPaintHintProviderCount() Returns the number of associated paint hint providers.
TLcdGXYAsynchronousPaintHint	getPaintHint(ILcdGXYAsynchronousLayerWrapper aLayer) Returns the TLcdGXYAsynchronousPaintHint corresponding to the layer aLayer.
void	removeAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider aGXYLayerTypeProvider) Removes the given ILcyAsynchronousPaintHintProvider 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 Detail

TLcyCompositeAsynchronousPaintHintProvider

public TLcyCompositeAsynchronousPaintHintProvider()

Default constructor. No ILcyAsynchronousPaintHintProviders are associated.

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

See Also:

TLcyCompositeAsynchronousPaintHintProvider(com.luciad.lucy.ILcyLucyEnv)

TLcyCompositeAsynchronousPaintHintProvider

public TLcyCompositeAsynchronousPaintHintProvider(ILcyLucyEnv aLucyEnv)

Construct a TLcyCompositeAsynchronousPaintHintProvider working on the Lucy back-end

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

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

Parameters:

aLucyEnv - The Lucy back-end.

See Also:

TLcyCompositeAsynchronousPaintHintProvider(), ILcyLucyEnv.addService(Object, int), ILcyLucyEnv.removeService(Object)

Method Detail

addAsynchronousPaintHintProvider

public void addAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider aPaintHintProvider)

Adds the given ILcyAsynchronousPaintHintProvider to the list of associated providers.

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

Parameters:

aPaintHintProvider - The provider to add.

See Also:

removeAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider), TLcyGenericComposite.add(Object)

removeAsynchronousPaintHintProvider

public void removeAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider aGXYLayerTypeProvider)

Removes the given ILcyAsynchronousPaintHintProvider 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 ILcyAsynchronousPaintHintProvider will be removed as service from the Lucy back-end (see ILcyLucyEnv.removeService(Object)).
Note: it is only possible to remove ILcyAsynchronousPaintHintProvider instances which were registered using the addAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider) method.

Parameters:

aGXYLayerTypeProvider - The provider to remove.

See Also:

addAsynchronousPaintHintProvider(ILcyAsynchronousPaintHintProvider), TLcyGenericComposite.remove(Object)

getAsynchronousPaintHintProviderCount

public int getAsynchronousPaintHintProviderCount()

Returns the number of associated paint hint providers.

Returns:

the number of associated paint hint providers.

See Also:

getAsynchronousPaintHintProvider(int)

getAsynchronousPaintHintProvider

public ILcyAsynchronousPaintHintProvider getAsynchronousPaintHintProvider(int aIndex)

Returns the layer type provider at the given index.

Parameters:

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

Returns:

the layer type provider at the given index.

See Also:

getAsynchronousPaintHintProviderCount()

getAsynchronousPaintHint

public TLcyAsynchronousPaintHint getAsynchronousPaintHint(ILcdLayer aLayer)

Loops over all its associated ILcyAsynchronousPaintHintProviders to find the first suitable provider. Suitable means it does not return null.

Specified by:

getAsynchronousPaintHint in interface ILcyAsynchronousPaintHintProvider

Parameters:

aLayer - The layer to provide the layer type of.

Returns:

The asynchronous paint hint returned by the first suitable provider, or null if no such provider could be found.

See Also:

TLcyAsynchronousPaintHint

getPaintHint

public TLcdGXYAsynchronousPaintHint getPaintHint(ILcdGXYAsynchronousLayerWrapper aLayer)

Description copied from interface: ILcdGXYAsynchronousPaintHintProvider

Returns the TLcdGXYAsynchronousPaintHint corresponding to the layer aLayer.

Depending on the returned TLcdGXYAsynchronousPaintHint instances, it might be useful for implementations of this class to use a caching mechanism. This is however left to the implementation.

Specified by:

getPaintHint in interface ILcdGXYAsynchronousPaintHintProvider

Parameters:

aLayer - The layer to retrieve the paint hint for.

Returns:

the paint hint