|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.worldwind.BasicDataConfiguration
gov.nasa.worldwind.layers.LayerConfiguration
public class LayerConfiguration
An implementation of the DataConfiguration
interface, which uses a Layer
configuration document as its backing store.
Field Summary |
---|
Fields inherited from class gov.nasa.worldwind.BasicDataConfiguration |
---|
dom, xpath |
Constructor Summary | |
---|---|
LayerConfiguration(Element domElement)
Creates an instance of LayerConfiguration backed by a specified DOM Element . |
Method Summary | |
---|---|
protected DataConfiguration |
createChildConfigInfo(Element domElement)
|
static Element |
createLayerElements(AVList params,
Element context)
Appends layer parameters as elements to a specified context. |
static Document |
createTiledImageLayerDocument(AVList params)
Creates a configuration document for the tiled image layer described by the specified params. |
static Element |
createTiledImageLayerElements(AVList params,
Element context)
Appends tiled image layer parameters as elements to a specified context. |
static Element |
createWMSTiledImageLayerElements(AVList params,
Element context)
Appends WMS tiled image layer parameters as elements to a specified context. |
static AVList |
getLayerParams(Element domElement,
AVList params)
Parses layer parameters from a specified DOM document. |
String |
getName()
Returns the text content of the DisplayName element. |
static AVList |
getTiledImageLayerParams(Element domElement,
AVList params)
Parses tiled image layer parameters from a specified DOM document. |
String |
getType()
Returns the string "Layer". |
String |
getVersion()
Returns the layer's version. |
static AVList |
getWMSTiledImageLayerParams(Capabilities caps,
String[] formatOrderPreference,
AVList params)
Parses WMS tiled image layer parameters from a specified WMS Capabilities document. |
static AVList |
getWMSTiledImageLayerParams(Element domElement,
AVList params)
Parses WMS tiled image layer parameters from a specified DOM document. |
static boolean |
isLayerDocument(Element domElement)
Returns true if a specified DOM document should be accepted as a Layer configuration document, and false otherwise. |
Methods inherited from class gov.nasa.worldwind.BasicDataConfiguration |
---|
getBoolean, getChild, getChildren, getDouble, getInteger, getLatLon, getLong, getSector, getSectorResolutionLimit, getSource, getString, getStringArray, getTimeInMillis, getUniqueStrings, getXPath |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LayerConfiguration(Element domElement)
Element
.
domElement
- the backing DOM Element.Method Detail |
---|
protected DataConfiguration createChildConfigInfo(Element domElement)
createChildConfigInfo
in class BasicDataConfiguration
public static Element createLayerElements(AVList params, Element context)
Key | Name | Type |
AVKey.DISPLAY_NAME | DisplayName | String |
AVKey.OPACITY | Opacity | Double |
AVKey.MAX_ACTIVE_ALTITUDE | ActiveAltitudes/@max | Double |
AVKey.MIN_ACTIVE_ALTITUDE | ActiveAltitudes/@min | Double |
AVKey.NETWORK_RETRIEVAL_ENABLED | NetworkRetrievalEnabled | Boolean |
AVKey.MAP_SCALE | MapScale | Double |
AVKey.SCREEN_CREDIT | ScreenCredit | ScreenCredit |
params
- the key-value pairs which define the layer parameters.context
- the XML document root on which to append parameter elements.
IllegalArgumentException
- if either the parameters or the context are null.public static Document createTiledImageLayerDocument(AVList params)
BasicTiledImageLayer
.
params
- parameters describing the tiled image layer.
public static Element createTiledImageLayerElements(AVList params, Element context)
DataConfigurationUtils.createLevelSetElements(gov.nasa.worldwind.avlist.AVList, org.w3c.dom.Element)
. Supported
key and element paths are: Key | Name | Type |
AVKey.SERVICE_NAME | Service/@serviceName | String |
AVKey.AVAILABLE_IMAGE_FORMATS | AvailableImageFormats/ImageFormat | String array |
AVKey.FORCE_LEVEL_ZERO_LOADS | ForceLevelZeroLoads | Boolean |
AVKey.RETAIN_LEVEL_ZERO_TILES | RetainLevelZeroTiles | Boolean |
AVKey.USE_MIP_MAPS | UseMipMaps | Boolean |
AVKey.USE_TRANSPARENT_TEXTURES | UseTransparentTextures | Boolean |
AVKey.URL_CONNECT_TIMEOUT | RetrievalTimeouts/ConnectTimeout/Time | Integer milliseconds |
AVKey.URL_READ_TIMEOUT | RetrievalTimeouts/ReadTimeout/Time | Integer milliseconds |
AVKey.RETRIEVAL_QUEUE_STALE_REQUEST_LIMIT | RetrievalTimeouts/StaleRequestLimit/Time | Integer milliseconds |
params
- the key-value pairs which define the tiled image layer parameters.context
- the XML document root on which to append parameter elements.
IllegalArgumentException
- if either the parameters or the context are null.public static Element createWMSTiledImageLayerElements(AVList params, Element context)
DataConfigurationUtils.createWMSLayerElements(gov.nasa.worldwind.avlist.AVList, org.w3c.dom.Element)
.
params
- the key-value pairs which define the WMS tiled image layer parameters.context
- the XML document root on which to append parameter elements.
IllegalArgumentException
- if either the parameters or the context are null.public static AVList getLayerParams(Element domElement, AVList params)
Key | Name | Type |
AVKey.DISPLAY_NAME | DisplayName | String |
AVKey.OPACITY | Opacity | Double |
AVKey.MAX_ACTIVE_ALTITUDE | ActiveAltitudes/@max | Double |
AVKey.MIN_ACTIVE_ALTITUDE | ActiveAltitudes/@min | Double |
AVKey.NETWORK_RETRIEVAL_ENABLED | NetworkRetrievalEnabled | Boolean |
AVKey.MAP_SCALE | MapScale | Double |
AVKey.SCREEN_CREDIT | ScreenCredit | ScreenCredit |
domElement
- the XML document root to parse for layer parameters.params
- the output key-value pairs which recieve the layer parameters. A null reference is permitted.
IllegalArgumentException
- if the document is null.public String getName()
DisplayName
element.
getName
in interface DataConfiguration
getName
in class BasicDataConfiguration
public static AVList getTiledImageLayerParams(Element domElement, AVList params)
DataConfigurationUtils.getLevelSetParams(org.w3c.dom.Element,
gov.nasa.worldwind.avlist.AVList)
. This writes output as key-value pairs to params. If a parameter from the XML
document already exists in params, that parameter is ignored. Supported key and parameter names are: Key | Name | Type |
AVKey.SERVICE_NAME | Service/@serviceName | String |
AVKey.AVAILABLE_IMAGE_FORMATS | AvailableImageFormats/ImageFormat | String array |
AVKey.FORCE_LEVEL_ZERO_LOADS | ForceLevelZeroLoads | Boolean |
AVKey.RETAIN_LEVEL_ZERO_TILES | RetainLevelZeroTiles | Boolean |
AVKey.USE_MIP_MAPS | UseMipMaps | Boolean |
AVKey.USE_TRANSPARENT_TEXTURES | UseTransparentTextures | Boolean |
AVKey.URL_CONNECT_TIMEOUT | RetrievalTimeouts/ConnectTimeout/Time | Integer milliseconds |
AVKey.URL_READ_TIMEOUT | RetrievalTimeouts/ReadTimeout/Time | Integer milliseconds |
AVKey.RETRIEVAL_QUEUE_STALE_REQUEST_LIMIT | RetrievalTimeouts/StaleRequestLimit/Time | Integer milliseconds |
domElement
- the XML document root to parse for tiled image layer parameters.params
- the output key-value pairs which recieve the tiled image layer parameters. A null reference is
permitted.
IllegalArgumentException
- if the document is null.public String getType()
getType
in interface DataConfiguration
getType
in class BasicDataConfiguration
public String getVersion()
getVersion
in interface DataConfiguration
getVersion
in class BasicDataConfiguration
public static AVList getWMSTiledImageLayerParams(Capabilities caps, String[] formatOrderPreference, AVList params)
Capabilities
document. This also parses
common WMS layer parameters by invoking DataConfigurationUtils.getWMSLayerParams(gov.nasa.worldwind.wms.Capabilities,
String[], gov.nasa.worldwind.avlist.AVList)
. This writes output as key-value pairs to params.
caps
- the WMS Capabilities document to parse for WMS layer 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 WMS layer parameters.
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.public static AVList getWMSTiledImageLayerParams(Element domElement, AVList params)
DataConfigurationUtils.getWMSLayerParams(org.w3c.dom.Element,
gov.nasa.worldwind.avlist.AVList)
. This writes output as key-value pairs to params. If a parameter from the XML
document already exists in params, that parameter is ignored.
domElement
- the XML document root to parse for WMS tiled image layer parameters.params
- the output key-value pairs which recieve the WMS tiled image layer parameters. A null reference
is permitted.
IllegalArgumentException
- if the document is null.public static boolean isLayerDocument(Element domElement)
domElement
- the DOM document in question.
IllegalArgumentException
- if document is null.
|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |