Skip to content

Commit

Permalink
Merge pull request #475 from catroest/AddressAndContact
Browse files Browse the repository at this point in the history
[Model Update]: Address and Contact (to SAMM)
  • Loading branch information
agg3fe authored Nov 28, 2023
2 parents 65392aa + 6d1b497 commit 82408d0
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 38 deletions.
76 changes: 38 additions & 38 deletions io.catenax.shared.address_characteristic/3.0.0/AddressAspect.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,19 @@

:AddressAspect a samm:Aspect ;
samm:preferredName "Address Aspect"@en ;
samm:description "Aspect used for the Characteristic :PostalAddress to reference address data"@en ;
samm:description "Aspect used for the Characteristic :PostalAddress to reference address data."@en ;
samm:properties ( :address ) ;
samm:operations ( ) ;
samm:events ( ) .

:address a samm:Property ;
samm:preferredName "Address"@en ;
samm:description "the address of the data provider"@en ;
samm:description "The address of the data provider."@en ;
samm:characteristic :PostalAddress .

:PostalAddress a samm:Characteristic ;
samm:description "A characteristic to express the postal address and which is intended to be referenced by other aspects"@en ;
samm:preferredName "PostalAddress"@en ;
samm:description "A characteristic to express the postal address and which is intended to be referenced by other aspects."@en ;
samm:dataType :AddressEntity .

:AddressEntity a samm:Entity ;
Expand All @@ -46,31 +47,32 @@

:thoroughfare a samm:Property ;
samm:preferredName "Thoroughfare"@en ;
samm:description "Street or thorough road name"@en ;
samm:description "Street or thorough road name."@en ;
samm:characteristic :ThoroughfareCharacteristic .

:locality a samm:Property ;
samm:preferredName "Locality"@en ;
samm:description "Locality belonging to an address"@en ;
samm:description "Locality belonging to an address."@en ;
samm:characteristic :LocalityCharacteristic .

:premise a samm:Property ;
samm:preferredName "Premise"@en ;
samm:description "Premise of an address, e.g. a specific \"BUILDING\" but can also be used for naming a particular site"@en ;
samm:description "Premise of an address, e.g. a specific \"BUILDING\" but can also be used for naming a particular site."@en ;
samm:characteristic :PremiseCharacteristic .

:postalDeliveryPoint a samm:Property ;
samm:preferredName "Postal Delivery Point"@en ;
samm:description "Delivery point, e.g. designation of a gate"@en ;
samm:description "Delivery point, e.g. designation of a gate."@en ;
samm:characteristic :PostalDeliveryPointCharacteristic .

:country a samm:Property ;
samm:preferredName "Country"@en ;
samm:description "Country of an address"@en ;
samm:description "Country of an address."@en ;
samm:characteristic :CountryCharacteristic .

:postCode a samm:Property ;
samm:preferredName "Post Code"@en ;
samm:description "Postal code of the address."@en ;
samm:characteristic :PostCodeCharacteristic .

:ThoroughfareCharacteristic a samm-c:SingleEntity ;
Expand All @@ -84,6 +86,7 @@
samm:dataType :LocalityEntity .

:PremiseCharacteristic a samm-c:SingleEntity ;
samm:preferredName "Premise Characteristic"@en ;
samm:description "Characteristic for defining a premise which consists of a technical key (e.g. \"BUILDING\" or \"OTHER\") and a value (e.g. \"Werk 1\")."@en ;
samm:dataType :PremiseEntity .

Expand Down Expand Up @@ -114,7 +117,7 @@

:PremiseEntity a samm:Entity ;
samm:preferredName "Premise Entity"@en ;
samm:description "Entity for a premise which consists of a type (technical key) and a value"@en ;
samm:description "Entity for a premise which consists of a type (technical key) and a value."@en ;
samm:properties ( [ samm:property :premiseTechnicalKey; samm:payloadName "technicalKey" ] [ samm:property :premiseValue; samm:payloadName "value" ] ) .

:PostalDeliveryPointEntity a samm:Entity ;
Expand All @@ -124,93 +127,90 @@

:CountryEntity a samm:Entity ;
samm:preferredName "Country Entity"@en ;
samm:description "Entity definition for a country"@en ;
samm:description "Entity definition for a country."@en ;
samm:properties ( [ samm:property :countryShortName; samm:payloadName "shortName" ] ) .

:PostCodeEntity a samm:Entity ;
samm:preferredName "PostCode Entity"@en ;
samm:description "Entity for a postcode which consists of a type plus a value"@en ;
samm:description "Entity for a postcode which consists of a type plus a value."@en ;
samm:properties ( [ samm:property :postCodeValue; samm:payloadName "value" ] [ samm:property :postCodeTechnicalKey; samm:payloadName "technicalKey" ] ) .

:thoroughfareTechnicalKey a samm:Property ;
samm:preferredName "Thoroughfare Technical Key "@en ;
samm:preferredName "Thoroughfare Technical Key"@en ;
samm:description "Technical key of a thoroughfare. As specified by BPDM, this can be a \"STREET\" or a different type."@en ;
samm:characteristic :ThoroughfareTechnicalKeyCharacteristic ;
samm:exampleValue "STREET" .

:thoroughfareValue a samm:Property ;
samm:preferredName "Value Thoroughfare"@en ;
samm:description "Value of a thoroughfare, e.g. name of a street."@en ;
samm:characteristic :Text ;
samm:exampleValue "Bernstra?e" .
samm:characteristic samm-c:Text ;
samm:exampleValue "Bernstrasse" .

:thoroughfareNumber a samm:Property ;
samm:preferredName "Thoroughfare Number"@en ;
samm:description "Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values"@en ;
samm:characteristic :Text ;
samm:description "Number of a thoroughfare. As used differently in international context, this number can contain both numerical and alphanumerical values."@en ;
samm:characteristic samm-c:Text ;
samm:exampleValue "45" .

:localityTechnicalKey a samm:Property ;
samm:preferredName "Locality Technical Key"@en ;
samm:description "Technical key of a locality"@en ;
samm:description "Technical key of a locality."@en ;
samm:characteristic :LocalityTechnicalKeyCharacteristic ;
samm:exampleValue "CITY" .

:localityValue a samm:Property ;
samm:preferredName "Locality Value"@en ;
samm:description "Value of a locality, e.g. name of a city (\"Mannheim\")."@en ;
samm:characteristic :Text ;
samm:characteristic samm-c:Text ;
samm:exampleValue "Mannheim" .

:premiseTechnicalKey a samm:Property ;
samm:preferredName "Premise Technical Key"@en ;
samm:description "Technical key of a premise"@en ;
samm:description "Technical key of a premise."@en ;
samm:characteristic :PremiseTechnicalKeyCharacteristic ;
samm:exampleValue "OTHER" .

:premiseValue a samm:Property ;
samm:preferredName "Premise Value"@en ;
samm:description "Value of a premise, e.g. name or designation of a particular site"@en ;
samm:characteristic :Text ;
samm:description "Value of a premise, e.g. name or designation of a particular site."@en ;
samm:characteristic samm-c:Text ;
samm:exampleValue "Werk 1" .

:postalDeliveryPointTechnicalKey a samm:Property ;
samm:preferredName "Postal Delivery Point Technical Key"@en ;
samm:description "Technical key of a postal delivery point"@en ;
samm:description "Technical key of a postal delivery point."@en ;
samm:characteristic :PostalDeliveryPointTechnicalKeyCharacteristic ;
samm:exampleValue "OTHER" .

:postalDeliveryPointValue a samm:Property ;
samm:preferredName "Postal Delivery Point Value"@en ;
samm:description "Value of a postal delivery point, e.g. designation of a gate"@en ;
samm:characteristic :Text ;
samm:description "Value of a postal delivery point, e.g. designation of a gate."@en ;
samm:characteristic samm-c:Text ;
samm:exampleValue "Tor 1" .

:countryShortName a samm:Property ;
samm:preferredName "Country Short Name"@en ;
samm:description "The short variation of the name of the country."@en ;
samm:characteristic :CountryTrait .

:postCodeValue a samm:Property ;
samm:preferredName "Post Code Value "@en ;
samm:description "The value of a post code"@en ;
samm:preferredName "Post Code Value"@en ;
samm:description "The value of a post code."@en ;
samm:characteristic :PostCodeTrait ;
samm:exampleValue "98765-4321" .

:postCodeTechnicalKey a samm:Property ;
samm:preferredName "Post Code Technical Key"@en ;
samm:description "The technical key of a post code"@en ;
samm:description "The technical key of a post code."@en ;
samm:characteristic :PostCodeTechnicalKeyCharacteristic .

:ThoroughfareTechnicalKeyCharacteristic a samm-c:Enumeration ;
samm:preferredName "Thoroughfare Technical Key Characteristic"@en ;
samm:description "Characteristic of the technical key of a thoroughfare"@en ;
samm:description "Characteristic of the technical key of a thoroughfare."@en ;
samm:dataType xsd:string ;
samm-c:values ( "STREET" "INDUSTRIAL_ZONE" "OTHER" "RIVER" "SQUARE" ) .

:Text a samm:Characteristic ;
samm:description "Describes a Property which contains plain text. This is intended exclusively for human readable strings, not for identifiers, measurement values, etc."@en ;
samm:dataType xsd:string .

:LocalityTechnicalKeyCharacteristic a samm-c:Enumeration ;
samm:preferredName "Locality Technical Key Characteristic"@en ;
samm:description "Characteristic of the technical key of a locality"@en ;
Expand All @@ -219,13 +219,13 @@

:PremiseTechnicalKeyCharacteristic a samm-c:Enumeration ;
samm:preferredName "Premise Technical Key Characteristic"@en ;
samm:description "Characteristic of the technical key of a premise"@en ;
samm:description "Characteristic of the technical key of a premise."@en ;
samm:dataType xsd:string ;
samm-c:values ( "BUILDING" "HARBOUR" "LEVEL" "OTHER" "ROOM" "SUITE" "UNIT" "WAREHOUSE" ) .

:PostalDeliveryPointTechnicalKeyCharacteristic a samm-c:Enumeration ;
samm:preferredName "Postal Delivery Point Technical Key Characteristic"@en ;
samm:description "Characteristic of the technical key of a postal delivery point"@en ;
samm:description "Characteristic of the technical key of a postal delivery point."@en ;
samm:dataType xsd:string ;
samm-c:values ( "INTERURBAN_DELIVERY_POINT" "MAIL_STATION" "MAILBOX" "OTHER" "POST_OFFICE_BOX" ) .

Expand All @@ -239,22 +239,22 @@

:PostCodeTechnicalKeyCharacteristic a samm-c:Enumeration ;
samm:preferredName "Post Code Technical Key Characteristic"@en ;
samm:description "Characteristic for the technical key of a post code"@en ;
samm:description "Characteristic for the technical key of a post code."@en ;
samm:dataType xsd:string ;
samm-c:values ( "CEDEX" "LARGE_MAIL_USER" "OTHER" "POST_BOX" "REGULAR" ) .

:CountryShortNameCharacteristic a samm:Characteristic ;
samm:preferredName "Country Short Name Characteristic"@en ;
samm:description "Characteristic for a short name of a country belonging to an address"@en ;
samm:description "Characteristic for a short name of a country belonging to an address."@en ;
samm:dataType xsd:string .

:CountryShortNameConstraint a samm-c:RegularExpressionConstraint ;
samm:preferredName "CountryShortNameConstraint"@en ;
samm:description "Regular expression for designation of a short name of a country as defined in ISO 3166-2"@en ;
samm:description "Regular expression for designation of a short name of a country as defined in ISO 3166-2."@en ;
samm:value "([A-Z]{2}-[A-Z0-9]{1,3}|)" .

:PostCodeConstraint a samm-c:RegularExpressionConstraint ;
samm:preferredName "Post Code Constraint"@en ;
samm:description "Regular expression for post codes"@en ;
samm:description "Regular expression for post codes."@en ;
samm:value "^[a-z0-9][a-z0-9\\- ]{0,10}$" .

96 changes: 96 additions & 0 deletions io.catenax.shared.contact_information/3.0.0/ContactInformation.ttl
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
#######################################################################
# Copyright (c) 2023 Robert Bosch Manufacturing Solutions GmbH
# Copyright (c) 2023 T-Systems International GmbH
# Copyright (c) 2023 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This work is made available under the terms of the
# Creative Commons Attribution 4.0 International (CC-BY-4.0) license,
# which is available at
# https://creativecommons.org/licenses/by/4.0/legalcode.
#
# SPDX-License-Identifier: CC-BY-4.0
#######################################################################

