XmiReader_2_0.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2004  Andrew Sutton
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to:
 *
 * The Free Software Foundation, Inc.
 * 59 Temple Place, Suite 330
 * Boston, MA  02111-1307  USA
 *
 * Contact:
 *   Andrew Sutton  asutton@cs.kent.edu
 */

#ifndef OMF_XMIREADER20_HPP
#define OMF_XMIREADER20_HPP

// std includes
#include <string>
#include <list>
#include <map>

// libxml includes
#include <libxml/tree.h>

namespace OMF
{
  // forward declarations
  class ModelObject;
  class Property;
  class Association;

  class XmiReader_2_0
  {
  public:
    XmiReader_2_0();
    ~XmiReader_2_0();

    // A good starting point
    void document(Model *model, xmlDocPtr doc);

  protected:
    bool isXmi(xmlNsPtr ns);
    bool isVersionAttr(xmlAttrPtr attr);
    bool isIdAttr(xmlAttrPtr attr);
    bool isLabelAttr(xmlAttrPtr attr);
    bool isUuidAttr(xmlAttrPtr attr);
    bool isTypeAttr(xmlAttrPtr attr);
    bool isIdrefAttr(xmlAttrPtr attr);
    bool isHrefAttr(xmlAttrPtr attr);

    void createObject();
    void resolveDeferred();

    // [3.3.1] Overall Document Structure
    void xmi();
    void startAttribs();
    void xmiVersion();
    void namespaces();

    // [3.3.2] Overall Content Structure
    void contentElements();

    // [3.3.3] Object Structure 
    void objectAsElement();
    void objectTagName();
    void objectAttribs();
    void identityAttribs();
    void typeAttrib();
    void featureAttribs();
    void dataValueAttrib();
    void refValueAttrib();

    // [3.3.4] References
    void linkAttribs();

    // [3.3.5] Object Contents
    void objectContents();
    void contentElement();
    void dataValue();
    void primitiveValue();
    void structureValue();

    // [3.3.6] Extensions???
    void extension();

    // 6:classAttributes
    void classAttributes();

    // 7:otherLinks
    void otherLinks();

  private:
    struct Context
    {
      Context() :
  node(0),
  attr(0),
  previous(0),
  object(0),
  prop(),
  context(),
  end(false)
      {}

      xmlNodePtr  node;   // the node being parsed
      xmlNodePtr  child;    // the current child position
      xmlAttrPtr  attr;   // the current attr position

      Context   *previous;  // the previous context
      ModelObject *object;  // the object being parsed (can be null)
      Property    *prop;    // some relavent property of this object
      Property    *context; // the property in which this object is defined

      bool    end;    // marks the end state for a sequence

      std::string uri;    // the uri of the element
      std::string metaclass;  // the element class name
      std::string feature;  // the name of the feature
      std::string xmiId;    // the xmi id
      std::string xmiUuid;  // the xmi uuid
      std::string xmiLabel; // the xmi label
      std::string xmiType;  // the xmi type
      std::string xmiIdref; // a local xmi id reference
      std::string href;   // a non-local xml reference
    };

    struct Deferred
    {
      Deferred() :
  id(),
  prop(0),
  object(0)
      {}

      std::string id;
      Property         *prop;
      ModelObject      *object;
    };

    typedef std::map<std::string, xmlNsPtr> PrefixMap;
    typedef std::list<Deferred *> DeferredList;

    xmlDocPtr   _doc;   // document object
    xmlNodePtr    _xmi;   // root node
    PrefixMap   _prefix;  // cached namespaces
    DeferredList  _deferred;  // deferred reference list
    Context        *_current; // the current context
    Model        *_model;   // the model being populated
  };
}

#endif

---