databases::XMLImport Class Reference

XML import interface. More...

#include <xml.h>

Inheritance diagram for databases::XMLImport:

modules::ErrorInterface modules::Interface

List of all members.

Public Member Functions

virtual bool import_data (std::string const &dir, std::string const &database)=0
 Imports a database from an XML file.

Static Public Attributes

static
modules::PSIID const 
IID = 0x42e3f23f
 The interface identifier.


Detailed Description

This interface may be exposed by databases modules through the Module::factory() function to provide a mean for other modules, and the dbimport tool that may be provided with the program, to import XML databases so that they can be used by the corresponding database module normally.

The import_data() function must be overriden in derived classes.


Member Function Documentation

virtual bool databases::XMLImport::import_data ( std::string const &  dir,
std::string const &  database 
) [pure virtual]

Imports a database from an XML file. The tags used in the XML files are currently undocumented, sorry... But it is very straightforward and examining XML files generated by some of the "standard" database modules will probably get you started without having to read the source code ;). The XMLReader class may be used as a framework to make the task easier.

Parameters:
[in] dir The input directory for the XML file. If it is an empty string, the file is located in the current working directory.
[in] database The name of the database to import.
Returns:
true if successful, false otherwise (in that case, error() should return an appropriate error string describing the error.)


The documentation for this class was generated from the following file:
Generated on Fri Apr 18 22:03:28 2008 for Epona API by  doxygen 1.5.3