/**
* Appends elevation model parameters as elements to a specified context. If a parameter key
* exists, that parameter is appended to the context. Supported key and element paths are:
*
* <table> <th><td>Key</td><td>Name</td><td>Type</td></th>
* <tr><td>{@link AVKey#DISPLAY_NAME}</td><td>DisplayName</td><td>String</td></tr> <tr><td>{@link
* AVKey#NETWORK_RETRIEVAL_ENABLED}</td><td>NetworkRetrievalEnabled</td><td>Boolean</td></tr> <tr><td>{@link
* AVKey#MISSING_DATA_SIGNAL}</td><td>MissingData/@signal</td><td>Double</td></tr> <tr><td>{@link
* AVKey#MISSING_DATA_REPLACEMENT}</td><td>MissingData/@replacement</td><td>Double</td></tr> <tr><td>{@link
* AVKey#DETAIL_HINT}</td><td>DataDetailHint</td><td>Double</td></tr> </table>
*
* @param params the key-value pairs which define the elevation model parameters.
* @param context the XML document root on which to append parameter elements.
* @return a reference to context.
* @throws IllegalArgumentException if either the parameters or the context are null.
*/
public static Element createElevationModelElements(AVList params, Element context) {
if (params == null) {
String message = Logging.getMessage("nullValue.ParametersIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (context == null) {
String message = Logging.getMessage("nullValue.ContextIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
WWXML.checkAndAppendTextElement(params, AVKey.DISPLAY_NAME, context, "DisplayName");
WWXML.checkAndAppendBooleanElement(
params, AVKey.NETWORK_RETRIEVAL_ENABLED, context, "NetworkRetrievalEnabled");
if (params.getValue(AVKey.MISSING_DATA_SIGNAL) != null
|| params.getValue(AVKey.MISSING_DATA_REPLACEMENT) != null) {
Element el = WWXML.getElement(context, "MissingData", null);
if (el == null) el = WWXML.appendElementPath(context, "MissingData");
Double d = AVListImpl.getDoubleValue(params, AVKey.MISSING_DATA_SIGNAL);
if (d != null) el.setAttribute("signal", Double.toString(d));
d = AVListImpl.getDoubleValue(params, AVKey.MISSING_DATA_REPLACEMENT);
if (d != null) el.setAttribute("replacement", Double.toString(d));
}
WWXML.checkAndAppendDoubleElement(params, AVKey.DETAIL_HINT, context, "DataDetailHint");
return context;
}
protected static AVList wmsGetParamsFromCapsDoc(Capabilities caps, AVList params) {
if (caps == null) {
String message = Logging.getMessage("nullValue.WMSCapabilities");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (params == null) {
String message = Logging.getMessage("nullValue.LayerConfigParams");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
try {
DataConfigurationUtils.getWMSLayerParams(caps, formatOrderPreference, params);
} catch (IllegalArgumentException e) {
String message = Logging.getMessage("WMS.MissingLayerParameters");
Logging.logger().log(java.util.logging.Level.SEVERE, message, e);
throw new IllegalArgumentException(message, e);
} catch (WWRuntimeException e) {
String message = Logging.getMessage("WMS.MissingCapabilityValues");
Logging.logger().log(java.util.logging.Level.SEVERE, message, e);
throw new IllegalArgumentException(message, e);
}
setFallbacks(params);
// Setup WMS URL builder.
params.setValue(AVKey.WMS_VERSION, caps.getVersion());
params.setValue(AVKey.TILE_URL_BUILDER, new URLBuilder(params));
// Setup default WMS tiled image layer behaviors.
params.setValue(AVKey.USE_TRANSPARENT_TEXTURES, true);
return params;
}
/**
* Parses basic elevation model parameters from a specified DOM document. This also parses
* LevelSet parameters by invoking {@link
* gov.nasa.worldwind.util.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:
*
* <table>
* <th><td>Key</td><td>Name</td><td>Type</td></th> <tr><td>{@link AVKey#SERVICE_NAME}</td><td>Service/@serviceName</td><td>String</td></tr>
* <tr><td>{@link AVKey#PIXEL_TYPE}</td><td>DataType</td><td>String</td></tr> <tr><td>{@link
* AVKey#BYTE_ORDER}</td><td>DataType/@byteOrder</td><td>String</td></tr> <tr><td>{@link
* AVKey#ELEVATION_EXTREMES_FILE}</td><td>ExtremeElevations/FileName</td><td>String</td></tr> <tr><td>{@link
* AVKey#ELEVATION_MAX}</td><td>ExtremeElevations/@max</td><td>Double</td></tr> <tr><td>{@link
* AVKey#ELEVATION_MIN}</td><td>ExtremeElevations/@min</td><td>Double</td></tr> </table>
*
* @param domElement the XML document root to parse for basic elevation model parameters.
* @param params the output key-value pairs which recieve the basic elevation model parameters. A
* null reference is permitted.
* @return a reference to params, or a new AVList if params is null.
* @throws IllegalArgumentException if the document is null.
*/
public static AVList getBasicElevationModelParams(Element domElement, AVList params) {
if (domElement == null) {
String message = Logging.getMessage("nullValue.DocumentIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (params == null) params = new AVListImpl();
XPath xpath = WWXML.makeXPath();
// LevelSet properties.
DataConfigurationUtils.getLevelSetParams(domElement, params);
// Service properties.
WWXML.checkAndSetStringParam(
domElement, params, AVKey.SERVICE_NAME, "Service/@serviceName", xpath);
WWXML.checkAndSetBooleanParam(
domElement,
params,
AVKey.RETRIEVE_PROPERTIES_FROM_SERVICE,
"RetrievePropertiesFromService",
xpath);
// Image format properties.
if (params.getValue(AVKey.PIXEL_TYPE) == null) {
String s = WWXML.getText(domElement, "DataType/@type", xpath);
if (s != null && s.length() > 0) {
s = WWXML.parseDataType(s);
if (s != null && s.length() > 0) params.setValue(AVKey.PIXEL_TYPE, s);
}
}
if (params.getValue(AVKey.BYTE_ORDER) == null) {
String s = WWXML.getText(domElement, "DataType/@byteOrder", xpath);
if (s != null && s.length() > 0) {
s = WWXML.parseByteOrder(s);
if (s != null && s.length() > 0) params.setValue(AVKey.BYTE_ORDER, s);
}
}
// Elevation data properties.
WWXML.checkAndSetStringParam(
domElement, params, AVKey.ELEVATION_EXTREMES_FILE, "ExtremeElevations/FileName", xpath);
WWXML.checkAndSetDoubleParam(
domElement, params, AVKey.ELEVATION_MAX, "ExtremeElevations/@max", xpath);
WWXML.checkAndSetDoubleParam(
domElement, params, AVKey.ELEVATION_MIN, "ExtremeElevations/@min", xpath);
return params;
}
public URLBuilder(AVList params) {
this.layerNames = params.getStringValue(AVKey.LAYER_NAMES);
this.styleNames = params.getStringValue(AVKey.STYLE_NAMES);
this.imageFormat = params.getStringValue(AVKey.IMAGE_FORMAT);
this.backgroundColor = params.getStringValue(AVKey.WMS_BACKGROUND_COLOR);
String version = params.getStringValue(AVKey.WMS_VERSION);
if (version == null || version.compareTo(MAX_VERSION) >= 0) {
this.wmsVersion = MAX_VERSION;
this.crs = "&crs=CRS:84";
} else {
this.wmsVersion = version;
this.crs = "&srs=EPSG:4326";
}
}
protected static void wmsRestoreStateToParams(
RestorableSupport rs, RestorableSupport.StateObject context, AVList params) {
// Invoke the BasicTiledImageLayer functionality.
restoreStateForParams(rs, context, params);
// Parse any legacy WMSTiledImageLayer state values.
legacyWmsRestoreStateToParams(rs, context, params);
String s = rs.getStateValueAsString(context, AVKey.IMAGE_FORMAT);
if (s != null) params.setValue(AVKey.IMAGE_FORMAT, s);
s = rs.getStateValueAsString(context, AVKey.TITLE);
if (s != null) params.setValue(AVKey.TITLE, s);
s = rs.getStateValueAsString(context, AVKey.DISPLAY_NAME);
if (s != null) params.setValue(AVKey.DISPLAY_NAME, s);
RestorableSupport.adjustTitleAndDisplayName(params);
s = rs.getStateValueAsString(context, AVKey.LAYER_NAMES);
if (s != null) params.setValue(AVKey.LAYER_NAMES, s);
s = rs.getStateValueAsString(context, AVKey.STYLE_NAMES);
if (s != null) params.setValue(AVKey.STYLE_NAMES, s);
s = rs.getStateValueAsString(context, "wms.Version");
if (s != null) params.setValue(AVKey.WMS_VERSION, s);
params.setValue(AVKey.TILE_URL_BUILDER, new URLBuilder(params));
}
protected static void legacyWmsRestoreStateToParams(
RestorableSupport rs, RestorableSupport.StateObject context, AVList params) {
// WMSTiledImageLayer has historically used a different format for storing LatLon and Sector
// properties
// in the restorable state XML documents. Although WMSTiledImageLayer no longer writes these
// properties,
// we must provide support for reading them here.
Double lat = rs.getStateValueAsDouble(context, AVKey.LEVEL_ZERO_TILE_DELTA + ".Latitude");
Double lon = rs.getStateValueAsDouble(context, AVKey.LEVEL_ZERO_TILE_DELTA + ".Longitude");
if (lat != null && lon != null)
params.setValue(AVKey.LEVEL_ZERO_TILE_DELTA, LatLon.fromDegrees(lat, lon));
Double minLat = rs.getStateValueAsDouble(context, AVKey.SECTOR + ".MinLatitude");
Double minLon = rs.getStateValueAsDouble(context, AVKey.SECTOR + ".MinLongitude");
Double maxLat = rs.getStateValueAsDouble(context, AVKey.SECTOR + ".MaxLatitude");
Double maxLon = rs.getStateValueAsDouble(context, AVKey.SECTOR + ".MaxLongitude");
if (minLat != null && minLon != null && maxLat != null && maxLon != null)
params.setValue(AVKey.SECTOR, Sector.fromDegrees(minLat, maxLat, minLon, maxLon));
}
protected static AVList wmsGetParamsFromDocument(Element domElement, AVList params) {
if (domElement == null) {
String message = Logging.getMessage("nullValue.DocumentIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (params == null) params = new AVListImpl();
LayerConfiguration.getWMSTiledImageLayerParams(domElement, params);
BasicTiledImageLayer.getParamsFromDocument(domElement, params);
params.setValue(AVKey.TILE_URL_BUILDER, new URLBuilder(params));
return params;
}
/**
* Appends basic elevation model parameters as elements to a specified context. If a parameter key
* exists, that parameter is appended to the context. This also writes LevelSet parameters by
* invoking {@link DataConfigurationUtils#createLevelSetElements(gov.nasa.worldwind.avlist.AVList,
* org.w3c.dom.Element)}. Supported key and element paths are:
*
* <table> <th><td>Key</td><td>Name</td><td>Type</td></th> <tr><td>{@link
* AVKey#SERVICE_NAME}</td><td>Service/@serviceName</td><td>String</td></tr> <tr><td>{@link
* AVKey#PIXEL_TYPE}</td><td>PixelType</td><td>String</td></tr> <tr><td>{@link AVKey#BYTE_ORDER}</td><td>ByteOrder</td><td>String</td></tr>
* <tr><td>{@link AVKey#ELEVATION_EXTREMES_FILE}</td><td>ExtremeElevations/FileName</td><td>String</td></tr>
* <tr><td>{@link AVKey#ELEVATION_MAX}</td><td>ExtremeElevations/@max</td><td>Double</td></tr> <tr><td>{@link
* AVKey#ELEVATION_MIN}</td><td>ExtremeElevations/@min</td><td>Double</td></tr> </table>
*
* @param params the key-value pairs which define the basic elevation model parameters.
* @param context the XML document root on which to append parameter elements.
* @return a reference to context.
* @throws IllegalArgumentException if either the parameters or the context are null.
*/
public static Element createBasicElevationModelElements(AVList params, Element context) {
if (params == null) {
String message = Logging.getMessage("nullValue.ParametersIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (context == null) {
String message = Logging.getMessage("nullValue.ContextIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
XPath xpath = WWXML.makeXPath();
// LevelSet properties.
DataConfigurationUtils.createLevelSetElements(params, context);
// Service properties.
// Try to get the SERVICE_NAME property, but default to "WWTileService".
String s = AVListImpl.getStringValue(params, AVKey.SERVICE_NAME, "WWTileService");
if (s != null && s.length() > 0) {
// The service element may already exist, in which case we want to append to it.
Element el = WWXML.getElement(context, "Service", xpath);
if (el == null) el = WWXML.appendElementPath(context, "Service");
el.setAttribute("serviceName", s);
}
WWXML.checkAndAppendBooleanElement(
params, AVKey.RETRIEVE_PROPERTIES_FROM_SERVICE, context, "RetrievePropertiesFromService");
// Image format properties.
if (params.getValue(AVKey.PIXEL_TYPE) != null || params.getValue(AVKey.BYTE_ORDER) != null) {
Element el = WWXML.getElement(context, "DataType", null);
if (el == null) el = WWXML.appendElementPath(context, "DataType");
s = params.getStringValue(AVKey.PIXEL_TYPE);
if (s != null && s.length() > 0) {
s = WWXML.dataTypeAsText(s);
if (s != null && s.length() > 0) el.setAttribute("type", s);
}
s = params.getStringValue(AVKey.BYTE_ORDER);
if (s != null && s.length() > 0) {
s = WWXML.byteOrderAsText(s);
if (s != null && s.length() > 0) el.setAttribute("byteOrder", s);
}
}
// Elevation data properties.
Element el = WWXML.appendElementPath(context, "ExtremeElevations");
WWXML.checkAndAppendTextElement(params, AVKey.ELEVATION_EXTREMES_FILE, el, "FileName");
Double d = AVListImpl.getDoubleValue(params, AVKey.ELEVATION_MAX);
if (d != null) el.setAttribute("max", Double.toString(d));
d = AVListImpl.getDoubleValue(params, AVKey.ELEVATION_MIN);
if (d != null) el.setAttribute("min", Double.toString(d));
return context;
}
/**
* Parses WMS elevation model parameters from a specified WMS {@link Capabilities} document. This
* also parses common WMS layer parameters by invoking {@link
* DataConfigurationUtils#getWMSLayerParams(gov.nasa.worldwind.wms.Capabilities, String[],
* gov.nasa.worldwind.avlist.AVList)}. This writes output as key-value pairs to params. Supported
* key and parameter names are:
*
* <table> <th><td>Key</td><td>Value</td><td>Type</td></th> <tr><td>{@link
* AVKey#ELEVATION_MAX}</td><td>WMS layer's maximum extreme elevation</td><td>Double</td></tr> <tr><td>{@link
* AVKey#ELEVATION_MIN}</td><td>WMS layer's minimum extreme elevation</td><td>Double</td></tr> <tr><td>{@link
* AVKey#PIXEL_TYPE}</td><td>Translate WMS layer's image format to a matching pixel type</td><td>String</td></tr>
* </table>
*
* @param caps the WMS Capabilities document to parse for WMS layer parameters.
* @param formatOrderPreference an ordered array of preferred image formats, or null to use the
* default format.
* @param params the output key-value pairs which recieve the WMS layer parameters.
* @return a reference to params.
* @throws IllegalArgumentException if either the document or params are null, or if params does
* not contain the required key-value pairs.
* @throws gov.nasa.worldwind.exception.WWRuntimeException if the Capabilities document does not
* contain any of the required information.
*/
public static AVList getWMSElevationModelParams(
Capabilities caps, String[] formatOrderPreference, AVList params) {
if (caps == null) {
String message = Logging.getMessage("nullValue.WMSCapabilities");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
if (params == null) {
String message = Logging.getMessage("nullValue.ElevationModelConfigParams");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
DataConfigurationUtils.getWMSLayerParams(caps, formatOrderPreference, params);
// Attempt to extract the WMS layer names from the specified parameters.
String layerNames = params.getStringValue(AVKey.LAYER_NAMES);
if (layerNames == null || layerNames.length() == 0) {
String message = Logging.getMessage("nullValue.WMSLayerNames");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
String[] names = layerNames.split(",");
if (names == null || names.length == 0) {
String message = Logging.getMessage("nullValue.WMSLayerNames");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
// Get the layer's extreme elevations.
Double[] extremes = caps.getLayerExtremeElevations(caps, names);
Double d = (Double) params.getValue(AVKey.ELEVATION_MIN);
if (d == null && extremes != null && extremes[0] != null)
params.setValue(AVKey.ELEVATION_MIN, extremes[0]);
d = (Double) params.getValue(AVKey.ELEVATION_MAX);
if (d == null && extremes != null && extremes[1] != null)
params.setValue(AVKey.ELEVATION_MAX, extremes[1]);
// Determine the internal pixel type from the image format.
if (params.getValue(AVKey.PIXEL_TYPE) == null) {
String imageFormat = params.getStringValue(AVKey.IMAGE_FORMAT);
if (imageFormat != null) {
if (imageFormat.equals("application/bil32"))
params.setValue(AVKey.PIXEL_TYPE, AVKey.FLOAT32);
else if (imageFormat.equals("application/bil16"))
params.setValue(AVKey.PIXEL_TYPE, AVKey.INT16);
else if (imageFormat.equals("application/bil"))
params.setValue(AVKey.PIXEL_TYPE, AVKey.INT16);
else if (imageFormat.equals("image/bil")) params.setValue(AVKey.PIXEL_TYPE, AVKey.INT16);
}
}
// Use the default pixel type.
if (params.getValue(AVKey.PIXEL_TYPE) == null) params.setValue(AVKey.PIXEL_TYPE, AVKey.INT16);
// Use the default byte order.
if (params.getValue(AVKey.BYTE_ORDER) == null)
params.setValue(AVKey.BYTE_ORDER, AVKey.LITTLE_ENDIAN);
return params;
}