com.luciad.util.height

LuciadLightspeedClass ALcdRasterModelHeightProviderFactory

java.lang.Object

com.luciad.util.height.ALcdModelHeightProviderFactory

com.luciad.util.height.ALcdRasterModelHeightProviderFactory

All Implemented Interfaces:

ILcdModelHeightProviderFactory

Direct Known Subclasses:

TLcdImageModelHeightProviderFactory, TLcdRasterModelHeightProviderFactory

public abstract class ALcdRasterModelHeightProviderFactory
extends ALcdModelHeightProviderFactory

This class provides the common interface and methods of both the legacy TLcdRasterModelHeightProviderFactory and the new TLcdImageModelHeightProviderFactory

Since:

2014.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_INTERPOLATE_DATA Key used to to denote that the raster data should be interpolated.
static String	KEY_MAX_VALID_HEIGHT Key for the maximum valid height of the returned height.
static String	KEY_MIN_VALID_HEIGHT Key for the minimum valid height of the returned height.
static String	KEY_PIXEL_DENSITY Key used for a pixel density value.

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

KEY_GEO_REFERENCE

Constructor Summary

Constructors

Constructor and Description
ALcdRasterModelHeightProviderFactory()

Method Summary

Modifier and Type	Method and Description
protected boolean	canCreateHeightProvider(ILcdModel aModel) Check if a height provider can be created from the given ILcdModel.
protected abstract ILcdHeightProvider	createModelElementHeightProvider(Object aElement, Map<String,Object> aRequiredPropertiesSFCT, Map<String,Object> aOptionalProperties) Creates an ILcdHeightProvider for the given model element.
protected void	transformProperties(ILcdModel aModel, ILcdGeoReference aFromReference, ILcdGeoReference aToReference, Map<String,Object> aRequiredProperties, Map<String,Object> aOptionalProperties) Transforms the properties in the TLcdHeightProviderProperties.

Methods inherited from class com.luciad.util.height.ALcdModelHeightProviderFactory

createHeightProvider

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PIXEL_DENSITY

public static final String KEY_PIXEL_DENSITY

Key used for a pixel density value. The property should be a double. Pixel density is defined as the number of pixels in an image or raster per unit of area. The area should be expressed in function of the given KEY_GEO_REFERENCE property. This property is used when the height provider is backed by multi-level data. It gives a hint to the implementation which level should be chosen. If this property is not provided, or set to Double.NaN, the most detailed level is chosen.

See Also:

Constant Field Values

KEY_MIN_VALID_HEIGHT

public static final String KEY_MIN_VALID_HEIGHT

Key for the minimum valid height of the returned height. The property should be an integer.

See Also:

Constant Field Values

KEY_MAX_VALID_HEIGHT

public static final String KEY_MAX_VALID_HEIGHT

Key for the maximum valid height of the returned height. The property should be an integer.

See Also:

Constant Field Values

KEY_INTERPOLATE_DATA

public static final String KEY_INTERPOLATE_DATA

Key used to to denote that the raster data should be interpolated. The property should be a boolean.

See Also:

Constant Field Values

Constructor Detail

ALcdRasterModelHeightProviderFactory

public ALcdRasterModelHeightProviderFactory()

Method Detail

createModelElementHeightProvider

protected abstract ILcdHeightProvider createModelElementHeightProvider(Object aElement,
                                                                       Map<String,Object> aRequiredPropertiesSFCT,
                                                                       Map<String,Object> aOptionalProperties)
                                                                throws TLcdMissingPropertyException,
                                                                       TLcdUnsupportedPropertyException

Description copied from class: ALcdModelHeightProviderFactory

Creates an ILcdHeightProvider for the given model element.

Specified by:

createModelElementHeightProvider in class ALcdModelHeightProviderFactory

Parameters:

aElement - a model element.

aRequiredPropertiesSFCT - the required properties.

aOptionalProperties - the optional properties.

Returns:

an ILcdHeightProvider for the given model element or null if no ILcdHeightProvider can be created.

Throws:

TLcdMissingPropertyException - when a property is missing that is necessary to create the ILcdHeightProvider.

TLcdUnsupportedPropertyException - when a required property was never used while creating the ILcdHeightProvider.

canCreateHeightProvider

protected boolean canCreateHeightProvider(ILcdModel aModel)

Check if a height provider can be created from the given ILcdModel. The default implementation only returns true if the model contains a TLcdRasterModelDescriptor or a TLcdMultilevelRasterModelDescriptor, and false otherwise.

Specified by:

canCreateHeightProvider in class ALcdModelHeightProviderFactory

Parameters:

aModel - the given model.

Returns:

true if a height provider can be created from the given model and false otherwise.

transformProperties

protected void transformProperties(ILcdModel aModel,
                                   ILcdGeoReference aFromReference,
                                   ILcdGeoReference aToReference,
                                   Map<String,Object> aRequiredProperties,
                                   Map<String,Object> aOptionalProperties)
                            throws TLcdOutOfBoundsException

Description copied from class: ALcdModelHeightProviderFactory

Transforms the properties in the TLcdHeightProviderProperties. A height provider factory that extends this class should override this method if it defines extra properties that depend on the geo reference property. If this is the case, it should be possible to transform these properties to aToReference.

Overrides:

transformProperties in class ALcdModelHeightProviderFactory

Parameters:

aModel - a model defined with respect to aToReference.

aFromReference - the reference in which the properties are defined.

aToReference - the reference to which the properties will be transformed.

aRequiredProperties - the required properties.

aOptionalProperties - the optional properties.

Throws:

TLcdOutOfBoundsException - when a property cannot be transformed correctly.