---

IdDict.h

Go to the documentation of this file.

// $Header: /nfs/slac/g/glast/ground/cvs/xmlUtil/xmlUtil/id/IdDict.h,v 1.7 2002/04/05 18:28:44 jrb Exp $
#ifndef XMLUTIL_IDDICT_H
#define XMLUTIL_IDDICT_H

#include <dom/DOM_Element.hpp>

#include <vector>
#include <string>

#include "xmlUtil/id/DictObject.h"
#include "xmlUtil/id/NamedId.h"

namespace xmlUtil {

  /* Some day should redo this using Builder architecture.
     Define abstract (or nearly abstract) IdDictBuilder class, then
     concrete derived XMLbuilder.  That way the dictionary class and
     classes making up elements of the dictionary wouldn't have to know
     about the XML representation at all.
  */
  class DictNode;
  class DictField;
  class DictFieldMan;
  class DictVisitor;

  class IdDict : public DictObject {
  public:
    enum Constituents {nodeHierarchy = 1,
                       fieldManager = 2};

    IdDict(DOM_Element elt);
    ~IdDict();

    bool isValid();

    bool idOk(const Identifier& id) const;

    bool idOk(const NamedId& id) const;

    bool nameSeqOk(const NameSeq& seq) const;

    // Not clear anyone wants or needs this service; if not, dump it
    //    NameSeq*     getNameSeq(const Identifier& id) const;

    NamedId *  getNamedId(const Identifier& id) const;

    const std::string& getDictName() const {return m_name;};
    int                getMajorVersion() const {return m_major;};
    int                getMinorVersion() const {return m_minor;};
    int                getPatchVersion() const {return m_patch;};
    DictNode&          getRoot() const {return *m_root;};
    bool               accept(DictVisitor *vis);

    bool               accept(DictVisitor *vis, unsigned constituentMask);
  protected:
    friend class IdConverter;

    // Maybe make a derived class, IdDictBuildable, where the following
    // constructor and member function are declared.  IdConverter
    // would create an object of this (derived) type.

    IdDict(DictNode* root);

    bool addChild(DictNode* parent, DictNode* newNode);

    /* vector<DictField*> m_fields;  */
                            /*< all fields defined in the dictionary;
                                need not all be used (associated with
                                a node) */
    DictFieldMan*      m_fieldMan;
    DictNode*          m_root;
    std::string        m_name;   /*< dictionary name */
    int                m_major;  /*< version information */
    int                m_minor;  /*< version information */
    int                m_patch;  /*< version information */
  };  // end of IdDict class definition
}      // end of namespace xmlUtil
#endif

---