|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WFSProtocol
Facade interface to interact with a WFS instance.
Implementations of this interface know how to send and get information back from a WFS service
for a specific protocol version, but are not meant to provide any logic other than the
conversation with the service. For instance, WFSProtocol
implementations are not required
to transform filters
to something appropriate for the service capabilities, nor
any other control logic than creating and sending the requests mapping what is given to the
operation methods.
This interface provides enough information extracted or derived from the WFS capabilities document as for the client code to issue requests appropriate for the server capabilities.
Method Summary | |
---|---|
WFSResponse |
describeFeatureTypeGET(java.lang.String typeName,
java.lang.String outputFormat)
Issues a DescribeFeatureType request for the given type name and output format using the HTTP GET method |
WFSResponse |
describeFeatureTypePOST(java.lang.String typeName,
java.lang.String outputFormat)
Issues a DescribeFeatureType request for the given type name and output format using the HTTP POST method |
void |
dispose()
Allows to free any resource held. |
java.lang.String |
getDefaultCRS(java.lang.String typeName)
Returns the CRS identifier of the default CRS for the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
java.lang.String |
getDefaultOutputFormat(WFSOperationType get_feature)
|
java.net.URL |
getDescribeFeatureTypeURLGet(java.lang.String typeName)
Returns the http GET request to get the gml schema for the given type name |
java.lang.String |
getFeatureTypeAbstract(java.lang.String typeName)
Returns the abstract of the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
java.util.Set<java.lang.String> |
getFeatureTypeKeywords(java.lang.String typeName)
Returns the list of keywords of the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
javax.xml.namespace.QName |
getFeatureTypeName(java.lang.String typeName)
Returns the full feature type name for the typeName as declared in the FeatureTypeList/FeatureType/Name element of the capabilities document. |
java.util.Set<javax.xml.namespace.QName> |
getFeatureTypeNames()
Returns the set of type names as extracted from the capabilities document, including the namespace and prefix. |
java.lang.String |
getFeatureTypeTitle(java.lang.String typeName)
Returns the title of the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
ReferencedEnvelope |
getFeatureTypeWGS84Bounds(java.lang.String typeName)
Returns the lat lon envelope of the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
org.opengis.filter.capability.FilterCapabilities |
getFilterCapabilities()
Returns the parsed version of the FilterCapabilities section in the capabilities document |
java.net.URL |
getOperationURL(WFSOperationType operation,
boolean post)
Returns the URL for the given operation name and HTTP protocol as stated in the WFS capabilities. |
java.lang.String |
getServiceAbstract()
Returns service abstract as stated in the capabilities document |
java.util.Set<java.lang.String> |
getServiceKeywords()
Returns service keywords as stated in the capabilities document |
java.net.URI |
getServiceProviderUri()
Returns service provider URI as stated in the capabilities document |
java.lang.String |
getServiceTitle()
Returns service title as stated in the capabilities document |
Version |
getServiceVersion()
Returns the WFS protocol version this facade talks to the WFS instance. |
java.util.Set<java.lang.String> |
getSupportedCRSIdentifiers(java.lang.String typeName)
Returns the union of the default CRS and the other supported CRS's of the given feature type as declared in the corresponding FeatureType element in the capabilities document. |
java.util.Set<java.lang.String> |
getSupportedGetFeatureOutputFormats()
Returns the output format names declared in the GetFeature operation metadata section of the WFS capabilities document |
java.util.Set<java.lang.String> |
getSupportedOutputFormats(java.lang.String typeName)
Returns the union of getSupportedGetFeatureOutputFormats() and the output formats
declared for the feature type specifically in the FeatureTypeList section of the capabilities
document for the given feature type |
WFSResponse |
issueGetFeatureGET(GetFeature request)
Issues a GetFeature request for the given request, using GET HTTP method |
WFSResponse |
issueGetFeaturePOST(GetFeature request)
Issues a GetFeature request for the given request, using POST HTTP method |
org.opengis.filter.Filter[] |
splitFilters(org.opengis.filter.Filter filter)
|
boolean |
supportsOperation(WFSOperationType operation,
boolean post)
Returns whether the service supports the given operation for the given HTTP method. |
Method Detail |
---|
Version getServiceVersion()
java.lang.String getServiceTitle()
java.lang.String getServiceAbstract()
null
java.util.Set<java.lang.String> getServiceKeywords()
java.net.URI getServiceProviderUri()
java.util.Set<java.lang.String> getSupportedGetFeatureOutputFormats()
java.util.Set<java.lang.String> getSupportedOutputFormats(java.lang.String typeName)
getSupportedGetFeatureOutputFormats()
and the output formats
declared for the feature type specifically in the FeatureTypeList section of the capabilities
document for the given feature type
typeName
- the feature type name for which to return the supported output formats
typeName
java.util.Set<javax.xml.namespace.QName> getFeatureTypeNames()
javax.xml.namespace.QName getFeatureTypeName(java.lang.String typeName)
typeName
as declared in the FeatureTypeList/FeatureType/Name
element of the capabilities document.
The returned QName contains the namespace, localname as well as the prefix. typeName
is known to be prefix:localName
.
typeName
- the prefixed type name to get the full name for
java.lang.IllegalArgumentException
- if the typeName
does not existorg.opengis.filter.capability.FilterCapabilities getFilterCapabilities()
FilterCapabilities
out of the FilterCapabilities section in the
getcapabilities documentboolean supportsOperation(WFSOperationType operation, boolean post)
operation
- the operation to check if the server supportsmethod
- the HTTP method to check if the server supports for the given operation
true
if the operation/method is supported as stated in the WFS capabilitiesjava.net.URL getOperationURL(WFSOperationType operation, boolean post)
operation
- the name of the WFS operationmethod
- the HTTP method
null
if the
capabilities does not declare an access point for the operation/method combination#supportsOperation(WFSOperationType, HttpMethod)
java.lang.String getFeatureTypeTitle(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
java.lang.String getFeatureTypeAbstract(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
ReferencedEnvelope getFeatureTypeWGS84Bounds(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
java.lang.String getDefaultCRS(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
java.util.Set<java.lang.String> getSupportedCRSIdentifiers(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
java.util.Set<java.lang.String> getFeatureTypeKeywords(java.lang.String typeName)
typeName
- the featuretype name as declared in the FeatureType/Name element of the WFS
capabilities
java.net.URL getDescribeFeatureTypeURLGet(java.lang.String typeName)
typeName
-
WFSResponse describeFeatureTypeGET(java.lang.String typeName, java.lang.String outputFormat) throws java.io.IOException, java.lang.UnsupportedOperationException
java.io.IOException
java.lang.UnsupportedOperationException
WFSResponse describeFeatureTypePOST(java.lang.String typeName, java.lang.String outputFormat) throws java.io.IOException, java.lang.UnsupportedOperationException
java.io.IOException
java.lang.UnsupportedOperationException
WFSResponse issueGetFeatureGET(GetFeature request) throws java.io.IOException, java.lang.UnsupportedOperationException
The request
shall already be adapted to what the server supports in terms of filter
capabilities and CRS reprojection. The WFSProtocol
implementation is not required to
check if the query filter is fully supported nor if the CRS is supported for the feature
type.
request
- the request to send to the WFS, as is.kvp
- the key/value pair representation of the request to build the query string from
java.io.IOException
java.lang.UnsupportedOperationException
WFSResponse issueGetFeaturePOST(GetFeature request) throws java.io.IOException, java.lang.UnsupportedOperationException
The query to WFS request parameter translation is the same than for
issueGetFeatureGET(GetFeature)
java.io.IOException
java.lang.UnsupportedOperationException
void dispose()
Successive calls to this method should not result in any exception, but the instance is meant to not be usable after the first invocation.
java.lang.String getDefaultOutputFormat(WFSOperationType get_feature)
org.opengis.filter.Filter[] splitFilters(org.opengis.filter.Filter filter)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |