XMLStorage.hxx

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
 *                         UNIVERSITAT POMPEU FABRA
 *
 *
 * 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

// XMLStorage.cxx
// Description: A storage in XML format for CLAM objects

#ifndef _XMLStorage_hxx_
#define _XMLStorage_hxx_

#include "Storage.hxx"
#include "XmlStorageErr.hxx"
#include <iosfwd>
#include <string>


namespace CLAM
{

class XMLable;
class Component;
class DomDocumentHandler;


class XmlStorage : public Storage
{
        DomDocumentHandler * _documentHandler;
        bool _lastWasContent;
        bool _useIndentation;
        std::string _errors;
// @{
public:
        XmlStorage();
        ~XmlStorage();

public:
        void Read(std::istream & is); 
        void Create(const std::string & name); 
        void WriteSelection(std::ostream & os); 
        void WriteDocument(std::ostream & os); 
        void DumpObject(const Component & component); 
        void RestoreObject(Component & component); 

        void Select(const std::string & path); 

        void UseIndentation(bool useIndentation);
// @}

// @{
public:

        static void Dump(const Component & obj, const std::string & rootName, std::ostream & os, bool indentate=true)
        {
                XmlStorage storage;
                storage.Create(rootName);
                storage.DumpObject(obj);
                storage.UseIndentation(indentate);
                storage.WriteDocument(os);
        }

        static void Restore(Component & obj, std::istream & is)
        {
                XmlStorage storage;
                storage.Read(is);
                storage.RestoreObject(obj);
        }

        static void RestoreFromFragment(Component & obj, const std::string & path, std::istream & is)
        {
                XmlStorage storage;
                storage.Read(is);
                storage.Select(path);
                storage.RestoreObject(obj);
        }

        static void AppendToDocument(const Component & obj, const std::string & xpath, const std::string & filename);

        static void Dump(const Component & obj, const std::string & rootName, const std::string & filename);

        static void Restore(Component & obj, const std::string & filename);
// @}

// @{
public:
        void Store(const Storable & storable);
        bool Load(Storable & storable);
// @}

// Private helper functions
private:
        bool LoadContentAndChildren(XMLable* xmlable);
        void StoreContentAndChildren(const XMLable * xmlable);
        void StoreChildrenIfComponent(const XMLable * xmlable);
        void AddContentToElement(const std::string & content);

};

typedef XmlStorage XMLStorage;

} // namespace CLAM



#endif//_XMLStorage_hxx_