---

xmlUtil::Substitute Class Reference

#include <Substitute.h>

List of all members.

Public Methods
	Substitute::Substitute (DOM_Document doc, std::string suffix=std::string("REF"))
int	execute (DOM_Element treeTop)
	~Substitute ()
	Destructor. More...
Private Methods
void	sub (DOM_Element elt)
Private Attributes
DOM_Document	m_doc
int	m_count
std::string	m_suffix
int	m_suffixLen
int	m_notFound

---

Detailed Description

The Substitute class will look up references to values (in attributes of type IDREF in a given subtree of a document) and replace the attribute with another that has as value the value of the reference. e.g., ... XREF="CsiLength" could get replaced by ... X = "33.12"

Definition at line 20 of file Substitute.h.

---

Constructor & Destructor Documentation

xmlUtil::Substitute::~Substitute (    )  [inline]

Destructor. Definition at line 44 of file Substitute.h. {};

---

Member Function Documentation

int xmlUtil::Substitute::execute (  DOM_Element    top )

Do substitution for the subtree indicated, returning count. execute may be invoked repeatedly for different subtrees of the source document. Parameters: treeTop  the root of the subtree for which substitutions are to be performed. Definition at line 20 of file Substitute.cxx. References m_count, m_doc, and sub(). Referenced by main(). { // Get rid of some inefficiency by means of the following imperfect // mechanism: // An element may have an attribute called "substituted". If it // does, the attribute always has a default value of "false". // The execute method looks for the attribute. If it is there and // has value "true", substitution has already been done, so just // return. If the attribute has value "false" or doesn't exist, // go ahead and do the substitution. Afterwards, if the attribute // exists set its value to "true", but don't add any new attributes. // Also as a matter of course always check the root element for // a "substituted" attribute. // // If an element and its descendent *both* have the substituted // attribute, only the one passed to execute will have its substitute // attribute examined and possibly changed. This means it's possible // for an element to have a "substituted" attribute value of "false" // when it really should be "true", but never the other way around. // DOM_Element docElt = m_doc.getDocumentElement(); if ((docElt.getAttribute("substituted")).equals(DOMString("true"))) return 0; if ((top.getAttribute("substituted")).equals(DOMString("true"))) return 0; DOM_Node curNode = top; // This is not explained anywhere in the xerces doc. that I // can see, but from the code in TreeWalkerImpl::acceptNode // this would seem to be the right value for whatToShow unsigned long whatToShow = 1 << (DOM_Node::ELEMENT_NODE -1); DOM_TreeWalker walker = m_doc.createTreeWalker(top, whatToShow, 0, 0); m_count = 0; while (curNode != DOM_Node() ) { sub(static_cast<DOM_Element &> (curNode)); curNode = walker.nextNode(); } DOM_Attr subNode = top.getAttributeNode("substituted"); if (subNode != DOM_Attr()) { subNode.setValue("true"); } return m_count; }

void xmlUtil::Substitute::sub (  DOM_Element    elt )  [private]

Handle a single element (invoked from public execute method) Definition at line 65 of file Substitute.cxx. References m_count, m_doc, m_notFound, m_suffix, and m_suffixLen. Referenced by execute(). { DOM_NamedNodeMap attMap = elt.getAttributes(); int nAtt = attMap.getLength(); int iAtt; std::vector<DOMString> toProcess; std::vector<unsigned> toProcessPos; // std::vector<DOM_Node> toDelete; for (iAtt = 0; iAtt <nAtt; iAtt++) { DOM_Node att = attMap.item(iAtt); // if (att != DOM_Node()) { // probably not necessary DOMString attString = att.getNodeName(); std::string attName = std::string(xml::Dom::transToChar(attString)); // Look for suffix unsigned pos = attName.find(m_suffix, attName.size() - m_suffixLen); if (pos < attName.size()) { // found toProcess.push_back(attString); toProcessPos.push_back(pos); } } // Now process by name while (toProcess.size() > 0) { DOMString oldAttString = toProcess.back(); std::string oldAttName = std::string(xml::Dom::transToChar(oldAttString)); unsigned pos = toProcessPos.back(); toProcess.pop_back(); toProcessPos.pop_back(); DOM_Element constElt = m_doc.getElementById(elt.getAttribute(oldAttString)); if (constElt == DOM_Element() ) { // shouldn't happen m_notFound++; continue; } // Build the new attribute DOMString val = constElt.getAttribute(DOMString("value")); // If the element referred to is a <prim>, we should be done // because it always has a value. If it's a <const> // we may have to evaluate it. if (val == DOMString()) { // try evaluating it Arith curArith(constElt); double evalValue = curArith.evaluate(); curArith.saveValue(); val = constElt.getAttribute(DOMString("value")); } std::string newAttName = oldAttName.erase(pos, oldAttName.size() ); elt.setAttribute(DOMString(newAttName.c_str()), val); elt.removeAttribute(oldAttString); m_count++; } // Now delete each saved attribute node // while (toDelete.size() > 0) { // DOM_Node att = toDelete.back(); // toDelete.pop_back(); // elt.removeAttributeNode(static_cast <DOM_Attr &>(att)); // } }

xmlUtil::Substitute::Substitute::Substitute (  DOM_Document    doc, std::string    suffix = std::string("REF") )

A Substitute object is configured by specifying the document in which substitutions are to occur and the suffix which will be used to find attributes for which substitutions are requested. Parameters: doc  The document for which substitutions are to be performed suffix  The suffix which identitifies references in the source docoument (defaults to "REF")

---

Member Data Documentation

int xmlUtil::Substitute::m_count [private]

Keep track of #subs done for one execute Definition at line 48 of file Substitute.h. Referenced by execute(), and sub().

DOM_Document xmlUtil::Substitute::m_doc [private]

Document on which substitutions may be done Definition at line 47 of file Substitute.h. Referenced by execute(), and sub().

int xmlUtil::Substitute::m_notFound [private]

count of id's not found-- shouldn't happen Definition at line 51 of file Substitute.h. Referenced by sub().

std::string xmlUtil::Substitute::m_suffix [private]

Suffix identifying references Definition at line 49 of file Substitute.h. Referenced by sub().

int xmlUtil::Substitute::m_suffixLen [private]

Definition at line 50 of file Substitute.h. Referenced by sub().

---

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

• Substitute.h
• Substitute.cxx

---