com.esri.aims.mtier.model.wmsmap
Class WmsMap

java.lang.Object
  |
  +--com.esri.aims.mtier.model.wmsmap.WmsMap
All Implemented Interfaces:
Serializable

public class WmsMap
extends Object
implements Serializable

Connects to a OGC WMS service and represents the wmsmap to be displayed.

See Also:
Serialized Form

Field Summary
static long EAST
           
static long NORTH
           
static long NORTHEAST
           
static long NORTHWEST
           
static long SOUTH
           
static long SOUTHEAST
           
static long SOUTHWEST
           
static long WEST
           
 
Constructor Summary
WmsMap()
          Constructs an instance of a WmsMap object.
 
Method Summary
 void centerAt(double x, double y)
          Centers the map.
 void doPan(long direction, double step)
          Deprecated. As of ArcIMS 4.0.1, replaced by doPan(long,long)
 void doPan(long direction, long step)
          Pans the specified map service by recalculating the WMSMap objects envelope object.
 void doZoom(long scaleFactor)
          Zooms to a new location of the specific map service by recalculating the WMSMap objects extent.
 void doZoomToExtent(Envelope obj)
          Resets the Map objects extent by reassigning the extent to a new Envelope object.
 void doZoomToFullExtent()
          Zooms to the Map objects initial extent envelope.
 PointObject fromMapPoint(double x, double y)
          Converts from database coordinate to pixel coordinate values.
 Envelope getEnvelope()
          Returns the WMSMap object's associated Envelope object.
 String getException()
          Returns the associated exceptions.
 String getFormat()
          Returns the WMSMap output format value (Example: JPEG).
 long getHeight()
          Returns the WMSMap object's height value in pixels.
 WmsLayers getLayers()
          Returns the WMSMap object's associated Layers collection object.
 String getMapUrl()
          Returns the Map URL for the image.
 String getServiceName()
          Returns the WMSMap serviceName.
 String getSRS()
          Returns the WMSMap SRS.
 boolean getVersion()
          Returns the WMSMap version.
 long getWidth()
          Returns the WMSMap object's width value in pixels.
 boolean initMap(String url)
          Initializes the WmsMap object.
static void main(String[] args)
           
 void setDebug(boolean debug)
          Sets the debug property.
 void setEnvelope(Envelope obj)
          Sets the WMSMap Envelope object.
 void setFormat(Vector format)
          Sets the WMSMap object's output format value.
 void setHeight(long height)
          Sets the WMSMap object's height value in pixels.
 void setLayers(WmsLayers layers)
          Sets WMSMap object's layer.
 void setServiceName(String serviceName)
          Sets the WMSMap serviceName.
 void setSRS(String srs)
          Sets the WMSMap SRS.
 void setVersion(boolean version)
          Sets the WMSMap version.
 void setWidth(long width)
          Sets the WMSMap object's width value in pixels.
 PointObject toMapPoint(double x, double y)
          Converts from pixel coordinate values to database coordinate values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NORTH

public static final long NORTH
See Also:
Constant Field Values

NORTHEAST

public static final long NORTHEAST
See Also:
Constant Field Values

EAST

public static final long EAST
See Also:
Constant Field Values

SOUTHEAST

public static final long SOUTHEAST
See Also:
Constant Field Values

SOUTH

public static final long SOUTH
See Also:
Constant Field Values

SOUTHWEST

public static final long SOUTHWEST
See Also:
Constant Field Values

WEST

public static final long WEST
See Also:
Constant Field Values

NORTHWEST

public static final long NORTHWEST
See Also:
Constant Field Values
Constructor Detail

WmsMap

public WmsMap()
Constructs an instance of a WmsMap object.

Method Detail

initMap

public boolean initMap(String url)
Initializes the WmsMap object. This method calls the capabilities of the WMS server and parses the capabilities.


setWidth

public void setWidth(long width)
Sets the WMSMap object's width value in pixels.

