xmlBase::DocMan Class Reference

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

#include <DocMan.h>

List of all members.

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)
Private Types
typedef std::vector< ClientList * >::const_iterator	ListsIt
Private Attributes
std::vector< ClientList * >	m_lists
XmlParser *	m_parser
DocClient *	m_meFirst
Static Private Attributes
static DocMan *	m_self = 0
Classes
class	ClientList
	Nested class to keep track of clients for one element type. More...

---

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.

---

Member Typedef Documentation

typedef std::vector<ClientList*>::const_iterator xmlBase::DocMan::ListsIt [private]

Definition at line 82 of file DocMan.h.

---

Constructor & Destructor Documentation

xmlBase::DocMan::DocMan

(

)

[protected]

Definition at line 16 of file DocMan.cxx.

References m_meFirst, m_parser, and m_self.

Referenced by getPointer().

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

xmlBase::DocMan::~DocMan

(

)

[protected, virtual]

Definition at line 119 of file DocMan.cxx.

References m_lists, and m_parser.

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

---

Member Function Documentation

DocMan::ClientList * xmlBase::DocMan::findList

(

const std::string &

eltName

)

[protected]

Definition at line 75 of file DocMan.cxx.

References m_lists.

Referenced by parse(), and regClient().

                                                             {
    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;
  }

DocMan * xmlBase::DocMan::getPointer

(

)

[static]

Implements singleton.

Definition at line 22 of file DocMan.cxx.

References DocMan(), and m_self.

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

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

Return false if something goes wrong with the parse

Definition at line 29 of file DocMan.cxx.

References findList(), xmlBase::Dom::getFirstChildElement(), xmlBase::Dom::getSiblingElement(), xmlBase::Dom::getTagName(), xmlBase::DocClient::handleChild(), xmlBase::DocMan::ClientList::invoke(), m_meFirst, m_parser, xmlBase::XmlParser::parse(), xmlBase::XmlParser::reset(), root, and deljobs::string.

                                                                        {
    //    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;
  }

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

Definition at line 59 of file DocMan.cxx.

References xmlBase::DocMan::ClientList::add(), findList(), and m_lists.

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

bool xmlBase::DocMan::regMeFirst

(

DocClient *

client

)

[protected]

Register privileged client; only available to derived classes.

Definition at line 68 of file DocMan.cxx.

References m_meFirst.

                                           {
    if (m_meFirst != 0)       return false;

    m_meFirst = client;
    return true;
  }

---

Member Data Documentation

std::vector<ClientList*> xmlBase::DocMan::m_lists [private]

Definition at line 81 of file DocMan.h.

Referenced by findList(), regClient(), and ~DocMan().

DocClient* xmlBase::DocMan::m_meFirst [private]

Definition at line 84 of file DocMan.h.

Referenced by DocMan(), parse(), and regMeFirst().

XmlParser* xmlBase::DocMan::m_parser [private]

Definition at line 83 of file DocMan.h.

Referenced by DocMan(), parse(), and ~DocMan().

XERCES_CPP_NAMESPACE_USE DocMan * xmlBase::DocMan::m_self = 0 [static, private]

Definition at line 80 of file DocMan.h.

Referenced by DocMan(), and getPointer().

---