nl.b3p.xml.ows.v100

Class CapabilitiesBaseType

java.lang.Object

nl.b3p.xml.ows.v100.CapabilitiesBaseType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

WFS_CapabilitiesType

public class CapabilitiesBaseType
extends Object
implements Serializable

XML encoded GetCapabilities operation response. This document provides clients with service metadata about a specific service instance, usually including metadata about the tightly-coupled data served. If the server does not implement the updateSequence parameter, the server shall always return the complete Capabilities document, without the updateSequence parameter. When the server implements the updateSequence parameter and the GetCapabilities operation request included the updateSequence parameter with the current value, the server shall return this element with only the "version" and "updateSequence" attributes. Otherwise, all optional elements shall be included or not depending on the actual value of the Contents parameter in the GetCapabilities operation request. This base type shall be extended by each specific OWS to include the additional contents needed.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CapabilitiesBaseType()

Method Summary

Modifier and Type	Method and Description
OperationsMetadata	getOperationsMetadata() Returns the value of field 'operationsMetadata'.
ServiceIdentification	getServiceIdentification() Returns the value of field 'serviceIdentification'.
ServiceProvider	getServiceProvider() Returns the value of field 'serviceProvider'.
String	getUpdateSequence() Returns the value of field 'updateSequence'.
String	getVersion() Returns the value of field 'version'.
boolean	isValid() Method isValid
void	marshal(ContentHandler handler) Method marshal
void	marshal(Writer out) Method marshal
void	setOperationsMetadata(OperationsMetadata operationsMetadata) Sets the value of field 'operationsMetadata'.
void	setServiceIdentification(ServiceIdentification serviceIdentification) Sets the value of field 'serviceIdentification'.
void	setServiceProvider(ServiceProvider serviceProvider) Sets the value of field 'serviceProvider'.
void	setUpdateSequence(String updateSequence) Sets the value of field 'updateSequence'.
void	setVersion(String version) Sets the value of field 'version'.
static CapabilitiesBaseType	unmarshal(Reader reader) Method unmarshal
void	validate() Method validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CapabilitiesBaseType

public CapabilitiesBaseType()

Method Detail

getOperationsMetadata

public OperationsMetadata getOperationsMetadata()

Returns the value of field 'operationsMetadata'. The field 'operationsMetadata' has the following description: Metadata about the operations and related abilities specified by this service and implemented by this server, including the URLs for operation requests. The basic contents of this section shall be the same for all OWS types, but individual services can add elements and/or change the optionality of optional elements.

Returns:

OperationsMetadata

getServiceIdentification

public ServiceIdentification getServiceIdentification()

Returns the value of field 'serviceIdentification'. The field 'serviceIdentification' has the following description: General metadata for this specific server. This XML Schema of this section shall be the same for all OWS.

Returns:

ServiceIdentification

getServiceProvider

public ServiceProvider getServiceProvider()

Returns the value of field 'serviceProvider'. The field 'serviceProvider' has the following description: Metadata about the organization that provides this specific service instance or server.

Returns:

ServiceProvider

getUpdateSequence

public String getUpdateSequence()

Returns the value of field 'updateSequence'.

Returns:

String

getVersion

public String getVersion()

Returns the value of field 'version'.

Returns:

String

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setOperationsMetadata

public void setOperationsMetadata(OperationsMetadata operationsMetadata)

Sets the value of field 'operationsMetadata'. The field 'operationsMetadata' has the following description: Metadata about the operations and related abilities specified by this service and implemented by this server, including the URLs for operation requests. The basic contents of this section shall be the same for all OWS types, but individual services can add elements and/or change the optionality of optional elements.

Parameters:

operationsMetadata - the value of field 'operationsMetadata'.

setServiceIdentification

public void setServiceIdentification(ServiceIdentification serviceIdentification)

Sets the value of field 'serviceIdentification'. The field 'serviceIdentification' has the following description: General metadata for this specific server. This XML Schema of this section shall be the same for all OWS.

Parameters:

serviceIdentification - the value of field 'serviceIdentification'.

setServiceProvider

public void setServiceProvider(ServiceProvider serviceProvider)

Sets the value of field 'serviceProvider'. The field 'serviceProvider' has the following description: Metadata about the organization that provides this specific service instance or server.

Parameters:

serviceProvider - the value of field 'serviceProvider'.

setUpdateSequence

public void setUpdateSequence(String updateSequence)

Sets the value of field 'updateSequence'.

Parameters:

updateSequence - the value of field 'updateSequence'.

setVersion

public void setVersion(String version)

Sets the value of field 'version'.

Parameters:

version - the value of field 'version'.

unmarshal

public static CapabilitiesBaseType unmarshal(Reader reader)
                                      throws org.exolab.castor.xml.MarshalException,
                                             org.exolab.castor.xml.ValidationException

Method unmarshal

Parameters:

reader -

Returns:

CapabilitiesBaseType

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException