metanorma-standoc 1.3.29 → 1.4.0

data/spec/examples/datamodel/models/models/AddressComponentProfile.yml

@@ -0,0 +1,63 @@
+name: AddressComponentProfile
+modelType: class
+definition: |
+  An `AddressComponentProfile` represents a profile of a `ProfileCompliantAddressComponent`,
+  which is extended from the `AddressComponent` model defined in <<ISO19160-1>>.
+
+  It represents additional attributes and restrictions to the `Address` model
+  of a `ProfileCompliantAddress`. It also represents metadata for the use of
+  the profile.
+attributes:
+  key:
+    definition: An identifier of this `AddressComponentProfile`, shall be unique within the `AddressProfile`.
+    type: CharacterString
+  description:
+    definition: Textual description of this component.
+    type: CharacterString
+  example:
+    definition: A textual example to demonstrate the correct use of this component.
+    type: CharacterString
+    cardinality:
+      min: 0
+      max: 1
+relations:
+  - target: AddressClassProfile
+    relationship:
+      target:
+        type: aggregation
+        attribute:
+          componentProfile:
+            cardinality:
+              min: 0
+              max: "*"
+      association: AddressComponentSpecification
+    action:
+      verb: uses
+      direction: source
+
+  - target: AttributeProfile
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          addressClassProfile:
+      target:
+        type: direct
+        attribute:
+          attributeProfile:
+            cardinality:
+              min: 0
+              max: '*'
+
+  - target: ProfileCompliantAddressComponent
+    relationship:
+      target:
+        type: direct
+        attribute:
+          profile:
+            cardinality:
+              min: 1
+              max: 1
+    action:
+      verb: compliesWith
+      direction: source

data/spec/examples/datamodel/models/models/AddressComponentSpecification.yml

@@ -0,0 +1,15 @@
+name: AddressComponentSpecification
+modelType: class
+definition: |
+  An `AddressComponentSpecification` specifies the cardinalities between a
+  `ProfileCompliantAddress` and `ProfileCompliantAddressComponents`.
+
+  A `ProfileComplinatAddress` MUST conform to this
+  `AddressComponentSpecification` to specifies its components.
+attributes:
+  maxCardinality:
+    definition: The maximum number of instances of the specific `ProfileCompliantAddressComponent` of a `ProfileCompliantAddress`.
+    type: Integer
+  minCardinality:
+    definition: The minimum number of instances of the specific `ProfileCompliantAddressComponent` of a `ProfileCompliantAddress`.
+    type: Integer

data/spec/examples/datamodel/models/models/AddressProfile.yml

@@ -0,0 +1,36 @@
+name: AddressProfile
+modelType: class
+definition:
+attributes:
+  country:
+    definition: The country of which this AddressProfile represents.
+    type: iso3166Code
+    cardinality:
+      min: 0
+      max: "*"
+relations:
+  - target: AddressComponentProfile
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          componentProfile:
+            cardinality:
+              min: 0
+              max: "*"
+    action:
+      verb: defines
+      direction: target
+
+  - target: AddressClassProfile
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          addressProfile:
+            cardinality:
+              min: 0
+              max: "*"
+    action:
+      verb: defines
+      direction: target

data/spec/examples/datamodel/models/models/AttributeProfile.yml

@@ -0,0 +1,32 @@
+modelType: class
+definition: |
+  An `AttributeProfile` represents name, cardinalities and value type of an
+  attribute in a model that complies with a profile that includes this
+  AttributeProfile.
+
+  If it represents an attribute that has been previously defined, e.g. an
+  attribute in Address model defined in <<ISO19160-1>>, it extends the
+  definition of the attribute by redefining the name, cardinalities and value
+  type.
+attributes:
+  name:
+    definition: The name of the attribute represented by this AttributeProfile.
+    type: CharacterString
+  minCardinality:
+    definition: The minimum number of occurrences of the attribute represented by this AttributeProfile.
+    type: Integer
+    cardinality:
+      min: 0
+      max: 1
+  maxCardinality:
+    definition: The maximum number of occurences of the attribute represented by this AttributeProfile.
+    type: Integer
+    cardinality:
+      min: 0
+      max: 1
+  valueType:
+    definition: The data type of values of the attribute represented by this AttributeProfile.
+    type: CharacterString
+    cardinality:
+      min: 0
+      max: 1

data/spec/examples/datamodel/models/models/InterchangeAddressClassProfile.yml

@@ -0,0 +1,79 @@
+name: InterchangeAddressClassProfile
+modelType: class
+definition: |
+  This `InterchangeAddressClassProfile` extends from `AddressClassProfile` to
+  enforce the existence of several subclasses of `AttributeProfile` for
+  interchange.
+
+  It also introduces `FormTemplate` and `DisplayTemplate` to
+  to allow the display, entry of, and the interchange of an
+  `ProfileCompliantAddress` (address
+  instance complying with an `InterchangeAddressClassProfile`).
+  --
+attributes:
+relations:
+  - target: AddressClassProfile
+    relationship:
+      target:
+        type: inheritance
+
+  - target: AttributeProfileSignature
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          attributeProfile:
+      target:
+        type: direct
+        attribute:
+          addressClassProfile:
+
+  - target: AttributeProfileAddressFeature
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          attributeProfile:
+      target:
+        type: direct
+        attribute:
+          addressClassProfile:
+
+  - target: AttributeProfileValidity
+    relationship:
+      source:
+        type: aggregation
+        attribute:
+          attributeProfile:
+      target:
+        type: direct
+        attribute:
+          addressClassProfile:
+
+  - target: FormTemplate
+    relationship:
+      source:
+        type: aggregation
+      target:
+        attribute:
+          formTemplate:
+            cardinality:
+              min: 0
+              max: "*"
+    action:
+      verb: defines
+      direction: target
+
+  - target: DisplayTemplate
+    relationship:
+      source:
+        type: aggregation
+      target:
+        attribute:
+          displayTemplate:
+            cardinality:
+              min: 0
+              max: "*"
+    action:
+      verb: defines
+      direction: target

data/spec/examples/datamodel/models/models/Localization copy.yml

@@ -0,0 +1,23 @@
+name: Localization
+modelType: class
+definition: |
+  The language and script used within the parent object.
+
+  Represented by the `PT_Locale` object defined in <<ISO19115-1>> and an
+  <<ISO15924>> script code.
+attributes:
+  locale:
+    definition: The locale of the parent object.
+    type: iso19115PT_Locale
+  script:
+    definition: The type of written script used in the parent object.
+    type: iso15924Code
+  textDirection:
+    definition: Indicating in which direction the text of the parent should be read.
+    type: TextDirectionCode
+relations:
+  - target: Validity
+    relationship:
+      target:
+        type: direct
+    direction: "[hidden]"

data/spec/examples/datamodel/models/models/Localization.yml

@@ -0,0 +1,23 @@
+name: Localization
+modelType: class
+definition: |
+  The language and script used within the parent object.
+
+  Represented by the `PT_Locale` object defined in <<ISO19115-1>> and an
+  <<ISO15924>> script code.
+attributes:
+  locale:
+    definition: The locale of the parent object.
+    type: iso19115PT_Locale
+  script:
+    definition: The type of written script used in the parent object.
+    type: iso15924Code
+  textDirection:
+    definition: Indicating in which direction the text of the parent should be read.
+    type: TextDirectionCode
+relations:
+  - target: Validity
+    relationship:
+      target:
+        type: direct
+    direction: "[hidden]"

data/spec/examples/datamodel/models/models/ProfileCompliantAddress.yml

@@ -0,0 +1,36 @@
+name: ProfileCompliantAddress
+modelType: class
+definition: |
+  ProfileCompliantAddress extends from the `Address` model defined in
+  <<ISO19160-1>> to represent an `Address` complying with an
+  `AddressClassProfile`.
+
+  A `ProfileCompliantAddress` MUST conform to the constraints and
+  requirements specified in `AddressClassProfile`, and its associated
+  profiles and specifications.
+relations:
+  - target: Address
+    relationship:
+      target:
+        type: inheritance
+
+  - target: ProfileCompliantAddressComponent
+    relationship:
+      source:
+        type: aggregation
+        attributes:
+          address:
+            cardinality:
+              min: 1
+              max: "*"
+      target:
+        type: direct
+        attributes:
+          addressComponent:
+            cardinality:
+              min: 1
+              max: "*"
+      association: AddressComponentSpecification
+    action:
+      verb: comprises
+      direction: target

data/spec/examples/datamodel/models/models/ProfileCompliantAddressComponent.yml

