/**
* Returns true if a specified DOM document should be accepted as an ElevationModel configuration
* document, and false otherwise.
*
* @param domElement the DOM document in question.
* @return true if the document is an ElevationModel configuration document; false otherwise.
* @throws IllegalArgumentException if document is null.
*/
public static boolean isElevationModelDocument(Element domElement) {
if (domElement == null) {
String message = Logging.getMessage("nullValue.DocumentIsNull");
Logging.logger().severe(message);
throw new IllegalArgumentException(message);
}
XPath xpath = WWXML.makeXPath();
Element[] elements = WWXML.getElements(domElement, "//ElevationModel", xpath);
return elements != null && elements.length > 0;
}
/**
* 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;
}
protected static AVList getParamsFromDocument(Element domElement, AVList params) {
if (params == null) {
params = new AVListImpl();
}
XPath xpath = WWXML.makeXPath();
// Common layer properties.
AbstractLayer.getLayerConfigParams(domElement, params);
WWXML.checkAndSetStringParam(domElement, params, AVKey.URL, "URL", xpath);
WWXML.checkAndSetIntegerParam(domElement, params, AVKey.WIDTH, "Size/@width", xpath);
WWXML.checkAndSetIntegerParam(domElement, params, AVKey.HEIGHT, "Size/@height", xpath);
WWXML.checkAndSetDoubleParam(domElement, params, AVKeyMore.SCALE, "Scale", xpath);
WWXML.checkAndSetSectorParam(domElement, params, AVKey.SECTOR, "Sector", xpath);
WWXML.checkAndSetBooleanParam(domElement, params, AVKeyMore.WRAP, "Wrap", xpath);
return params;
}
/**
* Parses elevation model parameters from a specified DOM document. 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
* gov.nasa.worldwind.avlist.AVKey#DISPLAY_NAME}</td><td>DisplayName</td><td>String</td></tr> <tr><td>{@link
* gov.nasa.worldwind.avlist.AVKey#NETWORK_RETRIEVAL_ENABLED}</td><td>NetworkRetrievalEnabled</td><td>Boolean</td></tr>
* <tr><td>{@link gov.nasa.worldwind.avlist.AVKey#MISSING_DATA_SIGNAL}</td><td>MissingData/@signal</td><td>Double</td></tr>
* <tr><td>{@link gov.nasa.worldwind.avlist.AVKey#MISSING_DATA_REPLACEMENT}</td><td>MissingData/@replacement</td><td>Double</td></tr>
* <tr><td>{@link gov.nasa.worldwind.avlist.AVKey#DETAIL_HINT}</td><td>DataDetailHint</td><td>Double</td></tr>
* </table>
*
* @param domElement the XML document root to parse for elevaiton model parameters.
* @param params the output key-value pairs which recieve the 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 getElevationModelParams(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();
WWXML.checkAndSetStringParam(domElement, params, AVKey.DISPLAY_NAME, "DisplayName", xpath);
WWXML.checkAndSetBooleanParam(
domElement, params, AVKey.NETWORK_RETRIEVAL_ENABLED, "NetworkRetrievalEnabled", xpath);
WWXML.checkAndSetDoubleParam(
domElement, params, AVKey.MISSING_DATA_SIGNAL, "MissingData/@signal", xpath);
WWXML.checkAndSetDoubleParam(
domElement, params, AVKey.MISSING_DATA_REPLACEMENT, "MissingData/@replacement", xpath);
WWXML.checkAndSetDoubleParam(domElement, params, AVKey.DETAIL_HINT, "DataDetailHint", xpath);
return params;
}
@Override
protected AnimatableBase createAnimatableFromXml(
String name,
Animation animation,
boolean enabled,
Element element,
AnimationFileVersion version,
AVList context) {
AnimationIOConstants constants = version.getConstants();
XPath xpath = WWXML.makeXPath();
DepthOfFieldAnimatableEffect effect = new DepthOfFieldAnimatableEffect(name, animation);
context.setValue(constants.getCurrentEffectKey(), effect);
effect.focusParameter =
new DepthOfFieldFocusParameter()
.fromXml(
WWXML.getElement(element, constants.getDepthOfFieldFocusElementName(), xpath),
version,
context);
effect.nearParameter =
new DepthOfFieldNearParameter()
.fromXml(
WWXML.getElement(element, constants.getDepthOfFieldNearElementName(), xpath),
version,
context);
effect.farParameter =
new DepthOfFieldFarParameter()
.fromXml(
WWXML.getElement(element, constants.getDepthOfFieldFarElementName(), xpath),
version,
context);
effect.initializeParameters();
return effect;
}
/**
* 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;
}