Package gov.nasa.worldwind.terrain

Class WMSBasicElevationModel

java.lang.Object

gov.nasa.worldwind.avlist.AVListImpl

gov.nasa.worldwind.WWObjectImpl

gov.nasa.worldwind.terrain.AbstractElevationModel

gov.nasa.worldwind.terrain.BasicElevationModel

gov.nasa.worldwind.terrain.WMSBasicElevationModel

All Implemented Interfaces:

AVList, Disposable, MessageListener, ElevationModel, Restorable, BulkRetrievable, WWObject, java.beans.PropertyChangeListener, java.util.EventListener

public class WMSBasicElevationModel
extends BasicElevationModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	WMSBasicElevationModel.CompositionRetrievalPostProcessor
protected static class	WMSBasicElevationModel.ElevationCompositionTile
protected static class	WMSBasicElevationModel.URLBuilder

Nested classes/interfaces inherited from class gov.nasa.worldwind.terrain.BasicElevationModel

BasicElevationModel.DownloadPostProcessor, BasicElevationModel.Elevations, BasicElevationModel.ElevationTile, BasicElevationModel.RequestTask

Field Summary

Fields inherited from class gov.nasa.worldwind.terrain.BasicElevationModel

detailHint, elevationDataByteOrder, elevationDataType, extremes, extremesCachingEnabled, extremesLevel, extremesLookupCache, fileLock, levels, levelZeroTiles, maxElevation, memoryCache, minElevation, RESOURCE_ID_OGC_CAPABILITIES

Fields inherited from class gov.nasa.worldwind.terrain.AbstractElevationModel

dataFileStore, enabled, expiryTime, missingDataFlag, missingDataValue, networkRetrievalEnabled

Constructor Summary

Constructors

Constructor	Description
WMSBasicElevationModel(AVList params)
WMSBasicElevationModel(WMSCapabilities caps, AVList params)
WMSBasicElevationModel(java.lang.String restorableStateInXml)
WMSBasicElevationModel(org.w3c.dom.Element domElement, AVList params)

Method Summary

Modifier and Type	Method	Description
void	composeElevations(Sector sector, java.util.List<? extends LatLon> latlons, int tileWidth, double[] buffer)	Determines the elevations at specified locations within a specified Sector.
protected org.w3c.dom.Document	createConfigurationDocument(AVList params)	Appends WMS basic elevation model configuration elements to the superclass configuration document.
protected void	downloadElevations(WMSBasicElevationModel.ElevationCompositionTile tile)
void	getRestorableStateForAVPair(java.lang.String key, java.lang.Object value, RestorableSupport rs, RestorableSupport.StateObject context)
static AVList	getWMSElevationModelConfigParams(WMSCapabilities caps, java.lang.String[] formatOrderPreference, AVList params)	Parses WMSBasicElevationModel configuration parameters from a specified WMS Capabilities source.
protected static AVList	wmsGetParamsFromCapsDoc(WMSCapabilities caps, AVList params)
protected static AVList	wmsGetParamsFromDocument(org.w3c.dom.Element domElement, AVList params)
protected static AVList	wmsRestorableStateToParams(java.lang.String stateInXml)
protected static void	wmsRestoreStateForParams(RestorableSupport rs, RestorableSupport.StateObject context, AVList params)
protected static void	wmsSetFallbacks(AVList params)

Methods inherited from class gov.nasa.worldwind.terrain.BasicElevationModel

addTileToCache, areElevationsInMemory, checkElevationExpiration, checkElevationExpiration, computeExtremeElevations, contains, convertImageToElevations, createBasicElevationModelConfigDocument, createBasicElevationModelConfigElements, createMemoryCache, createTile, determineExtremes, doGetRestorableState, doRestoreState, doRestoreStateForObject, downloadElevations, downloadElevations, doWriteConfigurationParams, generateExtremeElevations, getBasicElevationModelConfigParams, getBestResolution, getConfigurationParams, getDetailHint, getElevationDataByteOrder, getElevationDataType, getElevations, getElevations, getElevations, getEstimatedMissingDataSize, getEstimatedMissingDataSize, getExtremeElevations, getExtremeElevations, getExtremes, getExtremesLevel, getExtremesLookupCache, getLevels, getLevelZeroTiles, getLocalDataAvailability, getMaxElevation, getMemoryCache, getMinElevation, getRestorableState, getTargetLevel, getTileFromMemory, getUnmappedElevation, getUnmappedElevations, getUnmappedLocalSourceElevation, getValue, initFromOGCCapabilitiesResource, intersects, isExtremesCachingEnabled, isFileExpired, isRetrieveResources, isTileLocalOrAbsent, loadElevations, loadExtremeElevations, lookupElevation, makeBilElevations, makeLocal, makeLocal, makeTiffElevations, needsConfigurationFile, readElevations, requestTile, restorableStateToParams, restoreState, restoreStateForParams, retrieveElevations, retrieveLocalElevations, retrieveRemoteElevations, retrieveResources, setByteOrder, setDetailHint, setElevationDataType, setExpiryTime, setExtremesCachingEnabled, setFallbacks, setValue, startResourceRetrieval, writeConfigurationFile, writeConfigurationParams

Methods inherited from class gov.nasa.worldwind.terrain.AbstractElevationModel

