XMLComponentAdapter.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
 *
 */

// Class XMLComponentAdapter
// 

#ifndef _XMLComponentAdapter_h
#define _XMLComponentAdapter_h
#include "BasicXMLable.hxx"
#include "Component.hxx"
#include "Assert.hxx"

namespace CLAM {

class XMLComponentAdapter : public BasicXMLable , public Component {
// Internal Types
public:
        typedef BasicXMLable super;
// Attributes
private:
        Component &myAdaptee;
// Construction/Destruction
public:
        template <class T> XMLComponentAdapter (const T & adaptee, const char * name=NULL, bool isXMLElement=false)
                : BasicXMLable(name, isXMLElement), myAdaptee(const_cast<T&>(adaptee))
        {
                CLAM_ASSERT(!name||isXMLElement,"Adapting a component as attribute is useless");
        }
        virtual ~XMLComponentAdapter() {};

// Accessors (for XMLable interface)
public:
        //* @return The XML content: an empty string.
        virtual std::string XMLContent() const
        {
                return "";
        }

        //* Extracts the content from the stream.
        virtual bool XMLContent(std::istream & str) 
        {
                return true;
        }

        //* Returns the class name
        const char * GetClassName() const {return "XMLComponentAdapter";}

// Operators (for Component interface)
public:
        virtual void StoreOn (Storage & store) const {
                myAdaptee.StoreOn(store);
        };
        virtual void LoadFrom (Storage & store) {
                myAdaptee.LoadFrom(store);
        };
// Testing
public:
        //* Check the internal status for a class instance is valid
        bool FulfilsInvariant();
};

}

#endif//_XMLComponentAdapter_h