PAGE-OM 1.0 FTF Avatar
  1. OMG Issue

PAGEOM_ — Associations in the model not really documented

  • Key: PAGEOM_-26
  • Legacy Issue Number: 13808
  • Status: closed  
  • Source: Thematix Partners LLC ( Dr. Doug Tolbert)
  • Summary:

    There are a lot of associations in the model but not one of them is documented in any fashion beyond listing names and the classes they connect. Cardinalities can be found in the diagrams but direct documentation of the associations and their use is necessary to convey the intent of the specification. Associations should be individually documented to the extent that a reader can determine the characteristics of each association, its name, and the names, multiplicity, and ocnstraints of its ends in a single place in the spec. The reader should not have to harvest association characteristics scattered around figures and text.

  • Reported: PAGE-OM 1.0b2 — Thu, 19 Mar 2009 04:00 GMT
  • Disposition: Resolved — PAGE-OM 1.0
  • Disposition Summary:

    Resolution explanation:

    1) Cardinalities will be generated into the generated documentation of
    the model.

    Plus: Explicit cardinality is one (whenever it is not mentioned in the
    generated document).

    See also issue 14018 dealing with missing cardinalities.

    2) The rules for associations are:

    a) Many associations are described enough by the class names they
    connect. We have not changed them; we do not see a need for better
    documentation for these associations.

    b) Some of the remaining associations have on one or on both sides
    roles. We believe that the roles describe the association

    c) Many of the remaining associations have names that are sufficent
    for describing the association role. We added, however, some names:

    • Panel has subpanels.
    • Genotype_phenotype_correlation_experiment associated with itself:
      meta-experiments has sub-experiments.

    d) For the rest we added better description.

    3) In the model, we do not define (expect) any constraints - so no
    documentation needed for them.


    • Few new descriptions added to the associations. Done directly in the
      model. Regenerate the whole documentation (chapter 7).
    • Add to the generated documentation roles and cardinalities. [Now,
      each class has two new rows labelled "Card" and "Role name". Often,
      however, on places that we consider self-explanatory, they are
  • Updated: Sat, 7 Mar 2015 03:28 GMT