shisplugin.java

openmap java写的开源数字地图程序. 用applet实现,可以像google map 那样放大缩小地图.

// **********************************************************************
// 
// <copyright>
// 
//  BBN Technologies
//  10 Moulton Street
//  Cambridge, MA 02138
//  [phone]
// 
//  Copyright (C) BBNT Solutions LLC. All rights reserved.
// 
// </copyright>
// **********************************************************************
// 
// $Source: /cvs/distapps/openmap/src/openmap/com/bbn/openmap/plugin/shis/SHISPlugIn.java,v $
// $RCSfile: SHISPlugIn.java,v $
// $Revision: 1.2.2.2 $
// $Date: 2005/08/09 21:18:02 $
// $Author: dietrick $
// 
// **********************************************************************

package com.bbn.openmap.plugin.shis;

import java.util.Properties;

import com.bbn.openmap.image.ImageServerConstants;
import com.bbn.openmap.plugin.*;
import com.bbn.openmap.proj.Projection;
import com.bbn.openmap.util.Debug;
import com.bbn.openmap.util.PropUtils;

/**
 * This class asks for an image from a SimpleHttpImageServer. It has
 * some properties that you can set in the openmap.properties file:
 * <P>
 * The query to the SimpleHttpImageServer looks like something you can
 * plug into your browser to test the server:
 * <P>
 * http://hostname:port/path?REQUEST=MAP&PROJTYPE=projection_type_value&SCALE=scale_value&LAT=center_latitude&LON=center_longitude&HEIGHT=map_pixel_height&WIDTH=map_pixel_width&FORMAT=image_format&TRANSPARENT=true|false&BGCOLOR=background_color
 * 
 * <P>
 * The projection information will be entered automatically by the
 * plugin based on the projection it receives from the MapBean. The
 * other parameters can be entered in the properties for the layer.
 * 
 * #For the plugin layer
 * pluginlayer.class=com.bbn.openmap.plugin.PlugInLayer
 * pluginlayer.prettyName=Whatever
 * pluginlayer.plugin=com.bbn.openmap.plugin.shis.SHISPlugIn
 * pluginlayer.plugin.host=hostname pluginlayer.plugin.port=port
 * number pluginlayer.plugin.path=query path (default is openmap)
 * pluginlayer.plugin.format=image format (JPEG, GIF from
 * WMTConstants.java) pluginlayer.plugin.transparent=true or false,
 * depends on imageformat pluginlayer.plugin.backgroundColor=RGB hex
 * string (RRGGBB)
 */
public class SHISPlugIn extends WebImagePlugIn implements ImageServerConstants {

    protected String queryHeader = null;
    protected String imageFormat = null;
    protected String backgroundColor = null;
    protected String transparent = null;
    protected String host = null;
    protected String port = null;
    protected String path = null;

    public final static String HostNameProperty = "host";
    public final static String PortNumberProperty = "port";
    public final static String PathProperty = "path";
    public final static String ImageFormatProperty = "format";
    public final static String BackgroundColorProperty = "backgroundColor";
    public final static String TransparentProperty = "transparent";

    public SHISPlugIn() {}

    /**
     * When a projection is received, translate it into a valid
     * request for a SimpleHttpImageServer, and then return the image
     * received back from it.
     * 
     * @param p projection of the screen, holding scale, center
     *        coords, height, width.
     * @return an OMGraphicList with an image received from a SHIS.
     */
    public String createQueryString(Projection p) {

        if (queryHeader == null) {
            return null;
        }

        StringBuffer buf = new StringBuffer(queryHeader);
        buf.append(REQUEST + "=" + MAP + "&");

        if (p != null) {
            buf.append(PROJTYPE + "=" + p.getName() + "&" + SCALE + "="
                    + p.getScale() + "&" + LAT + "="
                    + p.getCenter().getLatitude() + "&" + LON + "="
                    + p.getCenter().getLongitude() + "&" + HEIGHT + "="
                    + p.getHeight() + "&" + WIDTH + "=" + p.getWidth());
        } else {
            buf.append(PROJTYPE + "=name_undefined&" + SCALE
                    + "=scale_undefined&" + LAT + "=center_lat_undefined&"
                    + LON + "=center_lon_undefined&" + HEIGHT
                    + "=height_undefined&" + WIDTH + "=width_undefined");
        }

        if (imageFormat != null) {
            buf.append("&" + FORMAT + "=" + imageFormat);
        }

        if (transparent != null) {
            buf.append("&" + TRANSPARENT + "=true");
        }

        if (backgroundColor != null) {
            buf.append("&" + BGCOLOR + "=" + backgroundColor);
        }

        String layers = getLayerMarkers();
        if (layers != null) {
            buf.append("&" + layers);
        }

        return buf.toString();
    }

