qgswfsparameters.h

Go to the documentation of this file.

/***************************************************************************
                              qgswfsparameters.h
                              ------------------
  begin                : Sept 14, 2017
  copyright            : (C) 2017 by René-Luc Dhont
  email                : rldhont at 3liz dot com
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QGSWFSPARAMETERS_H
#define QGSWFSPARAMETERS_H

#include <QMap>
#include <QObject>
#include <QMetaEnum>

#include "qgsrectangle.h"
#include "qgswfsserviceexception.h"
#include "qgsserverrequest.h"
#include "qgsprojectversion.h"
#include "qgsserverparameters.h"

namespace QgsWfs
{

  class QgsWfsParameter : public QgsServerParameterDefinition
  {
      Q_GADGET

    public:
      enum Name
      {
        UNKNOWN,
        OUTPUTFORMAT,
        RESULTTYPE,
        PROPERTYNAME,
        MAXFEATURES,
        STARTINDEX,
        SRSNAME,
        TYPENAME,
        FEATUREID,
        FILTER,
        BBOX,
        SORTBY,
        EXP_FILTER,
        GEOMETRYNAME
      };
      Q_ENUM( Name )

      
      QgsWfsParameter( const QgsWfsParameter::Name name = QgsWfsParameter::UNKNOWN,
                       const QVariant::Type type = QVariant::String,
                       const QVariant defaultValue = QVariant( "" ) );

      virtual ~QgsWfsParameter() = default;

      int toInt() const;

      QStringList toStringListWithExp( const QString &exp = "\\(([^()]+)\\)" ) const;

      QgsRectangle toRectangle() const;

      void raiseError() const;

      static QString name( const QgsWfsParameter::Name );

      static QgsWfsParameter::Name name( const QString &name );

      QgsWfsParameter::Name mName;
  };

  class QgsWfsParameters : public QgsServerParameters
  {
      Q_GADGET

    public:

      enum Format
      {
        NONE,
        GML2,
        GML3,
        GeoJSON,
        XSD
      };

      enum ResultType
      {
        RESULTS,
        HITS
      };

      QgsWfsParameters( const QgsServerParameters &parameters );

      QgsWfsParameters();

      virtual ~QgsWfsParameters() = default;

      void dump() const;

      QgsProjectVersion versionAsNumber() const;

      QString outputFormatAsString() const;

      Format outputFormat() const;

      QString resultTypeAsString() const;

      ResultType resultType() const;

      QStringList propertyNames() const;

      QString maxFeatures() const;

      int maxFeaturesAsInt() const;

      QString startIndex() const;

      int startIndexAsInt() const;

      QString srsName() const;

      QStringList typeNames() const;

      QStringList featureIds() const;

      QStringList filters() const;

      QString bbox() const;

      QgsRectangle bboxAsRectangle() const;

      QStringList sortBy() const;

      QStringList expFilters() const;

      QString geometryNameAsString() const;

    private:
      bool loadParameter( const QString &name, const QString &key ) override;
      void save( const QgsWfsParameter &parameter );

      void log( const QString &msg ) const;

      QList<QgsProjectVersion> mVersions;
      QMap<QgsWfsParameter::Name, QgsWfsParameter> mWfsParameters;
  };
}

#endif