@@ -0,0 +1,15 @@
+name: ProfileCompliantAddressComponent
+modelType: class
+definition: |
+  ProfileCompliantAddressComponent extends from the AddressComponent model
+  defined in <<ISO19160-1>> to represent an Address complying with an
+  AddressClassProfile.
+
+  A ProfileCompliantAddressComponent MUST conform to the constraints and
+  requirements specified in AddressComponentProfile, and its associated
+  profiles and specifications.
+relations:
+  - target: AddressComponent
+    relationship:
+      target:
+        type: inheritance

data/spec/examples/datamodel/models/models/Signature copy.yml

@@ -0,0 +1,20 @@
+name: Signature
+modelType: class
+definition: |
+  A cryptographic signature used to determine data integrity and validity of the object it belongs to.
+attributes:
+  algorithm:
+    definition: The public key cryptographic algorithm used for this digital signature.
+    type: iso14888Oid
+  publicKey:
+    definition: A reference to the actual public key used to verify the digital signature, a URI where the public key of the signer used for this signature is found.
+    type: Uri
+  signature:
+    definition: The actual digital signature value encoded in Base64 format.
+    type: CharacterString
+relations:
+  - target: Localization
+    relationship:
+      target:
+        type: direct
+    direction: "[hidden]"

data/spec/examples/datamodel/models/models/Signature.yml

@@ -0,0 +1,20 @@
+name: Signature
+modelType: class
+definition: |
+  A cryptographic signature used to determine data integrity and validity of the object it belongs to.
+attributes:
+  algorithm:
+    definition: The public key cryptographic algorithm used for this digital signature.
+    type: iso14888Oid
+  publicKey:
+    definition: A reference to the actual public key used to verify the digital signature, a URI where the public key of the signer used for this signature is found.
+    type: Uri
+  signature:
+    definition: The actual digital signature value encoded in Base64 format.
+    type: CharacterString
+relations:
+  - target: Localization
+    relationship:
+      target:
+        type: direct
+    direction: "[hidden]"

data/spec/examples/datamodel/models/models/TextDirectionCode copy.yml

@@ -0,0 +1,16 @@
+name: TextDirectionCode
+modelType: enum
+definition: |
+  An enumeration value of TextDirectionCode represents the reading
+  direction of textual data whether it is from left to right or right to
+  left, and from top to bottom or bottom to top.
+type: enumeration
+values:
+  leftToRightTopToBottom:
+    definition: Indicating that text should be read left to right, and top to bottom.
+  rightToLeftTopToBottom:
+    definition: Indicating that text should be read right to left, and top to bottom.
+  leftToRightBottomToTop:
+    definition: Indicating that text should be read left to right, and bottom to top.
+  rightToLeftBottomToTop:
+    definition: Indicating that text should be read right to left, and bottom to top.

data/spec/examples/datamodel/models/models/TextDirectionCode.yml

@@ -0,0 +1,16 @@
+name: TextDirectionCode
+modelType: enum
+definition: |
+  An enumeration value of TextDirectionCode represents the reading
+  direction of textual data whether it is from left to right or right to
+  left, and from top to bottom or bottom to top.
+type: enumeration
+values:
+  leftToRightTopToBottom:
+    definition: Indicating that text should be read left to right, and top to bottom.
+  rightToLeftTopToBottom:
+    definition: Indicating that text should be read right to left, and top to bottom.
+  leftToRightBottomToTop:
+    definition: Indicating that text should be read left to right, and bottom to top.
+  rightToLeftBottomToTop:
+    definition: Indicating that text should be read right to left, and bottom to top.

data/spec/examples/datamodel/models/models/Validity.yml

@@ -0,0 +1,14 @@
+name: Validity
+modelType: class
+definition: |
+  The time interval where this interchange address profile is determined valid, and the revision number (represented as a date).
+attributes:
+  validityBegins:
+    definition: The date and time when this object becomes valid.
+    type: iso19115CI_Date
+  validityEnds:
+    definition: The date and time when this object becomes invalid.
+    type: iso19115CI_Date
+  revision:
+    definition: Issuance date/time of this object.
+    type: iso19115CI_Date

data/spec/examples/datamodel/models/models/iso19160-1/Address.yml

@@ -0,0 +1,22 @@
+name: Address
+modelType: class
+relations:
+  - target: AddressComponent
+    relationship:
+      source:
+        type: aggregation
+        attributes:
+          address:
+            cardinality:
+              min: 1
+              max: "*"
+      target:
+        type: direct
+        attributes:
+          addressComponent:
+            cardinality:
+              min: 1
+              max: "*"
+    action:
+      verb: comprises
+      direction: target