Merge pull request #150 from jdvorak001/add-file-location-support

Thanks to @jdvorak001 for * introducing a new **Medium** entity, * adding support for **FileLocations** and * a common **DatesStructure__Group** which is used in _Products_, _Medium_ entities.
openaire · Jun 14, 2023 · 6ecbd0f · 6ecbd0f
2 parents 5c5467a + 2a9b715
commit 6ecbd0f
Show file tree

Hide file tree

Showing 16 changed files with 2,349 additions and 1,568 deletions.
diff --git a/conf/openaire-cerif-profile.xml b/conf/openaire-cerif-profile.xml
diff --git a/docs/_illustrations/data_model_cerif_openaire.png b/docs/_illustrations/data_model_cerif_openaire.png
diff --git a/docs/_illustrations/data_model_cerif_openaire.vue b/docs/_illustrations/data_model_cerif_openaire.vue
diff --git a/docs/cerif_xml_common__datesstructure__group.rst b/docs/cerif_xml_common__datesstructure__group.rst
@@ -0,0 +1,10 @@
+
+.. _cerif_xml_common__datesstructure__group:
+
+DatesStructure__Group
+^^^^^^^^^^^^^^^^^^^^^
+
+.. toctree::
+   :maxdepth: 3
+
+   cerif_xml_common__datesstructure__group_contents
diff --git a/docs/cerif_xml_common__datesstructure__group_contents.rst b/docs/cerif_xml_common__datesstructure__group_contents.rst
@@ -0,0 +1,94 @@
+
+.. _cerif_xml_common__datesstructure__group_contents:
+
+:Description: Dates or date ranges to describe temporal aspects of the product. Semantically follows the dateType construct from the DataCite Metadata Schema 4.4. If an embargo period is to be expressed, its start should be expressed by the ``startDate`` on ``Submitted`` or ``Accepted`` (as appropriate) and end is represented by the ``startDate`` on ``Available``.
+
+Accepted
+========
+:Description: Use the ``startDate`` attribute for the date the publisher accepted the resource into their system.
+:Use: optional (0..1)
+:Representation: XML element ``Accepted``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Accepted>`_ semantics
+
+
+
+Available
+=========
+:Description: Use the ``startDate`` and possibly also ``endDate`` attributes for the dates the resource is or was publicly available.
+:Use: optional (0..1)
+:Representation: XML element ``Available``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Available>`_ semantics
+
+
+
+Copyrighted
+===========
+:Description: Use the ``startDate`` attribute to give the specific, documented date at which the resource receives a copyrighted status, if applicable
+:Use: optional (0..1)
+:Representation: XML element ``Copyrighted``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Copyrighted>`_ semantics
+
+
+
+Collected
+=========
+:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range in which the resource content was collected. To indicate precise or particular timeframes in which research was conducted.
+:Use: optional (0..1)
+:Representation: XML element ``Collected``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Collected>`_ semantics
+
+
+
+Created
+=======
+:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range in which the resource itself was put together.
+:Use: optional (0..1)
+:Representation: XML element ``Created``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Created>`_ semantics
+
+
+
+Issued
+======
+:Description: Use the ``startDate`` attribute for the date the resource was published or distributed, e.g. to a data centre.
+:Use: optional (0..1)
+:Representation: XML element ``Issued``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Issued>`_ semantics
+
+
+
+Submitted
+=========
+:Description: Use the ``startDate`` attribute for the date the creator submits the resource to the publisher. This could be different from Accepted if the publisher then applies a selection process.
+:Use: optional (0..1)
+:Representation: XML element ``Submitted``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Submitted>`_ semantics
+
+
+
+Updated
+=======
+:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range of the last update to the resource, when the resource is being added to.
+:Use: optional (0..1)
+:Representation: XML element ``Updated``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Updated>`_ semantics
+
+
+
+Valid
+=====
+:Description: Use the ``startDate`` and ``endDate`` attributes to indicate the period in which the dataset or resource is accurate.
+:Use: optional (0..1)
+:Representation: XML element ``Valid``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Valid>`_ semantics
+
+
+
+Withdrawn
+=========
+:Description: Use the ``startDate`` attribute for the date the resource is removed.
+:Use: optional (0..1)
+:Representation: XML element ``Withdrawn``
+:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Withdrawn>`_ semantics
+
+
diff --git a/docs/cerif_xml_common_parts.rst b/docs/cerif_xml_common_parts.rst
@@ -0,0 +1,9 @@
+.. cerif_xml_common_parts:
+
+*Common Parts*
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   cerif_xml_common__datesstructure__group
diff --git a/docs/cerif_xml_medium_entity.rst b/docs/cerif_xml_medium_entity.rst
@@ -0,0 +1,100 @@
+.. _medium:
+
+
+Medium
+======
+:Representation: XML element ``Medium``; the rest of this section documents children of this element
+:CERIF: the Medium entity (`<https://w3id.org/cerif/model#Medium>`_)
+
+
+Internal Identifier
+^^^^^^^^^^^^^^^^^^^
+:Use: mandatory (1) in top level entity. When embedded in other entities the Internal Identifier must be included only for managed information (i.e. entities that have a concrete record in the local CRIS system). See `Metadata representation in CERIF XML <https://openaire-guidelines-for-cris-managers.readthedocs.io/en/v1.1.1/implementation.html#metadata-representation-in-cerif-xml>`_
+:Representation: XML attribute ``id``
+:CERIF: the MediumIdentifier attribute (`<https://w3id.org/cerif/model#Medium.MediumIdentifier>`_)
+
+
+Type
+^^^^
+:Description: The type of the medium
+:Use: optional, possibly multiple (0..*)
+:Representation: XML element ``Type`` containing the classification identifier and having a ``scheme`` attribute to specify the classification scheme identifier
+:CERIF: the Medium_Classification (`<https://w3id.org/cerif/model#Medium_Classification>`_)
+
+
+Title
+^^^^^
+:Description: Name of the medium
+:Use: optional, possibly multiple (0..*)
+:Representation: XML element ``Title`` as a multilingual string
+:CERIF: the Medium.Title attribute (`<https://w3id.org/cerif/model#Medium.Title>`_)
+
+
+
+URI
+^^^
+:Description: An URI of this medium
+:Use: optional (0..1)
+:Representation: XML element ``URI``
+:CERIF: the Medium.UniformResourceIdenfier attribute (`<https://w3id.org/cerif/model#Medium.UniformResourceIdenfier>`_)
+
+
+
+MimeType
+^^^^^^^^
+:Description: The MIME type of the medium
+:Use: optional (0..1)
+:Representation: XML element ``MimeType``
+:CERIF: the Medium.MimeType attribute (`<https://w3id.org/cerif/model#Medium.MimeType>`_)
+
+
+
+Size
+^^^^
+:Description: The size (in octets) of the medium
+:Use: optional (0..1)
+:Representation: XML element ``Size``
+:CERIF: the Medium.Size attribute (`<https://w3id.org/cerif/model#Medium.Size>`_)
+
+
+
+Identifier
+^^^^^^^^^^
+:Description: An identifier of this medium
+:Use: optional, possibly multiple (0..*)
+:Representation: XML element ``Identifier`` with a required ``type`` attribute (the URI of the identifier scheme)
+:CERIF: the FederatedIdentifier entity (`<https://w3id.org/cerif/model#FederatedIdentifier>`_)
+
+
+
+ns4:Access
+^^^^^^^^^^
+:Description: The open access type
+:Use: optional (0..1)
+:Representation: XML element ``Access`` from namespace `<http://purl.org/coar/access_right>`_
+:CERIF: the Medium_Classification (`<https://w3id.org/cerif/model#Medium_Classification>`_)
+:Vocabulary: 
+
+  * **open access** (`<http://purl.org/coar/access_right/c_abf2>`_): Open access refers to a resource that is immediately and permanently online, and free for all on the Web, without financial and technical barriers.The resource is either stored in the repository or referenced to an external journal or trustworthy archive.
+  * **embargoed access** (`<http://purl.org/coar/access_right/c_f1cf>`_): Embargoed access refers to a resource that is metadata only access until released for open access on a certain date. Embargoes can be required by publishers and funders policies, or set by the author (e.g such as in the case of theses and dissertations).
+  * **restricted access** (`<http://purl.org/coar/access_right/c_16ec>`_): Restricted access refers to a resource that is available in a system but with some type of restriction for full open access. This type of access can occur in a number of different situations. Some examples are described below: The user must log-in to the system in order to access the resource The user must send an email to the author or system administrator to access the resource Access to the resource is restricted to a specific community (e.g. limited to a university community)
+  * **metadata only access** (`<http://purl.org/coar/access_right/c_14cb>`_): Metadata only access refers to a resource in which access is limited to metadata only. The resource itself is described by the metadata, but neither is directly available through the system or platform nor can be referenced to an open access copy in an external journal or trustworthy archive.
+
+
+
+License
+^^^^^^^
+:Description: The license of the file. We recommend using URIs from the SPDX License List (https://spdx.org/licenses/), which includes the Creative Commons licenses.
+:Use: optional, possibly multiple (0..*)
+:Representation: XML element ``License`` containing the classification identifier and having a ``scheme`` attribute to specify the classification scheme identifier
+:CERIF: the Medium_Classification (`<https://w3id.org/cerif/model#Medium_Classification>`_)
+
+
+Dates
+^^^^^
+:Use: optional (0..1)
+:Representation: XML element ``Dates`` with  embedded XML elements ``Accepted`` or ``Available`` or ``Copyrighted`` or ``Collected`` or ``Created`` or ``Issued`` or ``Submitted`` or ``Updated`` or ``Valid`` or ``Withdrawn`` from the shared structure :ref:`DatesStructure__Group<cerif_xml_common__DatesStructure__Group>`
+
+
+
+
diff --git a/docs/cerif_xml_patent_entity.rst b/docs/cerif_xml_patent_entity.rst
@@ -196,4 +196,13 @@ References
 
 
 
+FileLocations
+^^^^^^^^^^^^^
+:Description: The files that this Patent has as contents.
+:Use: optional (0..1)
+:Representation: XML element ``FileLocations`` with embedded XML element ``Medium``
+:CERIF: the ResultPatent_Medium linking entity (`<https://w3id.org/cerif/model#ResultPatent_Medium>`_) with the `<https://w3id.org/cerif/vocab/MediaRelations#Contents>`_ semantics
+
+
+
 
diff --git a/docs/cerif_xml_product_entity.rst b/docs/cerif_xml_product_entity.rst
@@ -272,97 +272,16 @@ Dates
 ^^^^^
 :Description: Dates or date ranges to describe temporal aspects of the product. Semantically follows the dateType construct from the DataCite Metadata Schema 4.4. If an embargo period is to be expressed, its start should be expressed by the ``startDate`` on ``Submitted`` or ``Accepted`` (as appropriate) and end is represented by the ``startDate`` on ``Available``.
 :Use: optional (0..1)
-:Representation: XML element ``Dates`` with  embedded XML elements ``Accepted`` or ``Available`` or ``Copyrighted`` or ``Collected`` or ``Created`` or ``Issued`` or ``Submitted`` or ``Updated`` or ``Valid`` or ``Withdrawn``
+:Representation: XML element ``Dates`` with  embedded XML elements ``Accepted`` or ``Available`` or ``Copyrighted`` or ``Collected`` or ``Created`` or ``Issued`` or ``Submitted`` or ``Updated`` or ``Valid`` or ``Withdrawn`` from the shared structure :ref:`DatesStructure__Group<cerif_xml_common__DatesStructure__Group>`
 
 
 
-Accepted
---------
-:Description: Use the ``startDate`` attribute for the date the publisher accepted the resource into their system.
+FileLocations
+^^^^^^^^^^^^^
+:Description: The files that this Product has as contents.
 :Use: optional (0..1)
-:Representation: XML element ``Accepted``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Accepted>`_ semantics
-
-
-
-Available
----------
-:Description: Use the ``startDate`` and possibly also ``endDate`` attributes for the dates the resource is or was publicly available.
-:Use: optional (0..1)
-:Representation: XML element ``Available``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Available>`_ semantics
-
-
-
-Copyrighted
------------
-:Description: Use the ``startDate`` attribute to give the specific, documented date at which the resource receives a copyrighted status, if applicable
-:Use: optional (0..1)
-:Representation: XML element ``Copyrighted``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Copyrighted>`_ semantics
-
-
-
-Collected
----------
-:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range in which the resource content was collected. To indicate precise or particular timeframes in which research was conducted.
-:Use: optional (0..1)
-:Representation: XML element ``Collected``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Collected>`_ semantics
-
-
-
-Created
--------
-:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range in which the resource itself was put together.
-:Use: optional (0..1)
-:Representation: XML element ``Created``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Created>`_ semantics
-
-
-
-Issued
-------
-:Description: Use the ``startDate`` attribute for the date the resource was published or distributed, e.g. to a data centre.
-:Use: optional (0..1)
-:Representation: XML element ``Issued``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Issued>`_ semantics
-
-
-
-Submitted
----------
-:Description: Use the ``startDate`` attribute for the date the creator submits the resource to the publisher. This could be different from Accepted if the publisher then applies a selection process.
-:Use: optional (0..1)
-:Representation: XML element ``Submitted``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Submitted>`_ semantics
-
-
-
-Updated
--------
-:Description: Use the ``startDate`` and ``endDate`` attributes to describe the date range of the last update to the resource, when the resource is being added to.
-:Use: optional (0..1)
-:Representation: XML element ``Updated``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Updated>`_ semantics
-
-
-
-Valid
------
-:Description: Use the ``startDate`` and ``endDate`` attributes to indicate the period in which the dataset or resource is accurate.
-:Use: optional (0..1)
-:Representation: XML element ``Valid``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Valid>`_ semantics
-
-
-
-Withdrawn
----------
-:Description: Use the ``startDate`` attribute for the date the resource is removed.
-:Use: optional (0..1)
-:Representation: XML element ``Withdrawn``
-:CERIF: the ResultProduct_Classification linking entity (`<https://w3id.org/cerif/model#ResultProduct_Classification>`_) with the `<https://w3id.org/cerif/vocab/DataCiteMetadataSchema_DateType#Withdrawn>`_ semantics
+:Representation: XML element ``FileLocations`` with embedded XML element ``Medium``
+:CERIF: the ResultProduct_Medium linking entity (`<https://w3id.org/cerif/model#ResultProduct_Medium>`_) with the `<https://w3id.org/cerif/vocab/MediaRelations#Contents>`_ semantics
 
 
 

diff --git a/docs/cerif_xml_publication_entity.rst b/docs/cerif_xml_publication_entity.rst
@@ -487,4 +487,13 @@ ns4:Access
 
 
 
+FileLocations
+^^^^^^^^^^^^^
+:Description: The files that this Publication has as contents.
+:Use: optional (0..1)
+:Representation: XML element ``FileLocations`` with embedded XML element ``Medium``
+:CERIF: the ResultPublication_Medium linking entity (`<https://w3id.org/cerif/model#ResultPublication_Medium>`_) with the `<https://w3id.org/cerif/vocab/MediaRelations#Contents>`_ semantics
+
+
+
 
diff --git a/docs/cris_elements_openaire.rst b/docs/cris_elements_openaire.rst
@@ -43,3 +43,7 @@ Extensions are possible in the review phase of these Guidelines.
    cerif_xml_equipment_entity
 
    cerif_xml_event_entity
+
+   cerif_xml_medium_entity
+
+   cerif_xml_common_parts
diff --git a/samples/openaire_cerif_xml_example_orgunits.xml b/samples/openaire_cerif_xml_example_orgunits.xml
@@ -223,6 +223,20 @@
                 </OrgUnit>
             </metadata>
         </record>
+        <record>
+            <header>
+                <identifier>oai:cris.example.org:OrgUnits/345322</identifier>
+                <datestamp>2018-01-07T14:00:00Z</datestamp>
+                <setSpec>openaire_cris_orgunits</setSpec>
+            </header>
+            <metadata>
+                <OrgUnit xmlns="https://www.openaire.eu/cerif-profile/1.1/" id="OrgUnits/345322">
+					<Acronym>ORCID</Acronym>
+					<Name xml:lang="en">ORCID Inc.</Name>
+					<RORID>https://ror.org/04fa4r544</RORID>
+                </OrgUnit>
+            </metadata>
+        </record>
 
 	</ListRecords>
 </OAI-PMH>