---

xmlUtil::IdConversion Class Reference

An IdConversion object (corresponding to an idConv element as defined in gdd.dtd) "has" a path (list of id field names) a condition an operation to be performed on identifiers starting with the specified path and satisfying the condition and producing a new NamedId. More...

#include <IdConversion.h>

List of all members.

Public Methods
	IdConversion ()
	Default constructor produces a conversion which acts on any NamedId and does nothing to it; that is, returns a copy. More...
	IdConversion (const DOM_Element)
	The usual case: build a conversion from its XML description. More...
	~IdConversion ()
bool	inDomain (const NamedId &inputId)
	Check that start of inputId fieldnames match path. More...
NamedId *	convert (const NamedId &inputId)
	Convert the identifier if in domain; else return null. More...
bool	subpathOf (const IdConversion &other) const
	Return true if our path is subpath of other. More...
Private Types
typedef std::string	Condition
	For now only condition recognized is hasField, which can be represented by a string: the field name. More...
Private Methods
bool	satisfies (const NamedId &inputId)
NamedId *	internalConvert (const NamedId &inputId)
	Doesn't check that input is in domain. Typically invoked from convert. More...
void	makePath (const DOM_Element &pathElt)
	Form path component from corresponding piece of xml. More...
void	buildOp (const DOM_Element &optElt)
	Determine operation type and instantiate object of appropriate operation class. More...
Private Attributes
NameSeq *	m_path
	Defines domain of conversion. More...
Condition *	m_condition
	Given an identifier in domain, convert if condition is satisfied. More...
IdOperation *	m_op
	op knows how to do a conversion. More...
Friends
class	IdConverterLessThan
std::ostream &	operator<< (std::ostream &s, const IdConversion &convers)

---

Detailed Description

An IdConversion object (corresponding to an idConv element as defined in gdd.dtd) "has" a path (list of id field names) a condition an operation to be performed on identifiers starting with the specified path and satisfying the condition and producing a new NamedId.

Definition at line 23 of file IdConversion.h.

---

Member Typedef Documentation

typedef std::string xmlUtil::IdConversion::Condition [private]

For now only condition recognized is hasField, which can be represented by a string: the field name. Definition at line 68 of file IdConversion.h.

---

Constructor & Destructor Documentation

xmlUtil::IdConversion::IdConversion (    )

Default constructor produces a conversion which acts on any NamedId and does nothing to it; that is, returns a copy. Definition at line 12 of file IdConversion.cxx. References m_op. : m_path(0), m_condition(0) { m_op = new IdOperation(); }

xmlUtil::IdConversion::IdConversion (  const DOM_Element    conversion )

The usual case: build a conversion from its XML description. Definition at line 16 of file IdConversion.cxx. References buildOp(), m_condition, and makePath(). { // Get first child; invoke private function to build path DOM_Element child = xml::Dom::getFirstChildElement(conversion); makePath(child); // Get next child; save field name in condition component child = xml::Dom::getSiblingElement(child); m_condition = new std::string(xml::Dom::getAttribute(child, "name")); // Get next child; build new op component. child = xml::Dom::getSiblingElement(child); buildOp(child); }

xmlUtil::IdConversion::~IdConversion (    )

---

Member Function Documentation

void xmlUtil::IdConversion::buildOp (  const DOM_Element &    opElt )  [private]

Determine operation type and instantiate object of appropriate operation class. Definition at line 72 of file IdConversion.cxx. References m_op. Referenced by IdConversion(). { DOMString opType = opElt.getTagName(); if (opType.equals("truncate")) { m_op = new IdOpTruncate(opElt); } else if (opType.equals("disappear")) { m_op = new IdOpDisappear(opElt); } else if (opType.equals(DOMString("compress"))) { m_op = new IdOpCompress(opElt); } else { // default to identity operation, implemented by base class m_op = new IdOperation(opElt); } }

NamedId * xmlUtil::IdConversion::convert (  const NamedId &    inputId )

Convert the identifier if in domain; else return null. Definition at line 41 of file IdConversion.cxx. References inDomain(), and internalConvert(). { if (!inDomain(inputId)) return 0; return internalConvert(inputId); }

bool xmlUtil::IdConversion::inDomain (  const NamedId &    inputId )

Check that start of inputId fieldnames match path. Definition at line 31 of file IdConversion.cxx. References m_path. Referenced by convert(). { return inputId.hasSubpath(*m_path); }

NamedId * xmlUtil::IdConversion::internalConvert (  const NamedId &    inputId )  [private]

Doesn't check that input is in domain. Typically invoked from convert. Definition at line 46 of file IdConversion.cxx. References m_op, and satisfies(). Referenced by convert(). { if (satisfies(inputId)) { // let the operation do its thing return m_op->convert(inputId); } else { // clone input and return return new NamedId(inputId); } }

void xmlUtil::IdConversion::makePath (  const DOM_Element &    pathElt )  [private]

Form path component from corresponding piece of xml. Definition at line 55 of file IdConversion.cxx. References m_path, and xmlUtil::NameSeq. Referenced by IdConversion(). { // "path" consists of a list of fields. Fields have // a required attribute "name". Save its value. m_path = new NameSeq; DOM_Element child = xml::Dom::getFirstChildElement(pathElt); while (child != DOM_Element()) { m_path->push_back(new std::string(xml::Dom::getAttribute(child, "name"))); child = xml::Dom::getSiblingElement(child); } }

bool xmlUtil::IdConversion::satisfies (  const NamedId &    inputId )  [private]

Definition at line 35 of file IdConversion.cxx. References m_condition. Referenced by internalConvert(). { if (m_condition == 0) return true; return (inputId.hasField(*m_condition) >= 0); }

bool xmlUtil::IdConversion::subpathOf (  const IdConversion &    other )  const

Return true if our path is subpath of other. Definition at line 91 of file IdConversion.cxx. References m_path. { unsigned int ourLen = m_path->size(); if (ourLen > other.m_path->size() ) return false; for (unsigned int ix = 0; ix < ourLen; ix++) { if ((*(other.m_path))[ix]->compare((*(*m_path)[ix])) ) return false; } return true; }

---

Friends And Related Function Documentation

friend class IdConverterLessThan [friend]

Definition at line 49 of file IdConversion.h.

std::ostream& operator<< (  std::ostream &    s, const IdConversion &    convers )  [friend]

Definition at line 101 of file IdConversion.cxx. { s << (*(convers.m_op)) << std::endl << " Path: " << (*(convers.m_path)) << " Condition: hasField " << (*(convers.m_condition)); return s; }

---

Member Data Documentation

Condition* xmlUtil::IdConversion::m_condition [private]

Given an identifier in domain, convert if condition is satisfied. Definition at line 75 of file IdConversion.h. Referenced by IdConversion(), and satisfies().

IdOperation* xmlUtil::IdConversion::m_op [private]

op knows how to do a conversion. Definition at line 78 of file IdConversion.h. Referenced by buildOp(), IdConversion(), and internalConvert().

NameSeq* xmlUtil::IdConversion::m_path [private]

Defines domain of conversion. Definition at line 72 of file IdConversion.h. Referenced by inDomain(), makePath(), and subpathOf().

---

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

• IdConversion.h
• IdConversion.cxx

---