Skip to content

Commit

Permalink
Add Local Resource ID (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenejac committed May 27, 2024
1 parent 4a42f82 commit ee70139
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 9 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ for instance the [ORCID Identifier](./entities/ORCID_Identifier.md), [ROR Identi
or [Local Agent Identifier](./entities/Local_Agent_Identifier.md).

A Resource can have any number of [Resource Identifiers](./entities/Resource_Identifier.md) assigned,
for instance the [DOI Identifier](./entities/DOI_Identifier.md), or [Wikidata Resource Identifier](./entities/Wikidata_Resource_Identifier.md).
for instance the [DOI Identifier](./entities/DOI_Identifier.md), [Wikidata Resource Identifier](./entities/Wikidata_Resource_Identifier.md), or [Local Resource Identifier](./entities/Local_Resource_Identifier.md).

## Listings

Expand All @@ -82,26 +82,27 @@ for instance the [DOI Identifier](./entities/DOI_Identifier.md), or [Wikidata Re
* [Membership](./entities/Membership.md)
* [Employment](./entities/Employment.md)
* [Education](./entities/Education.md)
* [Document](./entities/Document.md)
* [Textual Document](./entities/Textual_Document.md)
* [Affiliation](./entities/Affiliation_Statement.md)
* [Contribution Statement](./entities/Contribution_Statement.md)
* [Textual Document Accessibility Specification](./entities/Textual_Document_Accessibility_Specification.md)
* [Project](./entities/Project.md)
* [Event](./entities/Event.md)
* [Publication Channel](./entities/Publication_Channel.md)
* [Resource](./entities/Resource.md)
* [Funding](./entities/Funding.md)
* [Expertise and Time and Effort](./entities/Expertise_and_Time_and_Effort.md)
* [Infrastructure](./entities/Infrastructure.md)
* [Document](./entities/Document.md)
* [Textual Document](./entities/Textual_Document.md)
* [Resource Offer](./entities/Resource_Offer.md)
* [Call for Applications](./entities/Call_for_Applications.md)
* [Call for Funding Applications](./entities/Call_for_Funding_Applications.md)
* [Resource Request](./entities/Resource_Request.md)
* [Application](./entities/Application.md)
* [Funding Application](./entities/Funding_Application.md)
* [Resource Usage Statement](./entities/Resource_Usage_Statement.md)
* [Condition](./entities/Condition.md)
* [Expertise and Skills Condition](./entities/Expertise_and_Skills_Condition.md)
* [Call for Applications](./entities/Call_for_Applications.md)
* [Call for Funding Applications](./entities/Call_for_Funding_Applications.md)
* [Application](./entities/Application.md)
* [Funding Application](./entities/Funding_Application.md)
* [Evaluation Outcome](./entities/Evaluation_Outcome.md)
* [Decision](./entities/Decision.md)
* [Prize](./entities/Prize.md)
Expand All @@ -119,6 +120,7 @@ for instance the [DOI Identifier](./entities/DOI_Identifier.md), or [Wikidata Re
* [Resource Identifier](./entities/Resource_Identifier.md)
* [DOI identifier](./entities/DOI_Identifier.md)
* [Wikidata Resource Identifier](./entities/Wikidata_Resource_Identifier.md)
* [Local Resource Identifier](./entities/Local_Resource_Identifier.md)

### Data Types
* [String](./datatypes/String.md)
Expand All @@ -135,6 +137,7 @@ for instance the [DOI Identifier](./entities/DOI_Identifier.md), or [Wikidata Re
* [Wikidata ID Type](./datatypes/Wikidata_ID.md)
* [Scopus Author ID Type](./datatypes/Scopus_Author_ID.md)
* [Local Agent ID Type](./datatypes/Local_Agent_ID.md)
* [Local Resource ID Type](./datatypes/Local_Resource_ID.md)
* [Person Name](./datatypes/Person_Name.md)
* [Physical Address](./datatypes/Physical_Address.md)
* [Simple Physical Address](./datatypes/Simple_Physical_Address.md)
Expand Down
2 changes: 1 addition & 1 deletion datatypes/Local_Agent_ID.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
The datatype that represents a local identifier.

## Notes
If some restriction is needed for a specific local identifier, Local Agent ID Type should be specialized by defining regular expression
If some restriction is needed for a specific local identifier for an agent, Local Agent ID Type should be specialized by defining regular expression
or any other restriction over String. An example of defining restriction over String can be found in the definition of [ISNI ID](../datatypes/ISNI_ID.md).
An example of defining specification of a data type can be found in the relation between [Postal Address](../datatypes/Postal_Address.md) and
[Structured Physical Address](../datatypes/Structured_Physical_Address.md)
Expand Down
14 changes: 14 additions & 0 deletions datatypes/Local_Resource_ID.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Local Resource ID Type

## Definition
The datatype that represents a local identifier.

## Notes
If some restriction is needed for a specific local identifier for a resource, Local Resource ID Type should be specialized by defining regular expression
or any other restriction over String. An example of defining restriction over String can be found in the definition of [ISNI ID](../datatypes/ISNI_ID.md).
An example of defining specification of a data type can be found in the relation between [Postal Address](../datatypes/Postal_Address.md) and
[Structured Physical Address](../datatypes/Structured_Physical_Address.md)

## Based on
[String](../datatypes/String.md)

8 changes: 7 additions & 1 deletion diagrams/core.puml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"Agent_Identifier" <|-- "Wikidata_Agent_Identifier"

class "Local_Agent_Identifier" #ffffff {
localAgentId : Local_Agent_ID
localId : Local_Agent_ID
}

"Agent_Identifier" <|-- "Local_Agent_Identifier"
Expand Down Expand Up @@ -344,6 +344,12 @@

"Resource_Identifier" <|-- "Wikidata_Resource_Identifier"

class "Local_Resource_Identifier" #ffffff {
localId : Local_Resource_ID
}

"Resource_Identifier" <|-- "Local_Resource_Identifier"

!endsub

!startsub Contribution_to_Project
Expand Down
16 changes: 16 additions & 0 deletions entities/Local_Resource_Identifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Local Resource Identifier

## Definition
A local identifier assigned to a [Resource](../entities/Resource.md). Local identifier is not adopted at global level, it
might be some platform identifier, regional identifier or national identifier.

## Specialization of
[Resource Identifier](../entities/Resource_Identifier.md)

## Attributes
Besides those of [Resource Identifier](../entities/Resource_Identifier.md):

Local ID : [Local Resource Identifier Type](../datatypes/Local_Resource_ID.md)

## Relationships
None besides those of [Resource Identifier](../entities/Resource_Identifier.md).

0 comments on commit ee70139

Please sign in to comment.