@prefix samm: <urn:samm:org.eclipse.esmf.samm:meta-model:2.0.0#> .
@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.0.0#> .
@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.0.0#> .
@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.0.0#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.shared.contact_information:3.0.0#> .

:ContactInformation a samm:Aspect ;
samm:preferredName "Contact Information"@en ;
samm:description "Entity encapsulating the contact details."@en ;
samm:see <https://www.plattform-i40.de/IP/Redaktion/DE/Downloads/Publikation/Spezifikation_Submodel-Templates.html> ;
samm:properties ( :contactProperty ) ;
samm:operations ( ) ;
samm:events ( ) .

:contactProperty a samm:Property ;
samm:preferredName "Contact Property"@en ;
samm:description "Property describing contact information for an organization."@en ;
samm:characteristic :ContactCharacteristic .

:ContactCharacteristic a samm:Characteristic ;
samm:preferredName "Contact Characteristic"@en ;
samm:description "Characteristic describing information on how to contact an organization."@en ;
samm:dataType :ContactEntity .

:ContactEntity a samm:Entity ;
samm:preferredName "Contact Entity"@en ;
samm:description "Entity to bundle the properties for the information on how to contact an organization."@en ;
samm:properties ( [ samm:property :website; samm:optional true ] [ samm:property :phoneNumber; samm:optional true ] [ samm:property :email; samm:optional true ] [ samm:property :faxNumber; samm:optional true ] ) .

:website a samm:Property ;
samm:preferredName "Website"@en ;
samm:description "Website of the contact."@en ;
samm:characteristic :WebsiteCharacteristic ;
samm:exampleValue "https://www.samsung.com"^^xsd:anyURI .

:phoneNumber a samm:Property ;
samm:preferredName "Phone Number"@en ;
samm:description "Phone number with country and area code."@en ;
samm:characteristic :PhoneNumberTrait ;
samm:exampleValue "+49 89 1234567890" .

:email a samm:Property ;
samm:preferredName "Email"@en ;
samm:description "An email address."@en ;
samm:characteristic :EMailTrait ;
samm:exampleValue "[email protected]" .

:faxNumber a samm:Property ;
samm:preferredName "Fax Number"@en ;
samm:description "Fax number with country and area code."@en ;
samm:characteristic :PhoneNumberTrait ;
samm:exampleValue "+49 89 0987654321" .

:WebsiteCharacteristic a samm:Characteristic ;
samm:preferredName "Website Characteristic"@en ;
samm:description "Address of the website."@en ;
samm:dataType xsd:anyURI .

:PhoneNumberTrait a samm-c:Trait ;
samm-c:baseCharacteristic samm-c:Text ;
samm-c:constraint :PhoneNumberConstraint .

:EMailTrait a samm-c:Trait ;
samm-c:baseCharacteristic samm-c:Text ;
samm-c:constraint :EMailConstraint .

:PhoneNumberConstraint a samm-c:RegularExpressionConstraint ;
samm:preferredName "PhoneNumber Constraint"@en ;
samm:description "Constraint to allow only numbers, whitespaces and an optional leading + sign."@en ;
samm:value "^[+]?[0-9 ]+$" .

:EMailConstraint a samm-c:RegularExpressionConstraint ;
samm:preferredName "Email Constraint"@en ;
samm:description "Regular expression for mail address as defined in W3C."@en ;
samm:see <https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address> ;
samm:value "^[a-zA-Z0-9.!#$%&?*+\\/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*$" .

1 change: 1 addition & 0 deletions io.catenax.shared.contact_information/3.0.0/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "status" : "release"}
5 changes: 5 additions & 0 deletions io.catenax.shared.contact_information/RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ All notable changes to this model will be documented in this file.

## [Unreleased]

## [3.0.0] - 2023-11-27
### Changed
- samm:io version changed to SAMM 2.0.0
- corrected typos and preffered names

## [2.0.0] - 2023-03-30
### Changed
- bamm:io version changed to 2.0.0
Expand Down

0 comments on commit 82408d0

Please sign in to comment.