com.luciad.lucy.util.height

LuciadLightspeedClass TLcyCompositeLayerHeightProviderFactory

java.lang.Object

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

com.luciad.lucy.util.height.TLcyCompositeLayerHeightProviderFactory

All Implemented Interfaces:

ILcdLayerHeightProviderFactory, Iterable<ILcdLayerHeightProviderFactory>

public class TLcyCompositeLayerHeightProviderFactory
extends TLcyGenericComposite<ILcdLayerHeightProviderFactory>
implements ILcdLayerHeightProviderFactory

Composite implementation of ILcdLayerHeightProviderFactory.

This composite implementation can work on the registered Lucy services, or as a regular composite implementation. Consult the javadoc of TLcyGenericComposite for an in-depth explanation.

Since:

10.1

See Also:

TLcyGenericComposite

Field Summary

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

PRIORITY_DEFAULT, PRIORITY_FALLBACK

Fields inherited from interface com.luciad.util.height.ILcdLayerHeightProviderFactory

KEY_GEO_REFERENCE

Constructor Summary

Constructors

Constructor and Description
TLcyCompositeLayerHeightProviderFactory() Default constructor
TLcyCompositeLayerHeightProviderFactory(ILcyLucyEnv aLucyEnv) Constructor for a composite ILcdLayerHeightProviderFactory which will work on the registered ILcdLayerHeightProviderFactory instances of the Lucy back-end.

Method Summary

Modifier and Type	Method and Description
ILcdHeightProvider	createHeightProvider(ILcdLayer aLayer, ILcdView aView, Map<String,Object> aRequiredPropertiesSFCT, Map<String,Object> aOptionalProperties) Returns a height provider for a given ILcdLayer and ILcdView using the given properties.

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

TLcyCompositeLayerHeightProviderFactory

public TLcyCompositeLayerHeightProviderFactory()

Default constructor

See Also:

TLcyGenericComposite.TLcyGenericComposite()

TLcyCompositeLayerHeightProviderFactory

public TLcyCompositeLayerHeightProviderFactory(ILcyLucyEnv aLucyEnv)

Constructor for a composite ILcdLayerHeightProviderFactory which will work on the registered ILcdLayerHeightProviderFactory instances of the Lucy back-end.

Parameters:

aLucyEnv - The Lucy back-end

See Also:

TLcyGenericComposite.TLcyGenericComposite(com.luciad.lucy.ILcyLucyEnv, Class)

Method Detail

createHeightProvider

public ILcdHeightProvider createHeightProvider(ILcdLayer aLayer,
                                               ILcdView aView,
                                               Map<String,Object> aRequiredPropertiesSFCT,
                                               Map<String,Object> aOptionalProperties)
                                        throws TLcdMissingPropertyException,
                                               TLcdUnsupportedPropertyException

Description copied from interface: ILcdLayerHeightProviderFactory

Returns a height provider for a given ILcdLayer and ILcdView using the given properties. The returned height provider is determined by the implementation, the ILcdLayer, ILcdView and the given properties.

Specified by:

createHeightProvider in interface ILcdLayerHeightProviderFactory

Parameters:

aLayer - an ILcdLayer for which a height provider is created.

aView - an ILcdView in which aLayer is contained.

aRequiredPropertiesSFCT - the required properties. The properties can be retrieved using a String key describing the property type. When not all required properties are used, an exception is thrown. aRequiredProperties may be empty but should not be null. When a required property as used, it should always be removed from the list of required properties. When an ILcdHeightProvider is actually made, the list of required properties should be verified.

aOptionalProperties - the optional properties. The properties can be retrieved using a String key describing the property type. The optional properties may or may not be used by the implementation. aOptionalProperties may be empty but should not be null.

Returns:

a height provider if elevation is supported, or null when elevation is not supported or when no valid height provider can be created.

Throws:

TLcdMissingPropertyException - when the implementation misses a necessary property.

TLcdUnsupportedPropertyException - when a required property is not used by the implementation.

See Also:

ILcdModelHeightProviderFactory