gov.nasa.worldwind.layers.LocalRasterServerLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of worldwind-pcm Show documentation
worldwind-pcm
The newest version!
/*
 * Copyright (C) 2012 United States Government as represented by the Administrator of the
 * National Aeronautics and Space Administration.
 * All Rights Reserved.
 */

package gov.nasa.worldwind.layers;

import gov.nasa.worldwind.avlist.*;
import gov.nasa.worldwind.data.*;
import gov.nasa.worldwind.retrieve.*;
import gov.nasa.worldwind.util.*;
import org.w3c.dom.*;

import java.io.File;
import java.net.URL;

/**
 * Implements a tiled image layer for a local dataset accessed via a local raster server.
 *
 * @author tag
 * @version $Id: LocalRasterServerLayer.java 1171 2013-02-11 21:45:02Z dcollins $
 */
public class LocalRasterServerLayer extends BasicTiledImageLayer
{
    /**
     * Constructs a layer from a list of parameters describing the layer.
     * 
     * Parameter values for DATASET_NAME and DATA_CACHE_NAME are required.
     * 

     * TODO: Enumerate the other required and optional parameters.
     *
     * @param params the parameters describing the dataset.
     *
     * @throws IllegalArgumentException if the parameter list is null.
     * @throws IllegalStateException    if the required parameters are missing from the parameter list.
     */
    public LocalRasterServerLayer(AVList params)
    {
        super(params);

        this.createRasterServer(params);
    }

    /**
     * Constructs a layer from an XML document description.
     * 

     * Either the specified XML document or parameter list must contain values for DATASET_NAME and DATA_CACHE_NAME.
     * 

     * TODO: Enumerate the other required and optional parameters.
     *
     * @param dom    the XML document describing the dataset.
     * @param params a list of parameters that each override a parameter of the same name in the XML document, or that
     *               augment the definition there.
     *
     * @throws IllegalArgumentException if the XML document reference is null.
     * @throws IllegalStateException    if the required parameters are missing from the XML document or the parameter
     *                                  list.
     */
    public LocalRasterServerLayer(Document dom, AVList params)
    {
        super(dom, params);

        this.createRasterServer(params != null ? params : (AVList) this.getValue(AVKey.CONSTRUCTION_PARAMETERS));
    }

    /**
     * Constructs a layer from an XML document {@link Element}.
     * 

     * Either the specified XML element or parameter list must contain values for DATASET_NAME and DATA_CACHE_NAME.
     * 
     * TODO: Enumerate the other required and optional parameters.
     *
     * @param domElement the XML document describing the dataset.
     * @param params     a list of parameters that each override a parameter of the same name in the XML document, or
     *                   that augment the definition there.
     *
     * @throws IllegalArgumentException if the XML document reference is null.
     * @throws IllegalStateException    if the required parameters are missing from the XML element or the parameter
     *                                  list.
     */
    public LocalRasterServerLayer(Element domElement, AVList params)
    {
        super(domElement, params);

        this.createRasterServer(params != null ? params : (AVList) this.getValue(AVKey.CONSTRUCTION_PARAMETERS));
    }

    /**
     * Constructs a layer from restorable state obtained by a call to {@link #getRestorableState()} on another instance
     * of this class.
     *
     * @param restorableStateInXml a string containing the restorable state.
     *
     * @throws IllegalArgumentException if the restorable state is null or cannot be interpreted.
     * @throws IllegalStateException    if the restorable state does not contain values for DATASET_NAME and
     *                                  DATA_CACHE_NAME.
     */
    public LocalRasterServerLayer(String restorableStateInXml)
    {
        super(restorableStateInXml);

        this.createRasterServer((AVList) this.getValue(AVKey.CONSTRUCTION_PARAMETERS));
    }

    protected void createRasterServer(AVList params)
    {
        if (params == null)
        {
            String reason = Logging.getMessage("nullValue.ParamsIsNull");
            String msg = Logging.getMessage("generic.CannotCreateRasterServer", reason);
            Logging.logger().severe(msg);
            throw new IllegalStateException(msg);
        }

        if (this.getDataFileStore() == null)
        {
            String reason = Logging.getMessage("nullValue.FileStoreIsNull");
            String msg = Logging.getMessage("generic.CannotCreateRasterServer", reason);
            Logging.logger().severe(msg);
            throw new IllegalStateException(msg);
        }

        String datasetName = params.getStringValue(AVKey.DATASET_NAME);
        if (WWUtil.isEmpty(datasetName))
        {
            String reason = Logging.getMessage("generic.MissingRequiredParameter", AVKey.DATASET_NAME);
            String msg = Logging.getMessage("generic.CannotCreateRasterServer", reason);
            Logging.logger().severe(msg);
            throw new IllegalStateException(msg);
        }

        String dataCacheName = params.getStringValue(AVKey.DATA_CACHE_NAME);
        if (WWUtil.isEmpty(dataCacheName))
        {
            String reason = Logging.getMessage("generic.MissingRequiredParameter", AVKey.DATA_CACHE_NAME);
            String msg = Logging.getMessage("generic.CannotCreateRasterServer", reason);
            Logging.logger().severe(msg);
            throw new IllegalStateException(msg);
        }

        String rasterServerConfigFilename = dataCacheName + File.separator + datasetName + ".RasterServer.xml";

        final URL rasterServerFileURL = this.getDataFileStore().findFile(rasterServerConfigFilename, false);
        if (WWUtil.isEmpty(rasterServerFileURL))
        {
            String reason = Logging.getMessage("Configuration.ConfigNotFound", rasterServerConfigFilename);
            String msg = Logging.getMessage("generic.CannotCreateRasterServer", reason);
            Logging.logger().severe(msg);
            throw new IllegalStateException(msg);
        }

        final AVList rasterServerParams = params.copy();

        rasterServerParams.setValue(AVKey.FILE_STORE, this.getDataFileStore());

        RetrieverFactory retrieverFactory = new RetrieverFactory()
        {
            final protected RasterServer rasterServer = new BasicRasterServer(rasterServerFileURL, rasterServerParams);

            public Retriever createRetriever(AVList tileParams, RetrievalPostProcessor postProcessor)
            {
                LocalRasterServerRetriever retriever =
                    new LocalRasterServerRetriever(tileParams, this.rasterServer, postProcessor);

                // copy only values that do not exist in destination AVList
                // from rasterServerParams (source) to retriever (destination)

                String[] keysToCopy = new String[] {
                    AVKey.DATASET_NAME, AVKey.DISPLAY_NAME, AVKey.FILE_STORE, AVKey.IMAGE_FORMAT, AVKey.FORMAT_SUFFIX};

                WWUtil.copyValues(rasterServerParams, retriever, keysToCopy, false);

                return retriever;
            }
        };

        params.setValue(AVKey.RETRIEVER_FACTORY_LOCAL, retrieverFactory);
        this.setValue(AVKey.RETRIEVER_FACTORY_LOCAL, retrieverFactory);
    }
}