QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Namespaces | Classes | Functions | Variables
QgsWfs Namespace Reference
server library

WMS implementation. More...

Namespaces

namespace  v1_0_0
 

Classes

struct  getFeatureQuery
 
struct  getFeatureRequest
 
class  QgsBadRequestException
 Exception thrown in case of malformed request. More...
 
class  QgsRequestNotWellFormedException
 Exception thrown in case of malformed request. More...
 
class  QgsSecurityAccessException
 Exception thrown when data access violates access controls. More...
 
class  QgsServiceException
 Exception class for WFS service exceptions. More...
 
class  QgsWfsParameter
 WFS parameter received from the client. More...
 
class  QgsWfsParameters
 Provides an interface to retrieve and manipulate WFS parameters received from the client. More...
 
class  Service
 OGC web service specialized for WFS. More...
 
struct  transactionDelete
 
struct  transactionInsert
 
struct  transactionRequest
 
struct  transactionUpdate
 

Functions

QDomDocument createGetCapabilitiesDocument (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Create get capabilities document. More...
 
QDomDocument createTransactionDocument (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request)
 Create a wfs transaction document. More...
 
QgsFeatureList featuresFromGML (QDomNodeList featureNodeList, QgsVectorLayer *layer)
 Transform GML feature nodes to features. More...
 
QDomElement getFeatureTypeListElement (QDomDocument &doc, QgsServerInterface *serverIface, const QgsProject *project)
 Create FeatureTypeList element for get capabilities document. More...
 
void getFieldAttributes (const QgsField &field, QString &fieldName, QString &fieldType)
 Helper for returning the field type and type name. More...
 
QDomElement getOperationsMetadataElement (QDomDocument &doc, const QgsProject *project, const QgsServerRequest &request, const QgsServerSettings *settings)
 Create OperationsMetadata element for get capabilities document. More...
 
QDomElement getParameterElement (QDomDocument &doc, const QString &name, const QStringList &values)
 Create a parameter element. More...
 
QStringList getRequestTypeNames (const QgsServerRequest &request, const QgsWfsParameters &wfsParams)
 Helper for returning typename list from the request. More...
 
QDomElement getServiceIdentificationElement (QDomDocument &doc, const QgsProject *project)
 Create Service Identification element for get capabilities document. More...
 
QDomElement getServiceProviderElement (QDomDocument &doc, const QgsProject *project)
 Create Service Provider element for get capabilities document. More...
 
QString implementationVersion ()
 Returns the highest version supported by this implementation. More...
 
QgsVectorLayer * layerByTypeName (const QgsProject *project, const QString &typeName)
 Retrieve a layer by typename. More...
 
QString layerTypeName (const QgsMapLayer *layer)
 Returns typename from vector layer. More...
 
transactionDelete parseDeleteActionElement (QDomElement &actionElem, const QgsProject *project)
 Transform Delete element to transactionDelete. More...
 
QgsFeatureRequest parseFilterElement (const QString &typeName, QDomElement &filterElem, QgsProject *project=nullptr)
 Transform a Filter element to a feature request. More...
 
QgsFeatureRequest parseFilterElement (const QString &typeName, QDomElement &filterElem, QStringList &serverFids, const QgsProject *project=nullptr, const QgsMapLayer *layer=nullptr)
 Transform a Filter element to a feature request and update server feature ids. More...
 
getFeatureRequest parseGetFeatureParameters (const QgsProject *project=nullptr)
 Transform parameters to getFeatureRequest. More...
 
getFeatureRequest parseGetFeatureRequestBody (QDomElement &docElem, const QgsProject *project=nullptr)
 Transform RequestBody root element to getFeatureRequest. More...
 
transactionInsert parseInsertActionElement (QDomElement &actionElem)
 Transform Insert element to transactionInsert. More...
 
getFeatureQuery parseQueryElement (QDomElement &queryElem, const QgsProject *project=nullptr)
 Transform Query element to getFeatureQuery. More...
 
void parseSortByElement (QDomElement &sortByElem, QgsFeatureRequest &featureRequest, const QString &typeName)
 Add SortBy element to featureRequest. More...
 
transactionRequest parseTransactionParameters (QgsServerRequest::Parameters parameters, const QgsProject *project)
 
transactionRequest parseTransactionRequestBody (QDomElement &docElem, const QgsProject *project)
 Transform RequestBody root element to getFeatureRequest. More...
 
transactionUpdate parseUpdateActionElement (QDomElement &actionElem, const QgsProject *project)
 Transform Update element to transactionUpdate. More...
 
void performTransaction (transactionRequest &aRequest, QgsServerInterface *serverIface, const QgsProject *project)
 Perform the transaction. More...
 
QString serviceUrl (const QgsServerRequest &request, const QgsProject *project, const QgsServerSettings &settings)
 Service URL string. More...
 
void writeDescribeFeatureType (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output WFS GetCapabilities response. More...
 
void writeGetCapabilities (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output WFS GetCapabilities response. More...
 
void writeGetFeature (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output WFS GetFeature response. More...
 
void writeTransaction (QgsServerInterface *serverIface, const QgsProject *project, const QString &version, const QgsServerRequest &request, QgsServerResponse &response)
 Output WFS transaction response. More...
 

Variables

const QString GML_NAMESPACE = QStringLiteral( "http://www.opengis.net/gml" )
 
const QString OGC_NAMESPACE = QStringLiteral( "http://www.opengis.net/ogc" )
 
const QString QGS_NAMESPACE = QStringLiteral( "http://www.qgis.org/gml" )
 
const QString WFS_NAMESPACE = QStringLiteral( "http://www.opengis.net/wfs" )
 

Detailed Description

WMS implementation.

WMS implementation

Function Documentation

◆ createGetCapabilitiesDocument()

QDomDocument QgsWfs::createGetCapabilitiesDocument ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request 
)

Create get capabilities document.

Definition at line 73 of file qgswfsgetcapabilities.cpp.

◆ createTransactionDocument()

QDomDocument QgsWfs::createTransactionDocument ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request 
)

Create a wfs transaction document.

Definition at line 64 of file qgswfstransaction.cpp.

◆ featuresFromGML()

QgsFeatureList QgsWfs::featuresFromGML ( QDomNodeList  featureNodeList,
QgsVectorLayer *  layer 
)

Transform GML feature nodes to features.

Definition at line 789 of file qgswfstransaction.cpp.

◆ getFeatureTypeListElement()

QDomElement QgsWfs::getFeatureTypeListElement ( QDomDocument &  doc,
QgsServerInterface *  serverIface,
const QgsProject *  project 
)

Create FeatureTypeList element for get capabilities document.

Definition at line 428 of file qgswfsgetcapabilities.cpp.

◆ getFieldAttributes()

void QgsWfs::getFieldAttributes ( const QgsField &  field,
QString &  fieldName,
QString &  fieldType 
)

Helper for returning the field type and type name.

Definition at line 103 of file qgswfsdescribefeaturetype.cpp.

◆ getOperationsMetadataElement()

QDomElement QgsWfs::getOperationsMetadataElement ( QDomDocument &  doc,
const QgsProject *  project,
const QgsServerRequest &  request,
const QgsServerSettings *  settings 
)

Create OperationsMetadata element for get capabilities document.

Definition at line 345 of file qgswfsgetcapabilities.cpp.

◆ getParameterElement()

QDomElement QgsWfs::getParameterElement ( QDomDocument &  doc,
const QString &  name,
const QStringList &  values 
)

Create a parameter element.

Definition at line 329 of file qgswfsgetcapabilities.cpp.

◆ getRequestTypeNames()

QStringList QgsWfs::getRequestTypeNames ( const QgsServerRequest &  request,
const QgsWfsParameters &  wfsParams 
)

Helper for returning typename list from the request.

Definition at line 68 of file qgswfsdescribefeaturetype.cpp.

◆ getServiceIdentificationElement()

QDomElement QgsWfs::getServiceIdentificationElement ( QDomDocument &  doc,
const QgsProject *  project 
)

Create Service Identification element for get capabilities document.

Definition at line 167 of file qgswfsgetcapabilities.cpp.

◆ getServiceProviderElement()

QDomElement QgsWfs::getServiceProviderElement ( QDomDocument &  doc,
const QgsProject *  project 
)

Create Service Provider element for get capabilities document.

Definition at line 240 of file qgswfsgetcapabilities.cpp.

◆ implementationVersion()

QString QgsWfs::implementationVersion ( )

Returns the highest version supported by this implementation.

Definition at line 31 of file qgswfsutils.cpp.

◆ layerByTypeName()

QgsVectorLayer * QgsWfs::layerByTypeName ( const QgsProject *  project,
const QString &  typeName 
)

Retrieve a layer by typename.

Definition at line 77 of file qgswfsutils.cpp.

◆ layerTypeName()

QString QgsWfs::layerTypeName ( const QgsMapLayer *  layer)

Returns typename from vector layer.

Definition at line 68 of file qgswfsutils.cpp.

◆ parseDeleteActionElement()

transactionDelete QgsWfs::parseDeleteActionElement ( QDomElement &  actionElem,
const QgsProject *  project 
)

Transform Delete element to transactionDelete.

Definition at line 1158 of file qgswfstransaction.cpp.

◆ parseFilterElement() [1/2]

QgsFeatureRequest QgsWfs::parseFilterElement ( const QString &  typeName,
QDomElement &  filterElem,
QgsProject *  project 
)

Transform a Filter element to a feature request.

Definition at line 100 of file qgswfsutils.cpp.

◆ parseFilterElement() [2/2]

QgsFeatureRequest QgsWfs::parseFilterElement ( const QString &  typeName,
QDomElement &  filterElem,
QStringList &  serverFids,
const QgsProject *  project,
const QgsMapLayer *  layer 
)

Transform a Filter element to a feature request and update server feature ids.

Definition at line 107 of file qgswfsutils.cpp.

◆ parseGetFeatureParameters()

getFeatureRequest QgsWfs::parseGetFeatureParameters ( const QgsProject *  project)

Transform parameters to getFeatureRequest.

Definition at line 518 of file qgswfsgetfeature.cpp.

◆ parseGetFeatureRequestBody()

getFeatureRequest QgsWfs::parseGetFeatureRequestBody ( QDomElement &  docElem,
const QgsProject *  project 
)

Transform RequestBody root element to getFeatureRequest.

Definition at line 913 of file qgswfsgetfeature.cpp.

◆ parseInsertActionElement()

transactionInsert QgsWfs::parseInsertActionElement ( QDomElement &  actionElem)

Transform Insert element to transactionInsert.

Definition at line 1247 of file qgswfstransaction.cpp.

◆ parseQueryElement()

getFeatureQuery QgsWfs::parseQueryElement ( QDomElement &  queryElem,
const QgsProject *  project 
)

Transform Query element to getFeatureQuery.

Definition at line 979 of file qgswfsgetfeature.cpp.

◆ parseSortByElement()

void QgsWfs::parseSortByElement ( QDomElement &  sortByElem,
QgsFeatureRequest &  featureRequest,
const QString &  typeName 
)

Add SortBy element to featureRequest.

Definition at line 931 of file qgswfsgetfeature.cpp.

◆ parseTransactionParameters()

transactionRequest QgsWfs::parseTransactionParameters ( QgsServerRequest::Parameters  parameters,
const QgsProject *  project 
)

Definition at line 861 of file qgswfstransaction.cpp.

◆ parseTransactionRequestBody()

transactionRequest QgsWfs::parseTransactionRequestBody ( QDomElement &  docElem,
const QgsProject *  project 
)

Transform RequestBody root element to getFeatureRequest.

Definition at line 1124 of file qgswfstransaction.cpp.

◆ parseUpdateActionElement()

transactionUpdate QgsWfs::parseUpdateActionElement ( QDomElement &  actionElem,
const QgsProject *  project 
)

Transform Update element to transactionUpdate.

Definition at line 1187 of file qgswfstransaction.cpp.

◆ performTransaction()

void QgsWfs::performTransaction ( transactionRequest &  aRequest,
QgsServerInterface *  serverIface,
const QgsProject *  project 
)

Perform the transaction.

Definition at line 219 of file qgswfstransaction.cpp.

◆ serviceUrl()

QString QgsWfs::serviceUrl ( const QgsServerRequest &  request,
const QgsProject *  project,
const QgsServerSettings &  settings 
)

Service URL string.

Definition at line 36 of file qgswfsutils.cpp.

◆ writeDescribeFeatureType()

void QgsWfs::writeDescribeFeatureType ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request,
QgsServerResponse &  response 
)

Output WFS GetCapabilities response.

Definition at line 37 of file qgswfsdescribefeaturetype.cpp.

◆ writeGetCapabilities()

void QgsWfs::writeGetCapabilities ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request,
QgsServerResponse &  response 
)

Output WFS GetCapabilities response.

Definition at line 39 of file qgswfsgetcapabilities.cpp.

◆ writeGetFeature()

void QgsWfs::writeGetFeature ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request,
QgsServerResponse &  response 
)

Output WFS GetFeature response.

Definition at line 100 of file qgswfsgetfeature.cpp.

◆ writeTransaction()

void QgsWfs::writeTransaction ( QgsServerInterface *  serverIface,
const QgsProject *  project,
const QString &  version,
const QgsServerRequest &  request,
QgsServerResponse &  response 
)

Output WFS transaction response.

Definition at line 53 of file qgswfstransaction.cpp.

Variable Documentation

◆ GML_NAMESPACE

const QString QgsWfs::GML_NAMESPACE = QStringLiteral( "http://www.opengis.net/gml" )

Definition at line 73 of file qgswfsutils.h.

◆ OGC_NAMESPACE

const QString QgsWfs::OGC_NAMESPACE = QStringLiteral( "http://www.opengis.net/ogc" )

Definition at line 74 of file qgswfsutils.h.

◆ QGS_NAMESPACE

const QString QgsWfs::QGS_NAMESPACE = QStringLiteral( "http://www.qgis.org/gml" )

Definition at line 75 of file qgswfsutils.h.

◆ WFS_NAMESPACE

const QString QgsWfs::WFS_NAMESPACE = QStringLiteral( "http://www.opengis.net/wfs" )

Definition at line 72 of file qgswfsutils.h.

Generated on Sun Mar 5 2023 20:41:05 for QGIS API Documentation by doxygen 1.9.4