---

xmlUtil::IdConverter Class Reference

An IdConverter is a collection of id conversions and associated functions to (1) verify self-consistency of the converter (2) apply the correct conversion to a supplied Identifier. More...

#include <IdConverter.h>

List of all members.

Public Types
typedef std::vector< IdConversion *>	Conversions
typedef Conversions::iterator	ConversionIt
Public Methods
	IdConverter (DOM_Element elt)
	~IdConverter ()
std::ostream &	displayConversions (std::ostream &s)
NamedId *	convert (const NamedId *in) const
	Return the result of converting a single NamedId. More...
Identifier *	convert (const Identifier *inIdent) const
	Return the result of converting a single Identifier. More...
bool	isConsistent ()
Private Types
enum	STATES { UNKNOWN = -1, NO = 0, YES = 1 }
Private Methods
void	sortConvs ()
Private Attributes
std::string *	inputDictName
IdDict *	inputDict
std::string *	outputDictName
IdDict *	outputDict
Conversions	m_convCol
STATES	m_consistent
STATES	m_sorted
Static Private Attributes
IdDictMan *	dictMan = 0

---

Detailed Description

An IdConverter is a collection of id conversions and associated functions to (1) verify self-consistency of the converter (2) apply the correct conversion to a supplied Identifier.

Definition at line 20 of file IdConverter.h.

---

Member Typedef Documentation

typedef Conversions::iterator xmlUtil::IdConverter::ConversionIt

Definition at line 67 of file IdConverter.h. Referenced by sortConvs().

typedef std::vector<IdConversion*> xmlUtil::IdConverter::Conversions

Definition at line 66 of file IdConverter.h.

---

Member Enumeration Documentation

enum xmlUtil::IdConverter::STATES [private]

Enumeration values: UNKNOWN  NO  YES  Definition at line 88 of file IdConverter.h. { UNKNOWN = -1, NO = 0, YES = 1};

---

Constructor & Destructor Documentation

xmlUtil::IdConverter::IdConverter (  DOM_Element    elt )

