de.cismet.cismap.commons.wfs

Class WFSFacade

java.lang.Object

de.cismet.cismap.commons.wfs.WFSFacade

public class WFSFacade
extends Object

This class invokes Web Feature services and creates WFS requests. This class considers the WFS version while creating WFS requests and should be the only class that is used to create and modify WFS request. The currently supported WFS versions are 1.0.0 and 1.1.0

Version:

$Revision$, $Date$

Author:

therter

Field Summary

Fields

Modifier and Type	Field and Description
static String	CISMAP_BOUNDING_BOX_AS_GML_PLACEHOLDER
static String	CISMAP_RESULT_TYPE_PLACEHOLDER
static String	SRS_NAME_PLACEHOLDER

Constructor Summary

Constructors

Constructor and Description
WFSFacade(WFSCapabilities cap, ResponseParserFactory parserFactory) this constructor should only be used by the WFSCapabilities classes.

Method Summary

Modifier and Type	Method and Description
static void	changePropertyNames(org.jdom.Element query, Collection<String> properties, String version) Replaces the current property names with the given property names in the getFeature query.
FeatureTypeDescription	describeFeatureType(FeatureType feature) sends a describeFeatureType request to the corresponding wfs.
static FeatureType	extractFeatureTypeFromCap(String featureName, WFSCapabilities cap) DOCUMENT ME!
static FeatureType	extractRequestedFeatureType(String request, WFSCapabilities cap) DOCUMENT ME!
org.jdom.Element	getGetFeatureQuery(FeatureType feature) Returns a template for a getFeature request.
static String	getOptimalCrsForFeature(FeatureType feature, String mapSrs) DOCUMENT ME!
static void	setGeometry(org.jdom.Element query, String geoName, String version) Replaces the geometry-property in the given getFeature query template.
String	setGetFeatureBoundingBox(String query, XBoundingBox bbox, FeatureType feature, String mapCrs, boolean reverseAxisOrder) Set the bounding box and the srs of the given getFeature request and returns the resulting request as string.
String	setGetFeatureBoundingBox(String query, XBoundingBox bbox, FeatureType feature, String mapCrs, boolean reverseAxisOrder, boolean onlyFeatureCount) Set the bounding box and the srs of the given getFeature request and returns the resulting request as string.
static void	setMaxFeatureCount(org.jdom.Element wfsQuery, int maxFeatureCount, String version) Replaces the current max feature count with the given max feature count in the given getFeature request.

Methods inherited from class java.lang.Object

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

Field Detail

CISMAP_BOUNDING_BOX_AS_GML_PLACEHOLDER

public static final String CISMAP_BOUNDING_BOX_AS_GML_PLACEHOLDER

See Also:

Constant Field Values

CISMAP_RESULT_TYPE_PLACEHOLDER

public static final String CISMAP_RESULT_TYPE_PLACEHOLDER

See Also:

Constant Field Values

SRS_NAME_PLACEHOLDER

public static final String SRS_NAME_PLACEHOLDER

See Also:

Constant Field Values

Constructor Detail

WFSFacade

public WFSFacade(WFSCapabilities cap,
                 ResponseParserFactory parserFactory)

this constructor should only be used by the WFSCapabilities classes. Because every WFSFacade is bounded to a capabilities class and should only be used with features of the given capabilities document.

Parameters:

cap - DOCUMENT ME!

parserFactory - DOCUMENT ME!

Method Detail

describeFeatureType

public FeatureTypeDescription describeFeatureType(FeatureType feature)
                                           throws IOException,
                                                  Exception

sends a describeFeatureType request to the corresponding wfs.

Parameters:

feature - the feature, the request should be sent for

Returns:

the wfs response as FeatureTypeDescription object

Throws:

IOException - DOCUMENT ME!

Exception - DOCUMENT ME!

getGetFeatureQuery

public org.jdom.Element getGetFeatureQuery(FeatureType feature)

Returns a template for a getFeature request. The template contains placeholders for the bounding box, the srs name and the property names. To replace the placeholders, use the following static methods:
setGetFeatureBoundingBox setGeometry changePropertyNames setMaxFeatureCount

Parameters:

feature - the request template will be created for this feature

Returns:

a getFeature request template. The WFS version will be considered.

setGetFeatureBoundingBox

public String setGetFeatureBoundingBox(String query,
                                       XBoundingBox bbox,
                                       FeatureType feature,
                                       String mapCrs,
                                       boolean reverseAxisOrder)

Set the bounding box and the srs of the given getFeature request and returns the resulting request as string.

Parameters:

query - the getFeature request template.

bbox - the bounding box that should be used in the getFeature request

feature - the type of the feature from the given query

mapCrs - the crs of the map, the features should be shown on

reverseAxisOrder - if true, the axis order will be lat/lon

Returns:

the new getFeature request

setGetFeatureBoundingBox

public String setGetFeatureBoundingBox(String query,
                                       XBoundingBox bbox,
                                       FeatureType feature,
                                       String mapCrs,
                                       boolean reverseAxisOrder,
                                       boolean onlyFeatureCount)

Set the bounding box and the srs of the given getFeature request and returns the resulting request as string.

Parameters:

query - the getFeature request template.

bbox - the bounding box that should be used in the getFeature request

feature - the type of the feature from the given query

mapCrs - the crs of the map, the features should be shown on

reverseAxisOrder - if true, the axis order will be lat/lon

onlyFeatureCount - the resultType attribute will be set to hits, iif onlyFeatureCount is true

Returns:

the new getFeature request

getOptimalCrsForFeature

public static String getOptimalCrsForFeature(FeatureType feature,
                                             String mapSrs)

DOCUMENT ME!

Parameters:

feature - DOCUMENT ME!

mapSrs - DOCUMENT ME!

Returns:

DOCUMENT ME!

extractRequestedFeatureType

public static FeatureType extractRequestedFeatureType(String request,
                                                      WFSCapabilities cap)

DOCUMENT ME!

Parameters:

request - DOCUMENT ME!

cap - DOCUMENT ME!

Returns:

DOCUMENT ME!

extractFeatureTypeFromCap

public static FeatureType extractFeatureTypeFromCap(String featureName,
                                                    WFSCapabilities cap)

DOCUMENT ME!

Parameters:

featureName - DOCUMENT ME!

cap - DOCUMENT ME!

Returns:

DOCUMENT ME!

setMaxFeatureCount

public static void setMaxFeatureCount(org.jdom.Element wfsQuery,
                                      int maxFeatureCount,
                                      String version)

Replaces the current max feature count with the given max feature count in the given getFeature request.

Parameters:

wfsQuery - query getFeature request as JDOM-element

maxFeatureCount - properties collection of strings

version - the version of the wfs request that is contained in the query paramaeter

changePropertyNames

public static void changePropertyNames(org.jdom.Element query,
                                       Collection<String> properties,
                                       String version)

Replaces the current property names with the given property names in the getFeature query.

Parameters:

query - getFeature request as JDOM-element

properties - the property names

version - the version of the wfs request that is contained in the query paramaeter

setGeometry

public static void setGeometry(org.jdom.Element query,
                               String geoName,
                               String version)

Replaces the geometry-property in the given getFeature query template.

Parameters:

query - getFeature request as JDOM-element

geoName - the name of the geometry

version - the version of the wfs request that is contained in the query paramaeter