Skip to content

Commit

Permalink
Addressing the issue #3
Browse files Browse the repository at this point in the history
Introducing Simple and Structured Postal Address
  • Loading branch information
chenejac committed Oct 5, 2023
1 parent 580db84 commit 7916ecd
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 6 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ for instance the [ORCID Identifier](./entities/ORCID_Identifier.md).
* [Wikidata ID Type](./datatypes/Wikidata_ID.md)
* [Person Name](./datatypes/Person_Name.md)
* [Postal Address](./datatypes/Postal_Address.md)
* [Simple Postal Address](./datatypes/Simple_Postal_Address.md)
* [Structured Postal Address](./datatypes/Structured_Postal_Address.md)
* [Language](./datatypes/Language.md), [Country](./datatypes/Country.md), [Script](./datatypes/Script.md)
* [Language Tag](./datatypes/Language_Tag.md)
* [Monetary Amount](./datatypes/Monetary_Amount.md)
Expand Down
7 changes: 2 additions & 5 deletions datatypes/Postal_Address.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,10 @@ The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md

## Components

- street : [Multilingual String](../datatypes/Multilingual_String.md)
- city : [Multilingual String](../datatypes/Multilingual_String.md)
- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md)
- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.md)
- country : [Country](../datatypes/Country.md)

## Notes

The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations.
Please note there are two specializations of this data type providing more or less structured details about a postal
address [Simple Postal Address](../datatypes/Simple_Postal_Address.md) and [Structured Postal Address](../datatypes/Structured_Postal_Address.md)

13 changes: 13 additions & 0 deletions datatypes/Simple_Postal_Address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Simple Postal Address

This data type is used when a string representation of postal address is used.

## Components

- address : [Multilingual String](../datatypes/Multilingual_String.md)

## Notes

The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations.
This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.

16 changes: 16 additions & 0 deletions datatypes/Structured_Postal_Address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Structured Postal Address

This data type is used when a structured representation of postal address is used.

## Components

- street : [Multilingual String](../datatypes/Multilingual_String.md)
- city : [Multilingual String](../datatypes/Multilingual_String.md)
- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md)
- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.md)

## Notes

The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations.
This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.

12 changes: 11 additions & 1 deletion diagrams/core.puml
Original file line number Diff line number Diff line change
Expand Up @@ -275,11 +275,21 @@

!startsub Postal_Address
datatype("Postal_Address") {
country : Country
}

datatype("Simple_Postal_Address") {
address : Multilingual_String
}

datatype("Structured_Postal_Address") {
street : Multilingual_String
city : Multilingual_String
zipCode : Multilingual_String
country : Country
}

"Postal_Address" <|-d- "Simple_Postal_Address"
"Postal_Address" <|-d- "Structured_Postal_Address"
!endsub

!startsub Country
Expand Down

0 comments on commit 7916ecd

Please sign in to comment.