AbstractWriter.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 terralib/xml/AbstractWriter.h
   
  \brief This class models a XML writer object.
*/

#ifndef __TERRALIB_XML_INTERNAL_ABSTRACTWRITER_H
#define __TERRALIB_XML_INTERNAL_ABSTRACTWRITER_H

// TerraLib
#include "Config.h"

// STL
#include <string>

// Boost
#include <boost/cstdint.hpp>

namespace te
{
  namespace xml
  {
    /*!
      \class AbstractWriter

      \brief This class models a XML writer object.

      \ingroup xml
    */
    class TEXMLEXPORT AbstractWriter
    {
      public:

        /*! \brief Constructor. */
        AbstractWriter();

        /*! \brief Virtual destructor. */
        virtual ~AbstractWriter();

        virtual void writeStartDocument(const std::string& encoding, const std::string& standalone) = 0;

        virtual void writeStartElement(const std::string& qName) = 0;

        virtual void writeElement(const std::string& qName, const std::string& value) = 0;

        virtual void writeElement(const std::string& qName, const double& value) = 0;

        virtual void writeElement(const std::string& qName, boost::int32_t value) = 0;

        virtual void writeElement(const std::string& qName, boost::uint32_t value) = 0;

        virtual void writeElement(const std::string& qName, boost::int64_t value) = 0;

        virtual void writeElement(const std::string& qName, boost::uint64_t value) = 0;

        virtual void writeAttribute(const std::string& attName, const std::string& value) = 0;

        virtual void writeAttribute(const std::string& attName, const double& value) = 0;

        virtual void writeAttribute(const std::string& attName, boost::int32_t value) = 0;

        virtual void writeAttribute(const std::string& attName, boost::uint32_t value) = 0;

        virtual void writeAttribute(const std::string& attName, boost::int64_t value) = 0;

        virtual void writeAttribute(const std::string& attName, boost::uint64_t value) = 0;

        virtual void writeValue(const std::string& value) = 0;

        virtual void writeValue(const double& value) = 0;

        virtual void writeValue(boost::int32_t value) = 0;

        virtual void writeValue(boost::uint32_t value) = 0;

        virtual void writeValue(boost::int64_t value) = 0;

        virtual void writeValue(boost::uint64_t value) = 0;

        virtual void writeEndElement(const std::string& qName) = 0;

        virtual void writeToFile() = 0;

        /*!
          \brief Gets the XML content in a std::string format

          \exception Exception It throws an exception if the content cannot be read
        */
        virtual std::string getContent() = 0;

        void setRootNamespaceURI(const std::string& uri);

        void setURI(const std::string& uri);

      protected:

        std::string m_uri;
        std::string m_rootNamespaceUri;
    };

  } // end namespace xml
}   // end namespace te

#endif  // __TERRALIB_XML_INTERNAL_ABSTRACTWRITER_H