org.geotools.data.wms
Class Specification

java.lang.Object
  org.geotools.data.wms.Specification

Direct Known Subclasses:

WMS1_0_0

public abstract class Specification

extends java.lang.Object

Provides support for the Web Map Server Specificaitons.

This class operates as a Factory creating the following related objects.

• AbstractGetCapabilitiesRequest
• GetMapRequest
• GetFeatureInfoRequest

The idea is that this class operates a Toolkit for all things assocated with a Web Map Server Specification. The various objects produced by this toolkit are used as strategy objects for the top level WebMapServer object:

• WebMapServer - uses a AbstractGetCapabilitiesRequest during version negotiation.

Both name and version information that may be checked against a GetCapabilities document during version negotiation.

Q: Why are these not static?
A: Because we want to place new specifications into a data structure for WebMapServer to search through dynamically

Author:

Jody Garnett, Refractions Reasearch

Constructor Summary

Specification()

Method Summary

abstract DescribeLayerRequest	createDescribeLayerRequest(java.net.URL onlineResource) Creates a DescribeLayer request which can be used to retrieve information about specific layers on the Web Map Server.
abstract AbstractGetCapabilitiesRequest	createGetCapabilitiesRequest(java.net.URL server) Factory method to create WMSGetCapabilities Request
abstract GetFeatureInfoRequest	createGetFeatureInfoRequest(java.net.URL onlineResource, GetMapRequest getMapRequest) Creates a GetFeatureInfoRequest for this specification, populating it with valid values.
abstract GetLegendGraphicRequest	createGetLegendGraphicRequest(java.net.URL onlineResource) Creates a GetLegendGraphicRequest which can be used to retrieve legend graphics from the WebMapServer
abstract GetMapRequest	createGetMapRequest(java.net.URL onlineResource) Creates a GetMapRequest for this specification, populating it with valid values.
abstract GetStylesRequest	createGetStylesRequest(java.net.URL onlineResource) Creates a GetStylesRequest which can be used to retrieve styles from the WMS.
abstract PutStylesRequest	createPutStylesRequest(java.net.URL onlineResource) Creates a PutStyles request which can be configured and the passed to the WMS to store styles for later use.
abstract java.lang.String	getVersion() Expected version attribute for root element.

Methods inherited from class java.lang.Object

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

Constructor Detail

Specification

public Specification()

Method Detail

getVersion

public abstract java.lang.String getVersion()

Expected version attribute for root element.

Returns:

the version as a String

createGetCapabilitiesRequest

public abstract AbstractGetCapabilitiesRequest createGetCapabilitiesRequest(java.net.URL server)

Factory method to create WMSGetCapabilities Request

Parameters:

server - the URL that points to the server's getCapabilities document

Returns:

a configured AbstractGetCapabilitiesRequest that can be used to access the Document

createGetMapRequest

public abstract GetMapRequest createGetMapRequest(java.net.URL onlineResource)

Creates a GetMapRequest for this specification, populating it with valid values.

Parameters:

onlineResource - the URL for the GetMapRequest

Returns:

a GetMapRequest that can be configured and used

createGetFeatureInfoRequest

public abstract GetFeatureInfoRequest createGetFeatureInfoRequest(java.net.URL onlineResource,
                                                                  GetMapRequest getMapRequest)

Creates a GetFeatureInfoRequest for this specification, populating it with valid values.

Parameters:

onlineResource - the URL to be executed against

getMapRequest - a previously configured GetMapRequest

Returns:

a GetFeatureInfoRequest that can be configured and used

createDescribeLayerRequest

public abstract DescribeLayerRequest createDescribeLayerRequest(java.net.URL onlineResource)
                                                         throws java.lang.UnsupportedOperationException

Creates a DescribeLayer request which can be used to retrieve information about specific layers on the Web Map Server.

Parameters:

onlineResource - the location where the request can be made

Returns:

a DescribeLayerRequest to be configured and then passed to the Web Map Server

Throws:

java.lang.UnsupportedOperationException - if the version of the specification doesn't support this request

createGetLegendGraphicRequest

public abstract GetLegendGraphicRequest createGetLegendGraphicRequest(java.net.URL onlineResource)
                                                               throws java.lang.UnsupportedOperationException

Creates a GetLegendGraphicRequest which can be used to retrieve legend graphics from the WebMapServer

Parameters:

onlineResource - the location where the request can be made

Returns:

a GetLegendGraphicRequest to be configured and passed to the WMS

Throws:

java.lang.UnsupportedOperationException - if the version of the specification doesn't support this request

createGetStylesRequest

public abstract GetStylesRequest createGetStylesRequest(java.net.URL onlineResource)
                                                 throws java.lang.UnsupportedOperationException

Creates a GetStylesRequest which can be used to retrieve styles from the WMS.

Parameters:

onlineResource - The location where the request can be made

Returns:

a configurable request object to be passed to a WMS

Throws:

java.lang.UnsupportedOperationException - if the version of the specification doesn't support this request

createPutStylesRequest

public abstract PutStylesRequest createPutStylesRequest(java.net.URL onlineResource)
                                                 throws java.lang.UnsupportedOperationException

Creates a PutStyles request which can be configured and the passed to the WMS to store styles for later use.

Parameters:

onlineResource - the location where the request can be made

Returns:

a configureable request object to be passed to the WMS

Throws:

java.lang.UnsupportedOperationException - if the version of the specification doesn't support this request