Build IdConverter from its XML representation. Assume that the containing document has already been "normalized" in the sense that constants evaluation and substitution has been done. Definition at line 16 of file IdConverter.cxx. References dictMan, inputDict, inputDictName, isConsistent(), m_convCol, outputDict, and outputDictName. : m_consistent(UNKNOWN), m_sorted(NO) { if (!dictMan) dictMan = IdDictMan::getPointer(); // An idConverter element may optionally have as first child // a constants element, but we're assuming that the XML document // has already had constants evaluation and substitution done // on it, if necessary. // Assume that any constant evaluations and substitutions have // already been dealt with DOM_Element child = xml::Dom::getFirstChildElement(elt); if ( (child.getTagName()).equals(DOMString("constants")) ) { // move on child = xml::Dom::getSiblingElement(child); } while ( (child.getTagName()).equals(DOMString("idDict")) ) { IdDict* dict = new IdDict(child); dictMan->registerDict(dict); child = xml::Dom::getSiblingElement(child); } // Now that all id dictionaries we need should have been defined, // handle attributes std::string dictName = xml::Dom::getAttribute(elt, "fromDict"); if (dictName.size() > 0 ) { // then it's not just an empty string inputDictName = new std::string(dictName); inputDict = dictMan->findDict(dictName); } dictName = xml::Dom::getAttribute(elt, "toDict"); if (dictName.size() > 0 ) { outputDictName = new std::string(dictName); outputDict = dictMan->findDict(dictName); } // All remaining elements should be idConv while (child != DOM_Element() ) { IdConversion *conv = new IdConversion(child); m_convCol.push_back(conv); child = xml::Dom::getSiblingElement(child); } // check for consistency before unleashing this object isConsistent(); }

xmlUtil::IdConverter::~IdConverter (    )

Definition at line 61 of file IdConverter.cxx. References m_convCol. { m_convCol.clear(); }

---

Member Function Documentation

Identifier * xmlUtil::IdConverter::convert (  const Identifier *    inIdent )  const

Return the result of converting a single Identifier. Can only do this if there is an input IdDict so that the IdDict can be asked for the NamedId corresponding to the Identifier Definition at line 113 of file IdConverter.cxx. References convert(), inputDict, m_consistent, and NO. { if (!inputDict) return 0; // can't get names without dictionary if (m_consistent == NO) return 0; NamedId *inNamed = inputDict->getNamedId(*inIdent); if (inNamed == 0) return 0; NamedId *outNamed = convert(inNamed); Identifier *converted = outNamed->stripNames(); delete inNamed; delete outNamed; return converted; }

NamedId * xmlUtil::IdConverter::convert (  const NamedId *    in )  const

Return the result of converting a single NamedId. Definition at line 97 of file IdConverter.cxx. References m_consistent, m_convCol, and NO. Referenced by convert(), and testConverter(). { unsigned int ix; if (m_consistent == NO) return 0; // Based on path, find appropriate conversion, if any for (ix = 0; ix < m_convCol.size(); ix++) { if ((m_convCol[ix])->inDomain(*in)) { // convert return (m_convCol[ix]->convert(*in)); } } // else return copy of input return new NamedId(*in); }

std::ostream & xmlUtil::IdConverter::displayConversions (  std::ostream &    s )

Definition at line 129 of file IdConverter.cxx. References m_convCol. Referenced by main(). { Conversions::const_iterator it = m_convCol.begin(); while (it != m_convCol.end() ) { s << (**it) << std::endl; ++it; } return s; }

bool xmlUtil::IdConverter::isConsistent (    )

Check that conversions comprising the converter have disjoint domains. This is equivalent to checking that no conversion has a path which is an initial subsequence of the path for another conversion. Definition at line 75 of file IdConverter.cxx. References m_consistent, m_convCol, NO, sortConvs(), UNKNOWN, and YES. Referenced by IdConverter(), and testConverter(). { if (m_consistent == UNKNOWN) { sortConvs(); // Check whether a path is a subsequence of some other path, // unfortunately an o(n**2) procedure unsigned int ix, jx; for (ix = 0; ix < (m_convCol.size() - 1); ix++ ) { for (jx = ix + 1; jx < (m_convCol.size()); jx++) { // Since conversions are ordered by size, only need // to check whether ix-th path is subpath of jx-th, // not the reverse if (m_convCol[ix]->subpathOf(*(m_convCol[jx]))) { m_consistent = NO; return m_consistent; } } } m_consistent = YES; } return m_consistent; }

void xmlUtil::IdConverter::sortConvs (    )  [private]

It's convenient to have the conversions sorted by length of path when checking for consistency. Definition at line 66 of file IdConverter.cxx. References ConversionIt, m_convCol, m_sorted, and YES. Referenced by isConsistent(). { if (m_sorted != YES) { ConversionIt start = m_convCol.begin(), last = m_convCol.end(); IdConverterLessThan weakOrder; std::sort(start, last, weakOrder); // sort them m_sorted = YES; } }

---

Member Data Documentation

IdDictMan * xmlUtil::IdConverter::dictMan = 0 [static, private]

Definition at line 14 of file IdConverter.cxx. Referenced by IdConverter().

IdDict* xmlUtil::IdConverter::inputDict [private]

Definition at line 72 of file IdConverter.h. Referenced by convert(), and IdConverter().

std::string* xmlUtil::IdConverter::inputDictName [private]

Definition at line 71 of file IdConverter.h. Referenced by IdConverter().

STATES xmlUtil::IdConverter::m_consistent [private]

Definition at line 93 of file IdConverter.h. Referenced by convert(), and isConsistent().

Conversions xmlUtil::IdConverter::m_convCol [private]

Definition at line 86 of file IdConverter.h. Referenced by convert(), displayConversions(), IdConverter(), isConsistent(), sortConvs(), and ~IdConverter().

STATES xmlUtil::IdConverter::m_sorted [private]

Definition at line 94 of file IdConverter.h. Referenced by sortConvs().

IdDict* xmlUtil::IdConverter::outputDict [private]

Definition at line 76 of file IdConverter.h. Referenced by IdConverter().

std::string* xmlUtil::IdConverter::outputDictName [private]

Definition at line 75 of file IdConverter.h. Referenced by IdConverter().

---

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

• IdConverter.h
• IdConverter.cxx

---