| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

IXmlParserSvc Class Reference

this interface defines a DOM XmlParser service More...

#include <DetDescCnv/IXmlParserSvc.h>

Inheritance diagram for IXmlParserSvc:

[legend]
Collaboration diagram for IXmlParserSvc:
[legend]
List of all members.

Public Types

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR
enum  Status

Public Member Functions

virtual IOVDOMDocumentparse (const char *fileName)=0
 This method parses an xml file and produces the corresponding DOM document.
virtual IOVDOMDocumentparseString (std::string source)=0
 This method parses XML from a string and produces the corresponding DOM document.
virtual void clearCache ()=0
 This clears the cache of previously parsed xml files.
virtual void releaseDoc (IOVDOMDocument *doc)=0
 Method to remove the lock from a document in the cache or to delete the document generated from a string.
virtual StatusCode queryInterface (const InterfaceID &riid, void **ppvInterface)=0
virtual unsigned long addRef ()=0
virtual unsigned long release ()=0

Static Public Member Functions

static const InterfaceIDinterfaceID ()
 Retrieve interface ID.

Public Attributes

 SUCCESS
 NO_INTERFACE
 VERSMISMATCH
 LAST_ERROR

Detailed Description

this interface defines a DOM XmlParser service

Author:
Sebastien Ponce

Marco Clemencic

Definition at line 23 of file IXmlParserSvc.h.


Member Function Documentation

static const InterfaceID& IXmlParserSvc::interfaceID (  )  [inline, static]

Retrieve interface ID.

Reimplemented from IInterface.

Reimplemented in IXmlSvc.

Definition at line 28 of file IXmlParserSvc.h.

00028 { return IID_IXmlParserSvc; }

virtual IOVDOMDocument* IXmlParserSvc::parse ( const char *  fileName  )  [pure virtual]

This method parses an xml file and produces the corresponding DOM document.

The actual document is kept in a cache and locked. The user must call IXmlParserSvc::releaseDoc() when he does not need anymore the document.

Parameters:
fileName the name of the file to parse
Returns:
the document issued from the parsing

virtual IOVDOMDocument* IXmlParserSvc::parseString ( std::string  source  )  [pure virtual]

This method parses XML from a string and produces the corresponding DOM document.

Like for the DOMDocument generated from a file, this one has to be released with IXmlParserSvc::releaseDoc() too.

Parameters:
source the string to parse
Returns:
the document issued from the parsing

virtual void IXmlParserSvc::clearCache (  )  [pure virtual]

This clears the cache of previously parsed xml files.

virtual void IXmlParserSvc::releaseDoc ( IOVDOMDocument doc  )  [pure virtual]

Method to remove the lock from a document in the cache or to delete the document generated from a string.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Mon Apr 11 20:00:37 2011 for XmlTools by doxygen 1.4.7