Base/DataFormat.hpp

Go to the documentation of this file.

/* 
 * DataFormat.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * This library 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 2 of the License, or (at your option) any later version.
 *
 * This library 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 this library; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_BASE_DATAFORMAT_HPP
#define CDPL_BASE_DATAFORMAT_HPP
 
#include <cstddef>
#include <string>
#include <vector>
 
#include "CDPL/Base/APIPrefix.hpp"
 
 
namespace CDPL
{
 
    namespace Base
    {
 
        class CDPL_BASE_API DataFormat
        {
 
            typedef std::vector<std::string> FileExtensionList;
 
          public:
            typedef FileExtensionList::const_iterator ConstFileExtensionIterator;
 
            typedef FileExtensionList::iterator FileExtensionIterator;
 
            template <typename Iter>
            DataFormat(const std::string& name, const std::string& descr, const std::string& mime_type,
                       Iter file_ext_begin, Iter file_ext_end, bool multi_rec):
                name(name),
                description(descr), mimeType(mime_type), fileExtensions(file_ext_begin, file_ext_end),
                multiRecordFormat(multi_rec)
            {}
 
            DataFormat():
                multiRecordFormat(false) {}
 
            const std::string& getDescription() const;
 
            void setDescription(const std::string& descr);
 
            const std::string& getName() const;
 
            void setName(const std::string& name);
 
            const std::string& getMimeType() const;
 
            void setMimeType(const std::string& mime_type);
 
            std::size_t getNumFileExtensions() const;
 
            ConstFileExtensionIterator getFileExtensionsBegin() const;
 
            ConstFileExtensionIterator getFileExtensionsEnd() const;
 
            FileExtensionIterator getFileExtensionsBegin();
 
            FileExtensionIterator getFileExtensionsEnd();
 
            ConstFileExtensionIterator begin() const;
 
            ConstFileExtensionIterator end() const;
 
            FileExtensionIterator begin();
 
            FileExtensionIterator end();
 
            DataFormat& addFileExtension(const std::string& file_ext);
 
            const std::string& getFileExtension(std::size_t idx) const;
 
            void setFileExtension(std::size_t idx, const std::string& file_ext);
 
            void removeFileExtension(std::size_t idx);
 
            FileExtensionIterator removeFileExtension(const FileExtensionIterator& it);
 
            void clearFileExtensions();
 
            bool isMultiRecordFormat() const;
 
            void setMultiRecordFormat(bool multi_rec);
 
            bool matchesName(const std::string& name) const;
 
            bool matchesMimeType(const std::string& mime_type) const;
 
            bool matchesFileExtension(const std::string& file_ext) const;
 
            bool operator==(const DataFormat& fmt) const;
 
            bool operator!=(const DataFormat& fmt) const;
 
          private:
            std::string       name;
            std::string       description;
            std::string       mimeType;
            FileExtensionList fileExtensions;
            bool              multiRecordFormat;
        };
    } // namespace Base
} // namespace CDPL
 
#endif // CDPL_BASE_DATAFORMAT_HPP