/**
* Create a {@link TiledImageLayer} layer described by an XML layer description.
*
* @param domElement the XML element describing the layer to create. The element must inculde a
* service name identifying the type of service to use to retrieve layer data. Recognized
* service types are "Offline", "WWTileService" and "OGC:WMS".
* @param params any parameters to apply when creating the layer.
* @return a new layer
* @throws WWUnrecognizedException if the service type given in the describing element is
* unrecognized.
*/
protected Layer createTiledImageLayer(Element domElement, AVList params) {
Layer layer;
String serviceName = WWXML.getText(domElement, "Service/@serviceName");
if ("Offline".equals(serviceName)) {
layer = new BasicTiledImageLayer(domElement, params);
} else if ("WWTileService".equals(serviceName)) {
layer = new BasicTiledImageLayer(domElement, params);
} else if (OGCConstants.WMS_SERVICE_NAME.equals(serviceName)) {
layer = new WMSTiledImageLayer(domElement, params);
} else if (AVKey.SERVICE_NAME_LOCAL_RASTER_SERVER.equals(serviceName)) {
layer = new LocalRasterServerLayer(domElement, params);
} else {
String msg = Logging.getMessage("generic.UnrecognizedServiceName", serviceName);
throw new WWUnrecognizedException(msg);
}
//
// String name = layer.getStringValue(AVKey.DISPLAY_NAME);
// System.out.println(name);
String actuate = WWXML.getText(domElement, "@actuate");
layer.setEnabled(actuate != null && actuate.equals("onLoad"));
return layer;
}
/**
* 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;
}
/**
* Create a collection of layer lists and their included layers described by an array of XML
* layer-list description elements.
*
* <p>Any exceptions occurring during creation of the layer lists or their included layers are
* logged and not re-thrown. The layers associated with the exceptions are not included in the
* returned layer list.
*
* @param elements the XML elements describing the layer lists to create.
* @param params any parameters to apply when creating the included layers.
* @return an array containing the specified layer lists.
*/
protected LayerList[] createLayerLists(Element[] elements, AVList params) {
ArrayList<LayerList> layerLists = new ArrayList<LayerList>();
for (Element element : elements) {
try {
String href = WWXML.getText(element, "@href");
if (href != null && href.length() > 0) {
Object o = this.createFromConfigSource(href, params);
if (o == null) continue;
if (o instanceof Layer) {
LayerList ll = new LayerList();
ll.add((Layer) o);
o = ll;
}
if (o instanceof LayerList) {
LayerList list = (LayerList) o;
if (list != null && list.size() > 0) layerLists.add(list);
} else if (o instanceof LayerList[]) {
LayerList[] lists = (LayerList[]) o;
if (lists != null && lists.length > 0) layerLists.addAll(Arrays.asList(lists));
} else {
String msg =
Logging.getMessage("LayerFactory.UnexpectedTypeForLayer", o.getClass().getName());
Logging.logger().log(java.util.logging.Level.WARNING, msg);
}
continue;
}
String title = WWXML.getText(element, "@title");
Element[] children = WWXML.getElements(element, "./Layer", null);
if (children != null && children.length > 0) {
LayerList list = this.createLayerList(children, params);
if (list != null && list.size() > 0) {
layerLists.add(list);
if (title != null && title.length() > 0) list.setValue(AVKey.DISPLAY_NAME, title);
}
}
} catch (Exception e) {
Logging.logger().log(java.util.logging.Level.WARNING, e.getMessage(), e);
// keep going to create other layers
}
}
return layerLists.toArray(new LayerList[layerLists.size()]);
}
/**
* Create a layer described by an XML layer description.
*
* @param domElement the XML element describing the layer to create.
* @param params any parameters to apply when creating the layer.
* @return a new layer
* @throws WWUnrecognizedException if the layer type or service type given in the describing
* element is unrecognized.
* @see #createTiledImageLayer(org.w3c.dom.Element, gov.nasa.worldwind.avlist.AVList).
*/
protected Layer createFromLayerDocument(Element domElement, AVList params) {
String className = WWXML.getText(domElement, "@className");
if (className != null && className.length() > 0) {
Layer layer = (Layer) WorldWind.createComponent(className);
String actuate = WWXML.getText(domElement, "@actuate");
layer.setEnabled(WWUtil.isEmpty(actuate) || actuate.equals("onLoad"));
WWXML.invokePropertySetters(layer, domElement);
return layer;
}
AVList props = WWXML.copyProperties(domElement, null);
if (props != null) { // Copy params and add any properties for this layer to the copy
if (params != null) props.setValues(params);
params = props;
}
Layer layer;
String href = WWXML.getText(domElement, "@href");
if (href != null && href.length() > 0) {
Object o = this.createFromConfigSource(href, params);
if (o == null) return null;
if (!(o instanceof Layer)) {
String msg =
Logging.getMessage("LayerFactory.UnexpectedTypeForLayer", o.getClass().getName());
throw new WWRuntimeException(msg);
}
layer = (Layer) o;
} else {
String layerType = WWXML.getText(domElement, "@layerType");
if (layerType != null && layerType.equals("TiledImageLayer")) {
layer = this.createTiledImageLayer(domElement, params);
} else {
String msg = Logging.getMessage("generic.UnrecognizedLayerType", layerType);
throw new WWUnrecognizedException(msg);
}
}
if (layer != null) {
String actuate = WWXML.getText(domElement, "@actuate");
layer.setEnabled(actuate != null && actuate.equals("onLoad"));
WWXML.invokePropertySetters(layer, domElement);
}
return layer;
}
