MakeGeometryValid.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

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

    TerraLib is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
 \file MakeGeometryValid.h
 
 \brief Functions to make geometry valid.
 
 \ingroup vp
 */

#ifndef __TERRALIB_VP_INTERNAL_MAKEGEOMETRYVALID_H
#define __TERRALIB_VP_INTERNAL_MAKEGEOMETRYVALID_H

//Terralib

#include "../common/Static.h"

#include "../dataaccess/datasource/DataSource.h"
#include "../dataaccess/dataset/ObjectIdSet.h"

#include "Config.h"

namespace te
{
  namespace vp
  {
    /*!
      \class MakeGeometryValid

      \brief A static class with methods to make geometry valid.
    */
    class TEVPEXPORT MakeGeometryValid : public te::common::Static
    {
      public:

      /*!
        \brief  This method gets the datasource capabilities and calls the specific function to fix geometry.

        \param dataSource The data source information.
        \param dataSetName The input data name.
        \param errorMessage Variable to catch any error occurred during execution.
        \param oidSet Set of object ids to filter iconsistent geometries.

        \return True, if the function was executed successfully and the geometries fixed was updated.
      */
       static bool makeValid(const te::da::DataSourcePtr dataSource,
                             const std::string& dataSetName,
                             std::string& errorMessage,
                             te::da::ObjectIdSet* oidSet = 0);

      private:

        /*!
          \brief  It tries to fix invalid geometry by SQL clause ST_MakeValid and updates the source data.

          \param dataSource The data source information.
          \param dataSetName The input data name.
          \param errorMessage Variable to catch any error occurred during execution.

          \return True, if the query was executed successfully and the geometries fixed was updated.

          \note The layer must be inserted in a database with spatial extent.
        */
        static bool makeValidQuery(const te::da::DataSourcePtr dataSource,
                                   const std::string& dataSetName,
                                   std::string& errorMessage,
                                   te::da::ObjectIdSet* oidSet = 0);

        /*!
          \brief  It tries to fix invalid geometry by GEOS and updates the source data.

          \param dataSource The data source information.
          \param dataSetName The input data name.
          \param errorMessage Variable to catch any error occurred during execution.

          \return True, if the query was executed successfully and the geometries fixed was updated.
        */
        static bool makeValidMemory(const te::da::DataSourcePtr dataSource,
                                    const std::string& dataSetName,
                                    std::string& errorMessage,
                                    te::da::ObjectIdSet* oidSet = 0);
    };
  }
}
#endif // __TERRALIB_VP_INTERNAL_MAKEGEOMETRYVALID_H