org.deegree.ogcwebservices.getcapabilities
Class CapabilitiesService

java.lang.Object
  org.deegree.ogcwebservices.getcapabilities.CapabilitiesService

public class CapabilitiesService
extends Object

The interface provides acces to the <CapabilitiesService> element of the Capabilities XML providing general metadata for the service as a whole. It shall include a Name, Title, and Online Resource URL. Optionally, Abstract, Keyword List, Contact Information, Fees, and Access Constraints may be provided. The meaning of most of these elements is defined in [ISO 19115]. The CapabilitiesService Name shall be "ogc:WMS" in the case of a Web Map CapabilitiesService.

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

Version:

$Revision: 18195 $

Author:

Katharina Lupp, Markus Schneider

Constructor Summary

CapabilitiesService(String name, String title, String abstract_, String[] keywords, URL onlineResource, ContactInformation contactInformation, String fees, String accessConstraints)
constructor initializing the class with the OGCWebServiceCapabilities

Method Summary

void	addKeyword(String keyword) adds the keywordList
String	getAbstract() The Abstract element allows a descriptive narrative providing more information about the enclosing object.
String	getAccessConstraints() Returns access constraints assigned to the service.
ContactInformation	getContactInformation() Returns informations who to contact for questions about the service.
String	getFees() Returns fees assigned to the service.
String[]	getKeywordList() A list of keywords or keyword phrases should be included to help catalog searching.
String	getName() returns the name of the service.
URL	getOnlineResource() The OnlineResource element within the CapabilitiesService element can be used, for example, to point to the web site of the service provider.
String	getTitle() Returns the title of the service.
void	setAbstract(String abstract_) Sets the abstract element
void	setAccessConstraints(String accessConstraints) Sets access constraints assigned to the service.
void	setContactInformation(ContactInformation contactInformation) Sets informations who to contact for questions about the service.
void	setFees(String fees) Sets fees assigned to the service.
void	setKeywordList(String[] keywordList) sets the keywordList
void	setName(String name) sets the name of the service.
void	setOnlineResource(URL onlineResource) sets URL prefix for get HTTP request method.
void	setTitle(String title) Sets the title of the service.

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilitiesService

public CapabilitiesService(String name,
                           String title,
                           String abstract_,
                           String[] keywords,
                           URL onlineResource,
                           ContactInformation contactInformation,
                           String fees,
                           String accessConstraints)

constructor initializing the class with the OGCWebServiceCapabilities

Parameters:

name -

title -

abstract_ -

keywords -

onlineResource -

contactInformation -

fees -

accessConstraints -

Method Detail

getName

public String getName()

returns the name of the service. Typically, the Name is a single word used for machine-to-machine communication.

Returns:

name of the service

setName

public void setName(String name)

sets the name of the service. Typically, the Name is a single word used for machine-to-machine communication.

Parameters:

name -

getTitle

public String getTitle()

Returns the title of the service. The Title is for the benefit of humans. The CapabilitiesService Title is at the discretion of the provider, and should be brief yet descriptive enough to identify this server in a menu with other servers.

Returns:

title of the service

See Also:

getName()

setTitle

public void setTitle(String title)

Sets the title of the service. The Title is for the benefit of humans. The CapabilitiesService Title is at the discretion of the provider, and should be brief yet descriptive enough to identify this server in a menu with other servers.

Parameters:

title -

See Also:

getName()

getAbstract

public String getAbstract()

The Abstract element allows a descriptive narrative providing more information about the enclosing object.

Returns:

the abstract

setAbstract

public void setAbstract(String abstract_)

Sets the abstract element

Parameters:

abstract_ -

getKeywordList

public String[] getKeywordList()

A list of keywords or keyword phrases should be included to help catalog searching. Currently, no controlled vocabulary has been defined.

Returns:

the keyword list

addKeyword

public void addKeyword(String keyword)

adds the keywordList

Parameters:

keyword -

setKeywordList

public void setKeywordList(String[] keywordList)

sets the keywordList

Parameters:

keywordList -

getOnlineResource

public URL getOnlineResource()

The OnlineResource element within the CapabilitiesService element can be used, for example, to point to the web site of the service provider. There are other OnlineResource elements used for the URL prefix of each supported operation.

Returns:

the link

setOnlineResource

public void setOnlineResource(URL onlineResource)

sets URL prefix for get HTTP request method.

Parameters:

onlineResource -

getContactInformation

public ContactInformation getContactInformation()

Returns informations who to contact for questions about the service. This method returns null if no contact informations are available.

Returns:

informations who to contact for questions about the service. This method returns null if no contact informations are available.

setContactInformation

public void setContactInformation(ContactInformation contactInformation)

Sets informations who to contact for questions about the service. This method returns null if no contact informations are available.

Parameters:

contactInformation -

getFees

public String getFees()

Returns fees assigned to the service. If no fees defined "none" will be returned.

Returns:

fees assigned to the service. If no fees defined "none" will be returned.

setFees

public void setFees(String fees)

Sets fees assigned to the service. If no fees defined "none" will be returned.

Parameters:

fees -

getAccessConstraints

public String getAccessConstraints()

Returns access constraints assigned to the service. If no access constraints are defined "none" will be returned.

Returns:

the constraints

setAccessConstraints

public void setAccessConstraints(String accessConstraints)

Sets access constraints assigned to the service. If no access constraints are defined "none" will be returned.

Parameters:

accessConstraints -