    public String getServerName() {
        return queryHeader;
    }

    public String getLayerMarkers() {
        // Not implemented - should be a list that can be set by the
        // user.
        return null;
    }

    /**
     * PropertyConsumer method.
     */
    public void setProperties(String prefix, Properties setList) {
        super.setProperties(prefix, setList);

        prefix = PropUtils.getScopedPropertyPrefix(prefix);

        host = setList.getProperty(prefix + HostNameProperty);
        port = setList.getProperty(prefix + PortNumberProperty);
        path = setList.getProperty(prefix + PathProperty);
        imageFormat = setList.getProperty(prefix + ImageFormatProperty);
        transparent = setList.getProperty(prefix + TransparentProperty);
        backgroundColor = setList.getProperty(prefix + BackgroundColorProperty);

        if (path == null) {
            path = com.bbn.openmap.Environment.OpenMapPrefix; // "openmap"
        }

        if (host == null || port == null) {
            Debug.error("SHISPlugIn needs a host name and port number for the image server.");
            queryHeader = null;
            return;
        }

        queryHeader = "http://" + (host == null ? "localhost" : host)
                + (port == null ? "" : (":" + port)) + "/" + path + "?";

        if (Debug.debugging("plugin")) {
            Debug.output("SHISPlugIn: set up with header \"" + queryHeader
                    + "\"");
        }
    }

    /**
     * PropertyConsumer method.
     */
    public Properties getProperties(Properties getList) {
        getList = super.getProperties(getList);

        String prefix = PropUtils.getScopedPropertyPrefix(this);
        getList.put(prefix + HostNameProperty, PropUtils.unnull(host));
        getList.put(prefix + PortNumberProperty, PropUtils.unnull(port));
        getList.put(prefix + PathProperty, PropUtils.unnull(path));
        getList.put(prefix + ImageFormatProperty, PropUtils.unnull(imageFormat));
        getList.put(prefix + TransparentProperty, PropUtils.unnull(transparent));
        getList.put(prefix + BackgroundColorProperty,
                PropUtils.unnull(backgroundColor));
        return getList;
    }

    /**
     * PropertyConsumer method.
     */
    public Properties getPropertyInfo(Properties list) {
        list = super.getPropertyInfo(list);

        list.put(initPropertiesProperty, HostNameProperty + " "
                + PortNumberProperty + " " + PathProperty + " "
                + ImageFormatProperty + " " + TransparentProperty + " "
                + BackgroundColorProperty);

        list.put(HostNameProperty, "This hostname of the server machine.");
        list.put(PortNumberProperty,
                "The port number the server is running on.");
        list.put(PathProperty, "The path to the server (openmap is default)");
        list.put(ImageFormatProperty, "Image format (JPEG|GIF|PPM|PNG)");
        list.put(TransparentProperty,
                "Whether background of image should be transparent.");
        list.put(TransparentProperty + ScopedEditorProperty,
                "com.bbn.openmap.util.propertyEditor.YesNoPropertyEditor");

        list.put(BackgroundColorProperty, "Background color for image.");
        list.put(BackgroundColorProperty + ScopedEditorProperty,
                "com.bbn.openmap.util.propertyEditor.ColorPropertyEditor");
        return list;
    }
}