Uploaded image for project: 'OASIS Open Building Information Exchange (oBIX) TC'
  1. OASIS Open Building Information Exchange (oBIX) TC
  2. OBIX-1

UML diagram and text needs clarification line 269

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: oBIX 1.1 PR01
    • Fix Version/s: None
    • Component/s: OBIX 1.1 Specification
    • Labels:
      None
    • Environment:

      William Cox

    • Proposal:
      Hide

      (1) Insert "xsd:" prior to stated types e.g. xsd::anyURI. Include text indicating that the base types are either xsd (as suggested) or UML.

      (2) Integrate the separate work on the schemas and the diagrams. A simple XML spy schema diagram for each type could be included, along with the respective UML diagram, perhaps combined into a few diagrams.

      (3) address the val: <type> issues, in conjunction with schema updates.

      Show
      (1) Insert "xsd:" prior to stated types e.g. xsd::anyURI. Include text indicating that the base types are either xsd (as suggested) or UML. (2) Integrate the separate work on the schemas and the diagrams. A simple XML spy schema diagram for each type could be included, along with the respective UML diagram, perhaps combined into a few diagrams. (3) address the val: <type> issues, in conjunction with schema updates.
    • Resolution:
      Hide

      Do not include xsd:. The text referring to Figure 4-1 should be similar to "All diagrams are non-normative.

      The normative definition of OBIX 1.1 is in XML schema. Diagram <DiagramNumber> is a UML representation of the OBIX class structure with some liberties taken in the types. XML schema attributes in the OBIX schemas are optional with cardinality [0..1]; we have illustrated those with initial values as having cardinality [1..1]. ".

      Show
      Do not include xsd:. The text referring to Figure 4-1 should be similar to "All diagrams are non-normative. The normative definition of OBIX 1.1 is in XML schema. Diagram <DiagramNumber> is a UML representation of the OBIX class structure with some liberties taken in the types. XML schema attributes in the OBIX schemas are optional with cardinality [0..1] ; we have illustrated those with initial values as having cardinality [1..1] . ".

      Description

      Line 269ff

      The UML diagram is generally conformant UML but leaves significant questions for the reader.

      (1) what are the base types? The text suggests but does not state that the underlying types are XML Schema (xsd) types. This should be clarified in the text.

      (2) The UML diagram does not follow the schema; they are not synchronized. The final 1.1 spec must have consistent use of types and implied types in the schemas. See also notes on schemas by others.

      (3) The use of "val" seems odd in UML expression; the apparent metaindication of "<type>" is not standard UML and should be corrected.

        Attachments

          Activity

            People

            • Assignee:
              craigg Craig Gemmill (Inactive)
              Reporter:
              william.cox William Cox (Inactive)
            • Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: