org.deegree_impl.services.wms.capabilities
Class Capability_Impl

java.lang.Object
  org.deegree_impl.services.wms.capabilities.Capability_Impl

All Implemented Interfaces:

Capability, Marshallable

class Capability_Impl

extends java.lang.Object

implements Capability, Marshallable

The element of the Capabilities XML names the actual operations that are supported by the service instance, the output formats offered for those operations, and the URL prefix for each operation. The XML DTD includes placeholders for Distributed Computing Platforms other than HTTP, and request methods other that HTTP GET, but currently only HTTP GET is defined for a basic WMS.

Ignorable vendor-specific elements may be included. An SLD WMS would also include a element and URLs for HTTP POST requests.

----------------------------------------------------------------------

Version:

$Revision: 1.14 $

Author:

Katharina Lupp, Markus Schneider

Field Summary

private CException	exception
private Layer	layer
private Request	request
private UserDefinedSymbolization	userDefinedSymbolization
private org.w3c.dom.Document	vendorSpecificCapabilities

Constructor Summary

(package private)	Capability_Impl() default constructor
(package private)	Capability_Impl(Request request, CException exception, org.w3c.dom.Document vendorSpecificCapabilities, UserDefinedSymbolization userDefinedSymbolization, Layer layer) constructor initializing the class with the capabilities

Method Summary

java.lang.String	exportAsXML() Returns an XML representation of this object.
CException	getException() returns the format where exceptions will be returned
Layer	getLayer() returns the top level layer that may encloses several more layers and layer hierachies available by a map server.
Layer	getLayer(java.lang.String name) Returns the Layer identified by the submitted name.
private Layer	getLayer(java.lang.String name, Layer[] layers) recursion over all layers to find the layer that matches the submitted name.
Request	getRequest() Available WMS Operations are listed in a Request element.
UserDefinedSymbolization	getUserDefinedSymbolization() Optional user-defined symbolization (used only by SLD-enabled WMSes).
org.w3c.dom.Document	getVendorSpecificCapabilities() returns vendor specific capabilities that are not common to wms as dom document.
void	setException(CException exception) sets the format where exceptions will be returned
void	setLayer(Layer layer) sets the top level layer that may encloses several more layers and layer hierachies available by a map server.
void	setRequest(Request request) sets available WMS Operations listed in a Request element.
void	setUserDefinedSymbolization(UserDefinedSymbolization userDefinedSymbolization) sets the user-defined symbolization
void	setVendorSpecificCapabilities(org.w3c.dom.Document vendorSpecificCapabilities) sets vendor specific capabilities that are not common to wms as dom document.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

exception

private CException exception

vendorSpecificCapabilities

private org.w3c.dom.Document vendorSpecificCapabilities

layer

private Layer layer

request

private Request request

userDefinedSymbolization

private UserDefinedSymbolization userDefinedSymbolization

Constructor Detail

Capability_Impl

Capability_Impl()

default constructor

Capability_Impl

Capability_Impl(Request request,
                CException exception,
                org.w3c.dom.Document vendorSpecificCapabilities,
                UserDefinedSymbolization userDefinedSymbolization,
                Layer layer)

constructor initializing the class with the capabilities

Method Detail

getRequest

public Request getRequest()

Available WMS Operations are listed in a Request element.

Specified by:

getRequest in interface Capability

setRequest

public void setRequest(Request request)

sets available WMS Operations listed in a Request element.

getException

public CException getException()

returns the format where exceptions will be returned

Specified by:

getException in interface Capability

setException

public void setException(CException exception)

sets the format where exceptions will be returned

getVendorSpecificCapabilities

public org.w3c.dom.Document getVendorSpecificCapabilities()

returns vendor specific capabilities that are not common to wms as dom document.

Specified by:

getVendorSpecificCapabilities in interface Capability

setVendorSpecificCapabilities

public void setVendorSpecificCapabilities(org.w3c.dom.Document vendorSpecificCapabilities)

sets vendor specific capabilities that are not common to wms as dom document.

getUserDefinedSymbolization

public UserDefinedSymbolization getUserDefinedSymbolization()

Optional user-defined symbolization (used only by SLD-enabled WMSes).

Specified by:

getUserDefinedSymbolization in interface Capability

setUserDefinedSymbolization

public void setUserDefinedSymbolization(UserDefinedSymbolization userDefinedSymbolization)

sets the user-defined symbolization

getLayer

public Layer getLayer()

returns the top level layer that may encloses several more layers and layer hierachies available by a map server. If no layer is available null will be returned.

Specified by:

getLayer in interface Capability

getLayer

public Layer getLayer(java.lang.String name)

Returns the Layer identified by the submitted name. If no Layer matches the name null will be returned.

Specified by:

getLayer in interface Capability

Parameters:

name - name of the requested layer

Returns:

a layer object or null

getLayer

private Layer getLayer(java.lang.String name,
                       Layer[] layers)

recursion over all layers to find the layer that matches the submitted name. If no layer can be found that fullfills the condition null will be returned.

Parameters:

name - name of the layer to be found

layers - list of searchable layers

Returns:

a layer object or null

setLayer

public void setLayer(Layer layer)

sets the top level layer that may encloses several more layers and layer hierachies available by a map server. If no layer is available null will be returned.

toString

public java.lang.String toString()

Returns:

exportAsXML

public java.lang.String exportAsXML()

Returns an XML representation of this object.

Specified by:

exportAsXML in interface Marshallable

Returns:

XML-representation of this object