From 7916ecd3fe76f05705311654664889c5106d6547 Mon Sep 17 00:00:00 2001 From: Dragan Ivanovic Date: Thu, 5 Oct 2023 15:13:38 +0200 Subject: [PATCH 1/3] Addressing the issue https://github.com/EuroCRIS/CERIF-Core/issues/3 Introducing Simple and Structured Postal Address --- README.md | 2 ++ datatypes/Postal_Address.md | 7 ++----- datatypes/Simple_Postal_Address.md | 13 +++++++++++++ datatypes/Structured_Postal_Address.md | 16 ++++++++++++++++ diagrams/core.puml | 12 +++++++++++- 5 files changed, 44 insertions(+), 6 deletions(-) create mode 100644 datatypes/Simple_Postal_Address.md create mode 100644 datatypes/Structured_Postal_Address.md diff --git a/README.md b/README.md index 8cec832..ea5cec0 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/datatypes/Postal_Address.md b/datatypes/Postal_Address.md index cdcc207..55ef500 100644 --- a/datatypes/Postal_Address.md +++ b/datatypes/Postal_Address.md @@ -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) diff --git a/datatypes/Simple_Postal_Address.md b/datatypes/Simple_Postal_Address.md new file mode 100644 index 0000000..9140071 --- /dev/null +++ b/datatypes/Simple_Postal_Address.md @@ -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. + diff --git a/datatypes/Structured_Postal_Address.md b/datatypes/Structured_Postal_Address.md new file mode 100644 index 0000000..ca67b97 --- /dev/null +++ b/datatypes/Structured_Postal_Address.md @@ -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. + diff --git a/diagrams/core.puml b/diagrams/core.puml index 3f0c0fd..52928c5 100644 --- a/diagrams/core.puml +++ b/diagrams/core.puml @@ -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 From 7d08cc9fcba257a31eb0274641beb48fd6ac9d55 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 5 Oct 2023 13:15:03 +0000 Subject: [PATCH 2/3] :rocket: adding generated diagrams --- diagrams/activity.svg | 18 +- diagrams/application.svg | 44 ++--- diagrams/contributionToDocument.svg | 14 +- diagrams/core.svg | 248 +++++++++++++++------------- diagrams/membership.svg | 10 +- 5 files changed, 179 insertions(+), 155 deletions(-) diff --git a/diagrams/activity.svg b/diagrams/activity.svg index 010fcbe..187cf52 100644 --- a/diagrams/activity.svg +++ b/diagrams/activity.svg @@ -12,30 +12,30 @@ class Contribution_to_Event-->EventInvolvementGroup_or_Organisation_UnitAffiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>Affiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>MembershipEducationEmploymentprove0..*0..*actor0..*0..1provides0..1provides0..1documentdocumentprojecteventeventinvolved in0..*is the foundation for0..*0..*part0..*0..1part transitive0..*0..*is the foundation for0..*0..*part0..*0..1part transitive0..*0..*affilations0..*0..*is detailed in0..*affilations0..*0..*is detailed in0..*Call_for_ApplicationsCall_for_ApplicationsAgentlifetime : Date_RangeApplicationdate : DateResource_OfferApplicationdate : DateResource_OfferDocumentDOI : DOItitle : Multilingual_StringpublicationDate : DateResource_RequestResource_RequestResourceConditionConditionFundingFunding_ApplicationCall_for_Funding_Applicationsissuerin response to0..10..*applicant0..1addressee0..1contents0..1of0..*1..*has0..*described in0..10..*described in0..10..*revise0..*0..1of0..*1..*Funding_ApplicationCall_for_Funding_Applicationsissuerin response to0..10..*applicant0..1addressee0..1contents0..1of0..*1..*has0..*described in0..10..*described in0..10..*revise0..*0..1of0..*1..*is part of0..*0..*ResourceContribution_to_DocumentTextual_DocumentAffiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>Affiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>FundingResource_Usage_Statementstatement : Multilingual_Stringprove0..*0..*actor0..*0..1provides0..1provides0..1documentis detailed in0..*documentis detailed in0..*affilations0..*0..*affilations0..*0..*is part of0..*0..*uses0..*uses0..*Agentlifetime : Date_RangePersonname : Person_NameAgent_IdentifierORCID_IdentifierorcidId : ORCID_iD«DataType»Person_NamefirstNames : Multilingual_StringfamilyNames : Multilingual_StringotherNames : Multilingual_StringOrganisation_Unitname : Multilingual_Stringacronym : Stringaddress : Postal_AddressrorId : ROR_IDwebSiteURL : URIemail : URI«DataType»Postal_Addressstreet : Multilingual_Stringcity : Multilingual_StringzipCode : Multilingual_Stringcountry : CountryGroup_or_Organisation_UnitGroupOrganisation_Unit_with_MembersActivitydateRange : Date_RangeInvolvementEmploymentEducationMembershipContributionContribution_to_ProjectContribution_to_DocumentContribution_to_EventDocumentDOI : DOItitle : Multilingual_StringpublicationDate : DateResourceFundingTextual_DocumentProjectEventContribution_Statementstatement : Multilingual_StringResource_Usage_Statementstatement : Multilingual_StringTextual_Document_Accessibility_SpecificationAuthorshipcorrespondingAuthorFlag : Boolean«DataType»Countryiso3166alpha2Code : ISO_3166_Alpha2_Codename : Multilingual_StringAffiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>Applicationdate : DateDecisiondate : DateFunding_ApplicationCall_for_ApplicationsCall_for_Funding_ApplicationsEvaluation_OutcomeContribution_to_Evaluation_OutcomeApplication_ReviewPrizePrize_AwardResource_OfferConditionResource_RequestExpertise_and_SkillsExpertise_and_Skills_PossessionExpertise_and_Skills_ConditionExpertise_and_Time_and_Effortamount_of_time_in_person_hours : DecimalPosition_TitleAgentlifetime : Date_RangePersonname : Person_NameAgent_IdentifierORCID_IdentifierorcidId : ORCID_iD«DataType»Person_NamefirstNames : Multilingual_StringfamilyNames : Multilingual_StringotherNames : Multilingual_StringOrganisation_Unitname : Multilingual_Stringacronym : Stringaddress : Postal_AddressrorId : ROR_IDwebSiteURL : URIemail : URI«DataType»Postal_Addresscountry : CountryGroup_or_Organisation_UnitGroupOrganisation_Unit_with_MembersActivitydateRange : Date_RangeInvolvementEmploymentEducationMembershipContributionContribution_to_ProjectContribution_to_DocumentContribution_to_EventDocumentDOI : DOItitle : Multilingual_StringpublicationDate : DateResourceFundingTextual_DocumentProjectEventContribution_Statementstatement : Multilingual_StringResource_Usage_Statementstatement : Multilingual_StringTextual_Document_Accessibility_SpecificationAuthorshipcorrespondingAuthorFlag : Boolean«DataType»Simple_Postal_Addressaddress : Multilingual_String«DataType»Structured_Postal_Addressstreet : Multilingual_Stringcity : Multilingual_StringzipCode : Multilingual_String«DataType»Countryiso3166alpha2Code : ISO_3166_Alpha2_Codename : Multilingual_StringAffiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>Applicationdate : DateDecisiondate : DateFunding_ApplicationCall_for_ApplicationsCall_for_Funding_ApplicationsEvaluation_OutcomeContribution_to_Evaluation_OutcomeApplication_ReviewPrizePrize_AwardResource_OfferConditionResource_RequestExpertise_and_SkillsExpertise_and_Skills_PossessionExpertise_and_Skills_ConditionExpertise_and_Time_and_Effortamount_of_time_in_person_hours : DecimalPosition_Titlehas identifier0..*1nameaddress0..1address0..1is part of0..*0..*projectcountryapplicant0..1addressee0..1issuerof0..10..*in response to0..10..*contents0..1on0..1expressed in0..1make0..*form the basis for0..1addressaffilations0..*0..*is detailed in0..*documenteventprovides0..1uses0..*0..*0..1 authorhas access0..*0..* authoredDocuments0..* authorsof0..*recipientby whomfor0..1for0..1for0..1of0..*1..*has0..*described in0..10..*described in0..10..*revise0..*0..1of0..*1..*0..*0..*prove0..*0..*0..*of0..*position0..*0..1contract0..10..*position0..*0..1is the foundation for0..*0..*part0..*0..1part transitive0..*0..*projectcountryapplicant0..1addressee0..1issuerof0..10..*in response to0..10..*contents0..1on0..1expressed in0..1make0..*form the basis for0..1addressaffilations0..*0..*is detailed in0..*documenteventprovides0..1uses0..*0..*0..1 authorhas access0..*0..* authoredDocuments0..* authorsof0..*recipientby whomfor0..1for0..1for0..1of0..*1..*has0..*described in0..10..*described in0..10..*revise0..*0..1of0..*1..*0..*0..*prove0..*0..*0..*of0..*position0..*0..1contract0..10..*position0..*0..1is the foundation for0..*0..*part0..*0..1part transitive0..*0..*> #ffffff { iso3166alpha2Code : ISO_3166_Alpha2_Code name : Multilingual_String diff --git a/diagrams/membership.svg b/diagrams/membership.svg index 5cd5094..46ec336 100644 --- a/diagrams/membership.svg +++ b/diagrams/membership.svg @@ -10,7 +10,7 @@ class Group-->Group_or_Organisation_UnitOrganisation_Unitname : Multilingual_Stringacronym : Stringaddress : Postal_AddressrorId : ROR_IDwebSiteURL : URIemail : URIOrganisation_Unit_with_MembersAffiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>Affiliation_StatementdisplayAffiliation_Statement : StringdisplayPersonName : Stringaddress : Postal_Addresscontacts : List<URI>prove0..*0..*actor0..*0..1involved in0..*is the foundation for0..*0..*part0..*0..1part transitive0..*0..*affilations0..*0..*is the foundation for0..*0..*part0..*0..1part transitive0..*0..*affilations0..*0..*