WMS (Groovy Documentation)

geoscript.layer.WMS

class WMS
extends java.lang.Object

The Web Map Server (WMS) module is a connection to a remote WMS server.

 def wms = new WMS("http://localhost:8080/geoserver/ows?service=wms&version=1.1.1&request=GetCapabilities")

You can use it to get information on the WMS Server just as name, version, formats, layers:

 println "Name: ${wms.name}"
 println "Version: ${wms.version}"
 println "Formats: ${wms.getMapFormats.join(',')}"
 wms.layers.each{layer -> println "${layer.name}" }

Or you can use it to render images or extract Rasters:

 def image = wms.getImage("world:borders")
 ImageIO.write(image,"png",new File("world.png"))
 def raster = wms.getRaster(["world:cities","world:borders"])
 ImageIO.write(raster.image,"png",new File("raster_world_cities.png"))

Authors:: Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`protected static class`	`WMS.Layer`	A WMS.Layer

Properties Summary

Properties
Type	Name and description
`WebMapServer`	`wms` The GeoTools WebMapServer

Constructor Summary

Constructors
Constructor and description
`WMS(Map options, java.lang.String url)` Create a new WMS object with a get capabilities URL
`WMS(Map options, java.net.URL url)` Create a new WMS object with a get capabilities URL

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getAbstract()` Get the abstract (WMT_MS_Capabilities/Service/Abstract)
	`java.util.List`	`getGetMapFormats()` Get the GetMap formats
	`java.awt.image.BufferedImage`	`getImage(Map options, java.lang.Object layers)` Get a Image from the WMS server.
	`java.util.List`	`getKeywords()` Get a List of keywords
	`Layer`	`getLayer(java.lang.String name)` Get a WMS.Layer by name
	`java.util.List`	`getLayers()` Get a List of WMS.Layers
	`java.awt.image.BufferedImage`	`getLegend(Map options, java.lang.Object layer)` Get a legend from a WMS service.
	`java.lang.String`	`getName()` Get the name (WMT_MS_Capabilities/Service/Name)
	`java.net.URL`	`getOnlineResource()` Get the online resource URL
	`Raster`	`getRaster(Map options, java.lang.Object layers)` Get a Raster from the WMS server
	`java.lang.String`	`getTitle()` Get the title (WMT_MS_Capabilities/Service/Title)
	`java.lang.String`	`getUpdateSequence()` Get the update sequence
	`java.lang.String`	`getVersion()` Get the version
	`java.lang.String`	`toString()` The String representation @return

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - WebMapServer wms
    
    The GeoTools WebMapServer
- Constructor Detail
  - WMS(Map options, java.lang.String url)
    
    Create a new WMS object with a get capabilities URL
    Parameters:
    options - Optional named parameters:
    
    user = The user name for password protected urls
    
    password = The password for password protected urls
    url - The get capabilities URL
  - WMS(Map options, java.net.URL url)
    
    Create a new WMS object with a get capabilities URL
    Parameters:
    options - Optional named parameters:
    
    user = The user name for password protected urls
    
    password = The password for password protected urls
    url - The get capabilities URL
- Method Detail
  - java.lang.String getAbstract()
    
    Get the abstract (WMT_MS_Capabilities/Service/Abstract)
    Returns:
    The abstract
  - java.util.List getGetMapFormats()
    
    Get the GetMap formats
    Returns:
    The GetMap formats
  - java.awt.image.BufferedImage getImage(Map options, java.lang.Object layers)
    
    Get a Image from the WMS server.
    Parameters:
    options - Named parameter options may include:
    
    width: The width of the image (defaults to 512)
    
    height: The height of the image (defaults to 512)
    
    format: The image format (defaults to image/png)
    
    srs: The srs or projection id (defaults to EPSG:4326)
    
    transparent: Whether the image should be transparent or not (defaults to true)
    
    bounds: The Bounds of the image (defaults to the extent of all Layers)
    
    debug: Show the WMS request url
    layers - The Layers to include on the image. Layers can be a single WMS.Layer, layer name, or map with name and style keys or it can be a List of the previously mentioned values.
    Returns:
    A BufferedImage
  - java.util.List getKeywords()
    
    Get a List of keywords
    Returns:
    A List of keywords
  - Layer getLayer(java.lang.String name)
    
    Get a WMS.Layer by name
    Parameters:
    The - name
    Returns:
    A WMS.Layer or null
  - java.util.List getLayers()
    
    Get a List of WMS.Layers
    Returns:
    A List of WMS.Layers
  - java.awt.image.BufferedImage getLegend(Map options, java.lang.Object layer)
    
    Get a legend from a WMS service.
    Parameters:
    options - Named parameter options
    
    width: The width to the image (defaults to 32)
    
    height: The height to the image (defaults to 32)
    
    format: The image format (defaults to image/png)
    
    exceptions: The exceptions WMS GET_LEGEND request value
    
    featureType: The featureType WMS GET_LEGEND request value
    
    rule: The rule WMS GET_LEGEND request value
    
    scale: The scale WMS GET_LEGEND request value
    
    sld: The sld WMS GET_LEGEND request value
    
    sldBody: The sldBody WMS GET_LEGEND request value
    
    style: The style WMS GET_LEGEND request value
    
    debug: Show the WMS request url
    Returns:
    A BufferedImage
  - java.lang.String getName()
    
    Get the name (WMT_MS_Capabilities/Service/Name)
    Returns:
    The name
  - java.net.URL getOnlineResource()
    
    Get the online resource URL
    Returns:
    The online resource URL
  - Raster getRaster(Map options, java.lang.Object layers)
    
    Get a Raster from the WMS server
    Parameters:
    options - Named parameter options may include:
    
    width: The width of the image (defaults to 512)
    
    height: The height of the image (defaults to 512)
    
    format: The image format (defaults to image/png)
    
    srs: The srs or projection id (defaults to EPSG:4326)
    
    transparent: Whether the image should be transparent or not (defaults to true)
    
    bounds: The Bounds of the image (defaults to the extent of all Layers)
    layers - The Layers to include on the image. Layers can be a single WMS.Layer, layer name, or map with name and style keys or it can be a List of the previously mentioned values.
    Returns:
    A Raster
  - java.lang.String getTitle()
    
    Get the title (WMT_MS_Capabilities/Service/Title)
    Returns:
    The title
  - java.lang.String getUpdateSequence()
    
    Get the update sequence
    Returns:
    The update sequence
  - java.lang.String getVersion()
    
    Get the version
    Returns:
    The version
  - java.lang.String toString()
    
    The String representation @return

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class WMS

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

WebMapServer wms

Constructor Detail

WMS(Map options, java.lang.String url)

WMS(Map options, java.net.URL url)

Method Detail

java.lang.String getAbstract()

java.util.List getGetMapFormats()

java.awt.image.BufferedImage getImage(Map options, java.lang.Object layers)

java.util.List getKeywords()

Layer getLayer(java.lang.String name)

java.util.List getLayers()

java.awt.image.BufferedImage getLegend(Map options, java.lang.Object layer)

java.lang.String getName()

java.net.URL getOnlineResource()

Raster getRaster(Map options, java.lang.Object layers)

java.lang.String getTitle()

java.lang.String getUpdateSequence()

java.lang.String getVersion()

java.lang.String toString()