xmlBase::DocMan Class Reference

DocMan allows different clients to share a single xml document. More...

#include <DocMan.h>

Classes
class	ClientList
	Nested class to keep track of clients for one element type. More...

Public Member Functions
virtual bool	parse (const std::string &filename, const std::string &docType=std::string(""))
virtual bool	regClient (const std::string &eltName, DocClient *client)

Static Public Member Functions
static DocMan *	getPointer ()
	Implements singleton.

Protected Member Functions
	DocMan ()
virtual	~DocMan ()
bool	regMeFirst (DocClient *client)
	Register privileged client; only available to derived classes.
ClientList *	findList (const std::string &eltName)

Detailed Description

DocMan allows different clients to share a single xml document.

Clients may sign up to handle particular child elements (direct children only of the root element). Then when the DocMan object (there is only one: it's a singleton) is asked to parse a file it

• invokes Xerces to build the DOM
• calls back each registered client for first-generation children of the root element
• resets the parser, which releases the memory for the DOM and readies the parser to parse another document DocMan can also be used as a base class for document managers which know something about a particular docType.

Definition at line 31 of file DocMan.h.

Constructor & Destructor Documentation

DocMan()

xmlBase::DocMan::DocMan ( )

protected

Definition at line 16 of file DocMan.cxx.

                 {
    m_self = this;
    m_meFirst = 0;
    m_parser = new xmlBase::XmlParser();
  }

Referenced by getPointer().

~DocMan()

xmlBase::DocMan::~DocMan ( )

protectedvirtual

Definition at line 119 of file DocMan.cxx.

                  {
    ListsIt it = m_lists.begin();
    while (it != m_lists.end()) {
      delete (*it);
      ++it;
    }
    delete m_parser;
  }

Member Function Documentation

findList()

DocMan::ClientList * xmlBase::DocMan::findList ( const std::string &  eltName )

protected

Definition at line 75 of file DocMan.cxx.

                                                             {
    unsigned int ix;
 
    for (ix = 0; ix < m_lists.size(); ix++) {
      ClientList* cur = m_lists[ix];
      if (eltName.compare(cur->getName()) == 0) return cur;
    }
    return 0;
  }

Referenced by parse(), and regClient().

getPointer()

DocMan * xmlBase::DocMan::getPointer ( )

static

Implements singleton.

Definition at line 22 of file DocMan.cxx.

                             {
    if (m_self == 0) {
      m_self = new DocMan();
    }
    return m_self;
  }

parse()

bool xmlBase::DocMan::parse ( const std::string &  filename, const std::string &  docType = std::string("")  )

virtual

parse not only parses and creates DOM; it also calls back registered clients.

Return false if something goes wrong with the parse

Definition at line 29 of file DocMan.cxx.

                                                                        {
    //    using xercesc::DOMDocument;
    //    using xercesc::DOMElement;
 
    DOMDocument* doc = m_parser->parse(filename.c_str(), docType);
    if (doc == 0) return false;
 
    if (m_meFirst != 0) m_meFirst->handleChild(doc);
 
    DOMElement* root = doc->getDocumentElement();
 
    DOMElement* child = xmlBase::Dom::getFirstChildElement(root);
 
    while (child != 0) {
      std::string eltName = Dom::getTagName(child);
      if (m_meFirst != 0) m_meFirst->handleChild(child);
 
      ClientList* list = findList(eltName);
      if (list) list->invoke(child);
 
      child = xmlBase::Dom::getSiblingElement(child);
    }
 
    // Clean up call for privileged client
    if (m_meFirst != 0) m_meFirst->handleChild(0);
 
    m_parser->reset();
    return true;
  }

regClient()

bool xmlBase::DocMan::regClient ( const std::string &  eltName, DocClient *  client  )

virtual

Definition at line 59 of file DocMan.cxx.

                                                                    {
    ClientList* curList = findList(eltName);
    if (curList == 0) {
      curList = new ClientList(eltName);
      m_lists.push_back(curList);
    }
    return curList->add(client);
  }

regMeFirst()

bool xmlBase::DocMan::regMeFirst ( DocClient *  client )

protected

Register privileged client; only available to derived classes.

Definition at line 68 of file DocMan.cxx.

                                           {
    if (m_meFirst != 0)       return false;
 
    m_meFirst = client;
    return true;
  }

---

The documentation for this class was generated from the following files:

• DocMan.h
• DocMan.cxx