createElevationModelConfigElements, dispose, getBestResolutions, getDataFileStore, getElevation, getElevationModelConfigParams, getElevations, getExpiryTime, getMissingDataReplacement, getMissingDataSignal, getName, getUnmappedElevations, isElevationModelConfigDocument, isEnabled, isNetworkRetrievalEnabled, isTransparentValue, setDataFileStore, setEnabled, setMissingDataReplacement, setMissingDataSignal, setName, setNetworkRetrievalEnabled, toString

Methods inherited from class gov.nasa.worldwind.WWObjectImpl

onMessage, propertyChange

Methods inherited from class gov.nasa.worldwind.avlist.AVListImpl

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getBooleanValue, getBooleanValue, getChangeSupport, getDoubleValue, getDoubleValue, getEntries, getIntegerValue, getIntegerValue, getLongValue, getLongValue, getStringValue, getStringValue, getStringValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nasa.worldwind.avlist.AVList

addPropertyChangeListener, addPropertyChangeListener, clearList, copy, firePropertyChange, firePropertyChange, getEntries, getStringValue, getValues, hasKey, removeKey, removePropertyChangeListener, removePropertyChangeListener, setValues

Methods inherited from interface gov.nasa.worldwind.retrieve.BulkRetrievable

getName

Methods inherited from interface gov.nasa.worldwind.event.MessageListener

onMessage

Methods inherited from interface java.beans.PropertyChangeListener

propertyChange

Constructor Detail

WMSBasicElevationModel

public WMSBasicElevationModel(AVList params)

WMSBasicElevationModel

public WMSBasicElevationModel(org.w3c.dom.Element domElement,
                              AVList params)

WMSBasicElevationModel

public WMSBasicElevationModel(WMSCapabilities caps,
                              AVList params)

WMSBasicElevationModel

public WMSBasicElevationModel(java.lang.String restorableStateInXml)

Method Detail

wmsGetParamsFromDocument

protected static AVList wmsGetParamsFromDocument(org.w3c.dom.Element domElement,
                                                 AVList params)

wmsGetParamsFromCapsDoc

protected static AVList wmsGetParamsFromCapsDoc(WMSCapabilities caps,
                                                AVList params)

wmsSetFallbacks

protected static void wmsSetFallbacks(AVList params)

getWMSElevationModelConfigParams

public static AVList getWMSElevationModelConfigParams(WMSCapabilities caps,
                                                      java.lang.String[] formatOrderPreference,
                                                      AVList params)

Parses WMSBasicElevationModel configuration parameters from a specified WMS Capabilities source. This writes output as key-value pairs to params. Supported key and parameter names are:

Parameters

Parameter	Value	Type
AVKey.ELEVATION_MAX	WMS layer's maximum extreme elevation	Double
AVKey.ELEVATION_MIN	WMS layer's minimum extreme elevation	Double
AVKey.DATA_TYPE	Translate WMS layer's image format to a matching data type	String

This also parses common WMS layer parameters by invoking DataConfigurationUtils.getWMSLayerConfigParams(gov.nasa.worldwind.ogc.wms.WMSCapabilities, String[], gov.nasa.worldwind.avlist.AVList).

Parameters:

caps - the WMS Capabilities source to parse for WMSBasicElevationModel configuration parameters.

formatOrderPreference - an ordered array of preferred image formats, or null to use the default format.

params - the output key-value pairs which recieve the WMSBasicElevationModel configuration parameters.

Returns:

a reference to params.

Throws:

java.lang.IllegalArgumentException - if either the document or params are null, or if params does not contain the required key-value pairs.

WWRuntimeException - if the Capabilities document does not contain any of the required information.

createConfigurationDocument

protected org.w3c.dom.Document createConfigurationDocument(AVList params)

Appends WMS basic elevation model configuration elements to the superclass configuration document.

Overrides:

createConfigurationDocument in class BasicElevationModel

Parameters:

params - configuration parameters describing this WMS basic elevation model.

Returns:

a WMS basic elevation model configuration document.

composeElevations

public void composeElevations(Sector sector,
                              java.util.List<? extends LatLon> latlons,
                              int tileWidth,
                              double[] buffer)
                       throws java.lang.Exception

Description copied from interface: ElevationModel

Determines the elevations at specified locations within a specified Sector.

Specified by:

composeElevations in interface ElevationModel

Overrides:

composeElevations in class AbstractElevationModel

Parameters:

sector - the sector containing the locations.

latlons - the locations for which to return elevations.

tileWidth - the number of locations that comprise one row in the latlons argument.

buffer - a buffer in which to put the elevations. The buffer must have at least as many elements as the number of specified locations.

Throws:

java.lang.Exception - if the method fails. Different elevation models may fail for different reasons.

java.lang.IllegalArgumentException - if either the sector, list of locations or buffer is null, if the buffer size is not at least as large as the location list, or the tile width is greater than the locations list length or less than 1.

downloadElevations

protected void downloadElevations(WMSBasicElevationModel.ElevationCompositionTile tile)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getRestorableStateForAVPair

public void getRestorableStateForAVPair(java.lang.String key,
                                        java.lang.Object value,
                                        RestorableSupport rs,
                                        RestorableSupport.StateObject context)

Overrides:

getRestorableStateForAVPair in class BasicElevationModel

wmsRestorableStateToParams

protected static AVList wmsRestorableStateToParams(java.lang.String stateInXml)

wmsRestoreStateForParams

protected static void wmsRestoreStateForParams(RestorableSupport rs,
                                               RestorableSupport.StateObject context,
                                               AVList params)