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()

Method Summary

void	centerAt(double x, double y) Centers the map.
void	doPan(long direction, double step) Deprecated. As of ArcIMS 4.0.1 Java Connector, 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.
Vector	getFormat() Gets the WMSMap object's output format value.
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.
String	getVersion() Returns the WMSMap version.
long	getWidth() Returns the WMSMap object's width value in pixels.
boolean	initMap(String url) Initializes the WmsMap object.
void	setBackgroundcolor(String color) Deprecated. As of ArcIMS 9.3 Java Connector, replaced by setBackgroundColor(java.lang.String).
void	setBackgroundColor(String color) Sets the WMSMap objects background color value 0xffffff format.
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	setTransparent(boolean transparent) Sets the WMSMap objects transparency.
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()

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, a sample url is http://localhost/wmsconnector/com.esri.wms.Esrimap?version=1.1.1&ServiceName=SantaClara&.

setWidth

public void setWidth(long width)

Sets the WMSMap object's width value in pixels.

Parameters:

width - the width value.

See Also:

getWidth()

getWidth

public long getWidth()

Returns the WMSMap object's width value in pixels.

Returns:

long

See Also:

setWidth(long)

setHeight

public void setHeight(long height)

Sets the WMSMap object's height value in pixels.

Parameters:

height - the height value.

See Also:

getHeight()

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:

getLayers()

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 Vector getFormat()

Gets the WMSMap object's output format value.

See Also:

setFormat(java.util.Vector)

setBackgroundcolor

public void setBackgroundcolor(String color)

Deprecated. As of ArcIMS 9.3 Java Connector, replaced by setBackgroundColor(java.lang.String).

Sets the WMSMap objects background color value 0xffffff format.

Parameters:

color - String value in 0xffffff

See Also:

getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(String color)

Sets the WMSMap objects background color value 0xffffff format.

Parameters:

color - String value in 0xffffff

setTransparent

public void setTransparent(boolean transparent)

Sets the WMSMap objects transparency.

Parameters:

transparent - transparent value

setEnvelope

public void setEnvelope(Envelope obj)

Sets the WMSMap Envelope object.

Parameters:

obj - the new Envelope object.

getEnvelope

public Envelope getEnvelope()

Returns the WMSMap object's associated Envelope object.

Returns:

Envelope

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

getServiceName

public String getServiceName()

Returns the WMSMap serviceName.

Returns:

the service name

getVersion

public String getVersion()

Returns the WMSMap version.

getSRS

public String getSRS()

Returns the WMSMap SRS.

Returns:

the SRS value

getException

public String getException()

Returns the associated exceptions.

Returns:

the exception string

getMapUrl

public String getMapUrl()

Returns the Map URL for the image.

Returns:

url string

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:

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.

See Also:

toMapPoint(double, double)

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 Java Connector, 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.

Parameters:

obj - the new extent.

doZoomToFullExtent

public void doZoomToFullExtent()

Zooms to the Map objects initial extent envelope.

See Also:

doPan(long, double), doZoom(long), centerAt(double, double)