OWS: Classes and Construction Functions for Elements of the OWS Namespace

Description

These classes represent elements from the OGC Web Services Common Specification and the OGC Web Services Common Standard.

Usage

OwsCapabilities(version, updateSequence = NA, owsVersion = sosDefaultGetCapOwsVersion, identification = NULL, provider = NULL, operations = NULL, contents = NULL, languages = NULL)
OwsException(exceptionCode, exceptionText = c(), locator = as.character(NA))
OwsExceptionReport(version, lang = as.character(NA), exceptions = list(NA))
OwsGetCapabilities(service, acceptVersions, sections = sosDefaultGetCapSections, acceptFormats = sosDefaultGetCapAcceptFormats, updateSequence = c(as.character(NA)), owsVersion = sosDefaultGetCapOwsVersion, acceptLanguages = c(NA))
OwsOperation(name, DCPs, parameters = list(NA), constraints = list(NA), metadata = list(NA))
OwsOperationsMetadata(operations, parameters = list(NA), constraints = list(NA), extendedCapabilities = xmlNode(NA))
OwsRange(minimumValue = as.character(NA), maximumValue = as.character(NA), rangeClosure = as.character(NA), spacing = as.character(NA))
OwsServiceProvider(providerName, providerSite = as.character(NA), serviceContact = xmlNode(NA))
OwsServiceIdentification(serviceType, serviceTypeVersion, profile = c(NA), title, abstract = c(NA), keywords = c(NA), fees = as.character(NA), accessConstraints = c(NA))

Arguments

abstract

Brief narrative description of this server, normally available for display to a human.

acceptFormats

Unordered character vector of zero or more response formats desired by client, with preferred formats listed first.

acceptLanguages

Unordered character vector of zero or more languages desired by client, with preferred formats listed first. Only OWS 2.0.0!

acceptVersions

Comma-separated prioritized sequence of one or more specification versions accepted by client, with preferred versions listed first.

accessConstraints

Access constraints that should be observed to assure the protection of privacy or intellectual property, and any other restrictions on retrieving or using data from or otherwise using a server.

constraints

Constraint on valid domain of a non-parameter quantity that applies to an operation which a server implements.

contents

The provider section of a capabilities document, object of class OwsContentsOrNULL.

DCPs

Information for a Distributed Computing Platform (DCP) supported for an operation.

exceptionCode

The code attribute of an OWS Exception, see OwsExceptionsData.

exceptions

The list of OwsException in a OwsExceptionReport.

exceptionText

The text element of an OWS Exception, see OwsExceptionsData.

extendedCapabilities

The possible contents of the ExtendedCapabilities subsection are not specified by the SOS standard.

fees

Fees and terms for using a server, including the monetary units as specified in ISO 4217.

identification

The identification section of a capabilities document, object of class OwsServiceIdentificationOrNULL.

keywords

Unordered list of one or more commonly used or formalised word(s) or phrase(s) used to describe a server.

lang

The code attribute of an OWS Exception.

languages

The languages section of a capabilities document, currently an object of class XMLAbstractNode.

locator

The locator attribute of an OWS Exception, see OwsExceptionsData.

maximumValue

Maximum value of a range (numeric parameter).

metadata

Metadata about an operation and its implementation.

minimumValue

Minimum value of a range (numeric parameter).

name

Name of an operation (request) (for example, GetCapabilities).

operations

A list of objects of class OwsOperation in a OperationsMetadata object. The provider section of a capabilities document.

owsVersion

The used OWS specification version.

parameters

Parameter valid domain that applies to an operation which a server implements.

profile

Identifier of OGC Web Service (OWS) Application Profile.

providerName

Unique identifier for service provider organization.

providerSite

Reference to the most relevant web site of a service provider.

provider

The provider section of a capabilities document, object of class OwsServiceProviderOrNULL.

rangeClosure

Specifies which of minimum and maximum values are included in this range; include when not default of closed range. Possible values are closed, open, open-closed, or closed-open.

sections

Unordered character vector of zero or more names of sections of service metadata document to be returned in service metadata document.

serviceContact

Information for contacting service provider.

service

Service type identifier text.

serviceType

A service type name from registry of services.

serviceTypeVersion

Version of a service type implemented by a server.

spacing

Regular distance or spacing between allowed values in this range; include when range is not continuous.

title

Title of a server, normally used for display to a human.

updateSequence

Service metadata document version, value is “increased” whenever any change is made in complete service metadata document. This can be used to request a certain version of a metadata document. Parameter is found in both request and reponse, but may not be

version

The version of the document.

Objects from the Class

Objects can be created by calling the construction functions, e.g. in the form OwsCapabilities_1.1.0(...), OwsContents(...) or OwsException(...).

The following classes are virtual and no objects may be created from it: OwsContentsOrNULL, OwsServiceIdentificationOrNULL, OwsServiceProviderOrNULL, OwsOperationsMetadataOrNULL.

Extends

OwsCapabilities_1.1.0: Class "OwsCapabilities", directly.

OwsCapabilities_2.0.0: Class "OwsCapabilities_1.1.0", directly. Class "OwsCapabilities", by class "OwsCapabilities_1.1.0", distance 2.

OwsGetCapabilities_1.1.0 Class "OwsGetCapabilities", directly. Class "OwsServiceOperation", by class "OwsGetCapabilities", distance 2.

OwsGetCapabilities_2.0.0: Class "OwsGetCapabilities_1.1.0", directly. Class "OwsGetCapabilities", by class "OwsGetCapabilities_1.1.0", distance 2. Class "OwsServiceOperation", by class "OwsGetCapabilities_1.1.0", distance 3.

OwsServiceIdentification: Class "OwsServiceIdentificationOrNULL", directly.

OwsServiceProvider: Class "OwsServiceProviderOrNULL", directly.

Details

OwsServiceOperation is the top class which is eventually put into the request method, sosRequest(...).

Classes ending in ...OrNULL are used to model optional slots.

References

Whiteside A. (Ed.), OGC Web Services Common Specification, Open Geospatial Consortium Inc., OGC 06-121r3, Version: 1.1.0 with Corrigendum 1

Whiteside A., Greenwood, J. (Eds.), OGC Web Services Common Standard, Open Geospatial Consortium Inc., OGC 06-121r9, Version: 2.0.0

Examples

Run this code

showClass("OwsCapabilities_1.1.0")
showClass("OwsCapabilities_2.0.0")
showClass("OwsCapabilities")
showClass("OwsContents")
showClass("OwsContentsOrNULL")
showClass("OwsException")
showClass("OwsExceptionReport")
showClass("OwsGetCapabilities_1.1.0")
showClass("OwsGetCapabilities_2.0.0")
showClass("OwsGetCapabilities")
showClass("OwsOperation")
showClass("OwsOperationsMetadata")
showClass("OwsRange")
showClass("OwsServiceIdentification")
showClass("OwsServiceIdentificationOrNULL")
showClass("OwsServiceOperation")
showClass("OwsServiceProvider")
showClass("OwsServiceProviderOrNULL")

# TBD examples for construction functions

Run the code above in your browser using DataLab