Parameters:
width - the width value.
See Also:
getWidth()

setHeight

public void setHeight(long height)
Sets the WMSMap object's height value in pixels.

Parameters:
height - the height value.
See Also:
getHeight()

getWidth

public long getWidth()
Returns the WMSMap object's width value in pixels.

Returns:
long
See Also:
setWidth(long)

getHeight

public long getHeight()
Returns the WMSMap object's height value in pixels.

Returns:
long
See Also:
setHeight(long)

setLayers

public void setLayers(WmsLayers layers)
Sets WMSMap object's layer.

Parameters:
layers - the WmsLayers value.
See Also:
#getLayer

getLayers

public WmsLayers getLayers()
Returns the WMSMap object's associated Layers collection object.

Returns:
Layers

setFormat

public void setFormat(Vector format)
Sets the WMSMap object's output format value.

Parameters:
format - the format value.
See Also:
getFormat()

getFormat

public String getFormat()
Returns the WMSMap output format value (Example: JPEG).

Returns:
String
See Also:
setFormat(java.util.Vector)

centerAt

public void centerAt(double x,
                     double y)
Centers the map.

Parameters:
x -
y -

toMapPoint

public PointObject toMapPoint(double x,
                              double y)
Converts from pixel coordinate values to database coordinate values.

Parameters:
x - the x coordinate.
y - the y coordinate.
See Also:
#getToMapPointX, #getToMapPointY, fromMapPoint(double, double)

fromMapPoint

public PointObject fromMapPoint(double x,
                                double y)
Converts from database coordinate to pixel coordinate values.

Parameters:
x - the x coordinate value.
y - the y coordinate value.

doZoom

public void doZoom(long scaleFactor)
Zooms to a new location of the specific map service by recalculating the WMSMap objects extent.

Parameters:
scaleFactor - the scale factor value.
See Also:
doPan(long, double), centerAt(double, double)

doPan

public void doPan(long direction,
                  double step)
Deprecated. As of ArcIMS 4.0.1, replaced by doPan(long,long)

Pans the specified map service by recalculating the WMSMap objects envelope object.

Parameters:
direction - the directional constant value.
step - the amount of directional shift.
See Also:
doZoom(long), centerAt(double, double)

doPan

public void doPan(long direction,
                  long step)
Pans the specified map service by recalculating the WMSMap objects envelope object.

Parameters:
direction - the directional constant value.
step - the amount of directional shift.
See Also:
doZoom(long), centerAt(double, double)

doZoomToExtent

public void doZoomToExtent(Envelope obj)
Resets the Map objects extent by reassigning the extent to a new Envelope object.


doZoomToFullExtent

public void doZoomToFullExtent()
Zooms to the Map objects initial extent envelope.

See Also:
doPan(long, double), doZoom(long), centerAt(double, double)

setEnvelope

public void setEnvelope(Envelope obj)
Sets the WMSMap Envelope object.


getEnvelope

public Envelope getEnvelope()
Returns the WMSMap object's associated Envelope object.

Returns:
Envelope

setServiceName

public void setServiceName(String serviceName)
Sets the WMSMap serviceName.

Parameters:
serviceName -

getServiceName

public String getServiceName()
Returns the WMSMap serviceName.


setSRS

public void setSRS(String srs)
Sets the WMSMap SRS.

Parameters:
srs -

getSRS

public String getSRS()
Returns the WMSMap SRS.


setVersion

public void setVersion(boolean version)
Sets the WMSMap version.


getVersion

public boolean getVersion()
Returns the WMSMap version.


getMapUrl

public String getMapUrl()
Returns the Map URL for the image.

Returns:
url string

setDebug

public void setDebug(boolean debug)
Sets the debug property. When set, this property logs errors and exceptions to the Web server's log file.

Parameters:
debug - true or false

getException

public String getException()
Returns the associated exceptions.


main

public static void main(String[] args)