CLAM-Development  1.4.0
XMLable.hxx
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2001-2004 MUSIC TECHNOLOGY GROUP (MTG)
3  * UNIVERSITAT POMPEU FABRA
4  *
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  *
20  */
21 
23 // Class XMLable: Interface for objects to be stored on a XMLStorage
25 // Description:
26 // Abstract class that defines the interface a object needs to be stored on
27 // a XMLStorage. An XML storage will need the information offered by those
28 // methods in order to know the XML structure.
30 
31 #ifndef _XMLable_
32 #define _XMLable_
33 
34 #include "Storable.hxx"
35 #include <string>
36 
37 namespace CLAM {
38 
46 class XMLable : public Storable {
47 // Construction/Destruction
48 public:
49  virtual ~XMLable();
50 // Redifinible methods
51 public:
52  //* @return A pointer to the XMLName
53  virtual const char * XMLName() const =0;
54  //* @return A string with the extracted XML content
55  virtual std::string XMLContent() const =0;
56  //* @TODO Implement this
57  virtual bool XMLContent(std::istream & contentHolder)=0;
58  //* @return Whether the object represents an XML attribute or not
59  virtual bool IsXMLAttribute() const =0;
60  //* @return Whether the object represents an XML element or not
61  virtual bool IsXMLElement() const =0;
62  //* @return Whether the object represents an XML text or not
63  virtual bool IsXMLText() const =0;
64 };
65 
66 }
67 
68 #endif//_XMLable_
69