com.lamatek.tags.google
Class GoogleMapWMSTag

java.lang.Object
  TagSupport
      com.lamatek.tags.google.GoogleMapWMSTag

public class GoogleMapWMSTag
extends TagSupport

GoogleMapWMSTag Represents a <googlemaps:wms> tag. Developers should not extend this class or override it's methods.

Version:

0.92

Author:

Tom Cole

Constructor Summary

GoogleMapWMSTag()

Method Summary

int	doStartTag() Overrides doStartTag() from TagSupport.
java.lang.String	getCopyright() Returns the copyright string that is displayed anytime this WMS mashup is presented on the map.
java.lang.String	getFormat() Returns the desired image file format to retrieve from this WMS server.
java.lang.String	getId() Returns the unique id for this WMS layer.
java.lang.String	getLayers() Returns the desired WMS layers to include in this map layer.
java.lang.String	getName() Returns the descriptive name for this layer.
java.lang.String	getPathToScript() Returns the path (either relative or absolute) to the wms1.js or wms2.js script required.
java.lang.String	getSrs() Returns the WMS SRS set for this layer.
java.lang.String	getUrl() Returns the base URL to the WMS map server used to supply the tiles.
java.lang.String	getVersion() Returns the desired version.
boolean	isShowOnStartup() Denotes whether or not this map type should be initially selected on startup.
boolean	isShowOverlay() Denotes whether or not this map should show the hybrid overlay.
void	setCopyright(java.lang.String copyright) Sets the copyright string that is displayed anytime this WMS mashup is presented on the map.
void	setFormat(java.lang.String format) Sets the desired image type for images retrieved from this server.
void	setId(java.lang.String id) Sets the unique id for this layer.
void	setLayers(java.lang.String layers) Sets the comma separated list of layers to include in this map.
void	setName(java.lang.String name) Sets the descriptive name for this layer.
void	setPathToScript(java.lang.String pathToScript) Sets the path (either relative or absolute) to the wms1.js or wms2.js script required.
void	setShowOnStartup(boolean showOnStartup) Sets whether or not this map type should be initially selected on startup.
void	setShowOverlay(boolean showOverlay) Sets whether or not this map should also include the Google Map Hybrid overlay.
void	setSrs(java.lang.String srs) Sets the WMS SRS for this map.
void	setUrl(java.lang.String url) Sets the base URL to the WMS server.
void	setVersion(java.lang.String version) Sets the desired version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GoogleMapWMSTag

public GoogleMapWMSTag()

Method Detail

doStartTag

public int doStartTag()

Overrides doStartTag() from TagSupport. Developers should not override this method.

getFormat

public java.lang.String getFormat()

Returns the desired image file format to retrieve from this WMS server.

Returns:

The content-type for the desired image format.

setFormat

public void setFormat(java.lang.String format)

Sets the desired image type for images retrieved from this server. This value must be a valid content-type.

Parameters:

format - The desired content-type for images retrieved from this server.

getId

public java.lang.String getId()

Returns the unique id for this WMS layer.

Returns:

A unique id for this layer.

setId

public void setId(java.lang.String id)

Sets the unique id for this layer. Must be unique per map.

Parameters:

id - A unique id for this layer.

getLayers

public java.lang.String getLayers()

Returns the desired WMS layers to include in this map layer. These must be valid layer names for the server referenced by the url. The layer names must be comma separated (without spaces).

Returns:

A comma separated list of layer names.

setLayers

public void setLayers(java.lang.String layers)

Sets the comma separated list of layers to include in this map.

Parameters:

layers - A comma separated list of vlaid layer names.

getName

public java.lang.String getName()

Returns the descriptive name for this layer.

Returns:

A short name for this layer.

setName

public void setName(java.lang.String name)

Sets the descriptive name for this layer. This value is used as the button label for this map type.

isShowOnStartup

public boolean isShowOnStartup()

Denotes whether or not this map type should be initially selected on startup.

Returns:

True if this maptype is to be initially selected. False if not.

setShowOnStartup

public void setShowOnStartup(boolean showOnStartup)

Sets whether or not this map type should be initially selected on startup.

Parameters:

showOnStartup - True or false.

getSrs

public java.lang.String getSrs()

Returns the WMS SRS set for this layer.

Returns:

The desired srs.

setSrs

public void setSrs(java.lang.String srs)

Sets the WMS SRS for this map.

Parameters:

srs - The desired SRS.

getUrl

public java.lang.String getUrl()

Returns the base URL to the WMS map server used to supply the tiles. This url will include an ending ?.

Returns:

A valid url to a WMS map server.

setUrl

public void setUrl(java.lang.String url)

Sets the base URL to the WMS server.

Parameters:

url - A valid url to a WMS map server.

getVersion

public java.lang.String getVersion()

Returns the desired version. Default is 1.1.1

Returns:

A valid WMS version number.

setVersion

public void setVersion(java.lang.String version)

Sets the desired version. Default is 1.1.1.

Parameters:

A - valid WMS version number.

getPathToScript

public java.lang.String getPathToScript()

Returns the path (either relative or absolute) to the wms1.js or wms2.js script required.

Returns:

A relative or absolute path.

setPathToScript

public void setPathToScript(java.lang.String pathToScript)

Sets the path (either relative or absolute) to the wms1.js or wms2.js script required.

Parameters:

pathToScript - A valid relative or absolute path.

isShowOverlay

public boolean isShowOverlay()

Denotes whether or not this map should show the hybrid overlay.

Returns:

True or false.

setShowOverlay

public void setShowOverlay(boolean showOverlay)

Sets whether or not this map should also include the Google Map Hybrid overlay. This feature is not available in version 2 maps.

Parameters:

showOverlay - True to display the Hybrid Overlay, false if not.

getCopyright

public java.lang.String getCopyright()

Returns the copyright string that is displayed anytime this WMS mashup is presented on the map.

Returns:

Copyright string

setCopyright

public void setCopyright(java.lang.String copyright)

Sets the copyright string that is displayed anytime this WMS mashup is presented on the map.

Parameters:

copyright - A copyright string