root/gaphor-doc/trunk/gaphor-uml.xml

<?xml version="1.0"?>
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
>
<appendix id="app-datamodel">
  <title>Gaphor's datamodel</title>

  <para>Gaphor has a data model based upon UML 2.0. UML 2.0 has a revised
  meta model (from which the data model is derived) that is designed to
  be more usable within modeling tools.</para>

  <para>The meta model is split up in several packages. The packages currently
  used in Gaphor are:
    <variablelist>
      <varlistentry>
        <term>Kernel</term>
        <listitem>
          <para>Contains the basic needs for UML models. Amongst those is
          the definition of a <classname>Class</classname>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Dependencies</term>
        <listitem>
          <para>Dependencies, relationships, etc. are defined here.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Interfaces</term>
        <listitem>
          <para>... interfaces...
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>UseCases</term>
        <listitem>
          <para>Contains Use Case related data.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Presentations</term>
        <listitem>
          <para>This package is added especially for Gaphor. It contains some
          extensions to the data model, such as the class
          <classname>Diagram</classname> and a relationship between diagram
          items and model elements.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </para>
  <para>All classes are put in one Python module: <classname>UML</classname>.
  For the remainder of this chapter, the packages are split up as they are
  in the official UML documentation.
  </para>

  <figure id="fig-overview" float="1">
    <title>Gaphor's data model</title>
    <graphic fileref="overview.png"/>
  </figure>

  <section>
    <title>Kernel package</title>

    <para>The Kernel package described the core modeling concepts. Basically
    all functionallity given by an UML model is related to this package.
    Here you can find the definition of <classname>Class</classname>,
    <classname>Package</classname>, attributes and operations, as well as
    associations.
    </para>

    <figure id="fig-kernel-root" float="0">
      <title>Kernel::Root</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Root.png"/>
    </figure>

    <figure id="fig-kernel-namespaces" float="0">
      <title>Kernel::Namespaces</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Namespaces.png"/>
    </figure>

    <figure id="fig-kernel-mult" float="0">
      <title>Kernel::Multiplicities</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Multiplicities.png"/>
    </figure>

    <figure id="fig-kernel-expr" float="0">
      <title>Kernel::Expressions</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Expressions.png"/>
    </figure>

    <figure id="fig-kernel-constraints" float="0">
      <title>Kernel::Constraints</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Constraints.png"/>
    </figure>

    <figure id="fig-kernel-inst" float="0">
      <title>Kernel::Instances</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Instances.png"/>
    </figure>

    <figure id="fig-kernel-classifiers" float="0">
      <title>Kernel::Classifiers</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Classifiers.png"/>
    </figure>

    <figure id="fig-kernel-feat" float="0">
      <title>Kernel::Features</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Features.png"/>
    </figure>

    <figure id="fig-kernel-oper" float="0">
      <title>Kernel::Operations</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Operations.png"/>
    </figure>

    <figure id="fig-kernel-classes" float="0">
      <title>Kernel::Classes</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Classes.png"/>
    </figure>

    <figure id="fig-kernel-datatypes" float="0">
      <title>Kernel::DataTypes</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/DataTypes.png"/>
    </figure>

    <figure id="fig-kernel-packages" float="0">
      <title>Kernel::Packages</title>
      <graphic fileref="UML2 DataModel/Classes/Kernel/Packages.png"/>
    </figure>

  </section>

  <section>
    <title>Dependencies</title>
    <para>All sorts of dependencies...
    </para>
    <figure id="fig-dependencies" float="0">
      <title>Dependencies</title>
      <graphic fileref="UML2 DataModel/Classes/Dependencies/Dependencies.png"/>
    </figure>
  </section>

  <section>
    <title>Interfaces</title>
    <para>
    </para>
    <figure id="fig-interfaces" float="0">
      <title>Interfaces</title>
      <graphic fileref="UML2 DataModel/Classes/Interfaces/Interfaces.png"/>
    </figure>
  </section>

  <section>
    <title>Components</title>
    <para>
    </para>
    <figure id="fig-components" float="0">
      <title>Components</title>
      <graphic fileref="UML2 DataModel/Components/Components.png"/>
    </figure>
  </section>

  <section>
    <title>Deployment</title>
    <para>
    </para>
    <figure id="fig-artifacts" float="0">
      <title>Artifacts</title>
      <graphic fileref="UML2 DataModel/Deployments/Artifacts.png"/>
    </figure>
    <figure id="fig-node" float="0">
      <title>Node</title>
      <graphic fileref="UML2 DataModel/Deployments/Node.png"/>
    </figure>
  </section>

  <section>
    <title>Behavioral modeling</title>
    <para>
    </para>
    <figure id="fig-basic-behaviors" float="0">
      <title>Basic behaviors</title>
      <graphic fileref="UML2 DataModel/CommonBehaviors/BasicBehaviors/CommonBehaviors.png"/>
    </figure>
    <figure id="fig-reception" float="0">
      <title>Reception</title>
      <graphic fileref="UML2 DataModel/CommonBehaviors/Communications/Reception.png"/>
    </figure>

    <figure id="fig-actions" float="0">
      <title>Actions</title>
      <graphic fileref="UML2 DataModel/Activities/BasicActivities//Actions.png"/>
    </figure>
    <figure id="fig-flows" float="0">
      <title>Flows</title>
      <graphic fileref="UML2 DataModel/Activities/BasicActivities/Flows.png"/>
    </figure>
    <figure id="fig-nodes" float="0">
      <title>Nodes</title>
      <graphic fileref="UML2 DataModel/Activities/BasicActivities/Nodes.png"/>
    </figure>
    <figure id="fig-groups" float="0">
      <title>Groups</title>
      <graphic fileref="UML2 DataModel/Activities/BasicActivities/Groups.png"/>
    </figure>
    <figure id="fig-control-nodes" float="0">
      <title>Control nodes</title>
      <graphic fileref="UML2 DataModel/Activities/BasicActivities/Control nodes.png"/>
    </figure>
  </section>

  <section>
    <title>Use Cases</title>
    <para>Use Cases are also added to Gaphor. They are basically quite easy to
    implement and for several reasons have been the first model elements ever
    created in Gaphor.
    </para>

    <figure id="fig-usecases" float="0">
      <title>UseCases</title>
      <graphic fileref="UML2 DataModel/UseCases/UseCases.png"/>
    </figure>

    <para>We have to define the relationship between an
    <classname>Actor</classname> or <classname>UseCase</classname> and a
    <classname>Property</classname>. This way associations can be made.
    </para>

    <figure id="fig-usecases-extra" float="0">
      <title>UseCases</title>
      <graphic fileref="UML2 DataModel/UseCases/UseCases_extra.png"/>
    </figure>

  </section>

  <section>
    <title>Profiles and stereotypes</title>

    <para>Profiles are the basic means to extend the usability of UML.
    </para>

    <figure id="fig-profiles" float="0">
      <title>Profiles</title>
      <graphic fileref="UML2 DataModel/AuxilaryConstructs/Profiles/Profiles.png"/>
    </figure>

    <para>The UML specification does not describe a uniform way to apply a
    stereotype to a model elements. <xref linkend="fig-stereotypes"/> describes
    the way Gaphor handles this.
    </para>

    <figure id="fig-stereotypes" float="0">
      <title>Stereotypes</title>
      <graphic fileref="UML2 DataModel/AuxilaryConstructs/Stereotypes/Stereotypes.png"/>
    </figure>

  </section>

  <section>
    <title>Presentations</title>

    <para>The Presentations package describes the relationship between model
    elements and their representation in a diagram. The UML 2.0 specification,
    as defined by the OMG, has no special classes and structures for
    integrating diagrams into a model.
    </para>

    <figure id="fig-presentations" float="0">
      <title>Presentations</title>
      <graphic fileref="UML2 DataModel/AuxilaryConstructs/Presentations/Presentations.png"/>
    </figure>

    <para>The items as found in the module <literal>gaphor.diagram</literal>
    are all inherited from <classname>Presentation</classname>.</para>
  </section>

</appendix>
<!-- vi:sw=2:tw=78:tabstop=2:sts=2
-->