com.moximedia.ows.wfs
Class WfsService

java.lang.Object
  extended bycom.moximedia.ows.wfs.WfsService
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, Service, ServiceType

public class WfsService
extends java.lang.Object
implements Service, ServiceType, java.lang.Cloneable, java.io.Serializable

The WfsService object contains properties and methods related to a WFS service. The service contains an array of layers contained in the service.

Author:
Doug Cates - www.moximedia.com
See Also:
Serialized Form

Field Summary
static int WFS_REQUEST_METHOD_GET
           
static int WFS_REQUEST_METHOD_POST
           
 
Fields inherited from interface com.moximedia.ows.types.ServiceType
SERVICE_TYPE_ACETATE, SERVICE_TYPE_WFS, SERVICE_TYPE_WMS
 
Constructor Summary
WfsService()
          Creates a new WfsService object.
 
Method Summary
 java.lang.String getDescribeFeatureTypeUrl()
          Gets the base URL used for the WFS DescribeFeatureType requests.
 java.lang.String getGetFeatureParsingFormat()
          Gets the name of the class used for parsing the GetFeature response for this service.
 int getGetFeatureRequestMethod()
          Gets the request method enumerator.
 java.lang.String getGetFeatureUrl()
          Gets the base URL used for the WFS GetFeature requests.
 Layers getLayers()
          Gets the layers in this service.
 java.lang.String getMap(Map map, Layers layers, boolean transparent)
          Creates the URL used for the image request for this service.
 java.lang.String getName()
          Get the name of this service.
 java.lang.String getNamespace()
          Gets the namespace used in requests to this service.
 int getObjectId()
          Gets the IMF assigned object id for this service.
 java.lang.String getOutputFormat()
          Gets the output format when requesting WFS features.
 java.lang.String getSchema()
          Gets the schema used in requests to this service.
 int getServiceType()
          Gets the service type of this service.
 java.lang.String getTransactionUrl()
          Gets the base URL used for the WFS transaction requests.
 java.lang.String getVersion()
          Gets the version number used in WMS requests to this service.
 long getVersionNumber()
          Gets the version number as a comparable number.
 long getVersionNumber(java.lang.String versionString)
          Gets the comparable numeric version number associated with a string.
 boolean isForwarded()
          Returns an indicator of whether responses from this server are forwarded.
 void setAuthentication(java.lang.String userpass)
          Sets the username and password.
 void setGetFeatureUrl(java.lang.String href)
          Sets the base URL used for the WMS GetFeature requests.
 void setName(java.lang.String name)
          Sets the name of this service.
 void setNamespace(java.lang.String namespace)
          Sets the namespace used in requests to this service.
 void setXmlAttribute(Map map, java.lang.String element, java.lang.String name, java.lang.String value)
          Sets one of the attributes of this object using a string value.
 boolean supports(java.lang.String capability)
          Checks to see if the specified capability is supported by this service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WFS_REQUEST_METHOD_GET

public static final int WFS_REQUEST_METHOD_GET
See Also:
Constant Field Values

WFS_REQUEST_METHOD_POST

public static final int WFS_REQUEST_METHOD_POST
See Also:
Constant Field Values
Constructor Detail

WfsService

public WfsService()
Creates a new WfsService object.

Method Detail

getNamespace

public java.lang.String getNamespace()
Gets the namespace used in requests to this service.

Returns:
The namespace.

setNamespace

public void setNamespace(java.lang.String namespace)
Sets the namespace used in requests to this service.

Parameters:
namespace - The namespace string.

getSchema

public java.lang.String getSchema()
Gets the schema used in requests to this service.

Returns:
The schema.

setAuthentication

public void setAuthentication(java.lang.String userpass)
Sets the username and password.

Parameters:
userpass - The credentials separated by a colon, user:pass

supports

public boolean supports(java.lang.String capability)
Checks to see if the specified capability is supported by this service.

Parameters:
capability - The capability name.
Returns:
True if the capability is supported, otherwise false.

isForwarded

public boolean isForwarded()
Returns an indicator of whether responses from this server are forwarded.

Specified by:
isForwarded in interface Service
Returns:
True if the responses are forwarded, otherwise false.

getDescribeFeatureTypeUrl

public java.lang.String getDescribeFeatureTypeUrl()
Gets the base URL used for the WFS DescribeFeatureType requests.

Returns:
The base URL.

getTransactionUrl

public java.lang.String getTransactionUrl()
Gets the base URL used for the WFS transaction requests.

Returns:
The base URL.

getGetFeatureParsingFormat

public java.lang.String getGetFeatureParsingFormat()
Gets the name of the class used for parsing the GetFeature response for this service.

Returns:
The name of the parser handler.

getObjectId

public int getObjectId()
Gets the IMF assigned object id for this service.

Specified by:
getObjectId in interface Service
Returns:
The object id.

getGetFeatureRequestMethod

public int getGetFeatureRequestMethod()
Gets the request method enumerator.

Returns:
The request method enumerator.

getGetFeatureUrl

public java.lang.String getGetFeatureUrl()
Gets the base URL used for the WFS GetFeature requests.

Returns:
The base URL.

getLayers

public Layers getLayers()
Gets the layers in this service.

Returns:
The layers.

getName

public java.lang.String getName()
Get the name of this service. The name is used to find this service in the map's service array.

Specified by:
getName in interface Service
Returns:
The name of this service.

getOutputFormat

public java.lang.String getOutputFormat()
Gets the output format when requesting WFS features.

Returns:
the output format.

getServiceType

public int getServiceType()
Gets the service type of this service.

Specified by:
getServiceType in interface Service
Returns:
Always returns com.moximedia.ows.types.ServiceType.SERVICE_TYPE_WFS

getVersion

public java.lang.String getVersion()
Gets the version number used in WMS requests to this service.

Returns:
The version number, like 1.1.0

getVersionNumber

public long getVersionNumber()
Gets the version number as a comparable number. For internal use only to determine what specification to use.

Returns:
The version number.

getVersionNumber

public long getVersionNumber(java.lang.String versionString)
Gets the comparable numeric version number associated with a string.

Parameters:
versionString - The version string.
Returns:
The version number.

setGetFeatureUrl

public void setGetFeatureUrl(java.lang.String href)
Sets the base URL used for the WMS GetFeature requests.

Parameters:
href - The base URL.

setName

public void setName(java.lang.String name)
Sets the name of this service. The name is used to find this service in the map's service array.

Parameters:
name - The name of this service.

setXmlAttribute

public void setXmlAttribute(Map map,
                            java.lang.String element,
                            java.lang.String name,
                            java.lang.String value)
Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:
map - The map that contains this service.
element - The XML element tag containing this attribute.
name - The XML attribute name.
value - The XML attribute value.

getMap

public java.lang.String getMap(Map map,
                               Layers layers,
                               boolean transparent)
Creates the URL used for the image request for this service. Used when rendering WFS layers directly. Not presently used.

Specified by:
getMap in interface Service
Parameters:
map - The map containing the service
layers - The layers to draw.
transparent - True if tranparent otherwise false.
Returns:
The GetMap URL. NOTE: always returns an empty image.


Internet Mapping Framework for OpenGIS Java Object Model API (v1.3.007)
Copyright © 2005 Moxi Media Inc. and Province of British Columbia. All Rights Reserved.