Darwin Core XML guide

Title
Plant-Pollinator Interactions Vocabulary XML guide
Date version issued
2021-12-03
Date created
2021-12-03
Part of Standard
http://www.rebipp.org.br/standards/ppi/
This version
http://rs.rebipp.org.br/ppi/terms/guides/xml/2021-12-03
Latest version
http://rs.rebipp.org.br/ppi/terms/guides/xml
Previous version
http://rs.rebipp.org.br/ppi/terms/guides/xml/2021-12-03
Abstract
Guidelines for implementing Plant-Pollinator Interactions in XML.
Contributors
Jose A Salim (Universidade de São Paulo), Paula Zermoglio (Universidad de Buenos Aires), Debora P Drucker (Embrapa Agricultura Digital), Filipi Soares (Universidade de São Paulo), Antonio M Saraiva (Universidade de São Paulo)
Creator
REBIPP Maintenance Group
Bibliographic citation
REBIPP Maintenance Group. 2021. Plant-Pollinator Interactions XML guide. Brazilian Network on Plant-Pollinator Interactions (REBIPP). http://rs.rebipp.org.br/ppi/terms/guides/xml/2021-12-03

1 Introduction

This document provides guidelines for implementing application schemas based on PPI terms and Darwin Core terms using XML. The underlying metadata model is described (in a syntax neutral way), followed by some specific guidelines for XML implementations.

This document does not provide guidelines for encoding Plant-Pollinator Interactions data in RDF/XML. Nor does it take a position on the relative merits of encoding metadata in “plain” XML rather than RDF/XML. This document provides guidelines in those cases where RDF/XML is not considered appropriate.

1.1 Status of the content of this document

All sections of this document are normative, except for sections that are explicitly marked as non-normative.

1.1.1 RFC 2119 key words

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

1.2 Audience

This document is targeted toward those who wish to use or construct application schemas using PPI terms in XML. It includes explanations of existing schemas and how to build new schemas to meet specific models of information.

2 Implementation guide

2.1 XML schema

Implementors SHOULD base their XML applications on XML Schemas rather than XML DTDs. Approaches based on XML Schemas are more flexible and are more easily re-used within other XML applications.

2.2 XML namespaces

Implementors MUST use XML Namespaces to uniquely identify elements. Plant-Pollinator Interactions Vocabulary namespaces are defined in the Plant-Pollinator Interactions vocabulary namespace policy, the Darwin Core namespaces are defined in the Darwin Core Namespace Policy, while Dublin Core namespaces are defined in the DCMI Namespace Recommendation.

2.3 Abstract model

The Darwin Core follows the Dublin Core Metadata Initiative Abstract Model except that the Darwin Core record is roughly equivalent to the Dublin Core resource.

  • Darwin Core terms MUST be either classes or properties.
  • A Darwin Core record MUST be made up of zero or more classes and one or more properties with their associated values.
  • Each value MUST be a literal string.
  • The values of properties within a Darwin Core record describe that record.
  • A Darwin Core record MUST include all required properties, if any, and their associated values.
  • Plant-Pollinator Interactions Vocabulary terms MUST be used as controlled vocabulary for dwc:measurementType term.
  • Plant-Pollinator Interactions Controlled Vocabulary terms MUST be used as controlled vocabulary for dwc:measurementValue when appropriated.

2.4 Properties and values

Plant-Pollinator Interactions schema follows the guidelines for expressing Dublin Core metadata using XML except in that implementors MUST encode properties as XML elements and values as the content of those elements instead of having each property contain a value representation and its associated value. The name of the XML element MUST be an XML qualified name (QName), which associates the value given in the Term name attribute in the Darwin Core Terms recommendation with the appropriate namespace name. For example, use:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    targetNamespace="http://rs.tdwg.org/dwc/terms/"
    xmlns:dwc="http://rs.tdwg.org/dwc/terms/"
    xmlns:ppi="https://rs.rebipp.org.br/ppi/terms/">
...
<dwc:measurementType>ppi:resourceCollected</dwc:measurementType>

rather than:

<dwc:measurementType value="ppi:resourceCollected"/>

2.5 Null values

Elements for which the value is null SHOULD be omitted from the document or explicitly coded using the attribute xsi:nil="true".

<dwc:measurementValue xsi:nil="true"/>

An empty string - an element with no content - MUST NOT be used:

<dwc:measurementValue></dwc:measurementValue>

2.6 Examples (non-normative)

Following is an example of using a normalized class-based schema to represent a interaction of two specimen occurrences from one interaction Event. In this example a individual of Euterpe edulis was found to have flowers visited by a Apis mellifera individual. Note the reuse of class instances by referring to the identifiers declared in the instances of those classes:

```xml <?xml version=”1.0” encoding=”UTF-8”?>

REBIPP:OCC:00101 HumanObservation Kayna Agostini REBIPP:PPI:0001 REBIPP:OCC:00102 HumanObservation Kayna Agostini REBIPP:PPI:0001 REBIPP:PPI:0001 2000-01-05 REBIPP:LOC:0001 REBIPP:LOC:0001 Brazil BR -47.0680352 -22.8261888 Kayna Agostini 2000-01-05 REBIPP:OCC:00101 https://www.gbif.org/species/5293403 https://www.gbif.org/species/5293403 Euterpe edulis Mart. species Euterpe edulis Kayna Agostini 2000-01-05 REBIPP:OCC:00102 https://www.gbif.org/species/1341976 https://www.gbif.org/species/1341976 Apis mellifera (Linnaeus, 1758) species Apis mellifera REBIPP:PPI:0001 REBIPP:OCC:00101 has flowers visited bt http://purl.obolibrary.org/obo/RO_0002623 REBIPP:OCC:00102 REBIPP:MOF:0001 REBIPP:PPI:00001 ppi:resourceCollected pollen </obis:ExtendedMeasurementOrFact> REBIPP:MOF:0002 REBIPP:PPI:00001 REBIPP:OCC:00101 http://rs.rebipp.org.br/ppi/terms/habit ppi:habit http://purl.obolibrary.org/obo/FLOPO_0900033 whole plant arborescent REBIPP:MOF:0003 REBIPP:PPI:00001 REBIPP:OCC:00101 http://rs.rebipp.org.br/ppi/terms/flowerLongevity ppi:flowerLongevity 168 REBIPP:MOF:0004 REBIPP:PPI:00001 REBIPP:OCC:00102 http://rs.rebipp.org.br/ppi/terms/caste ppi:caste worker </dwr:DarwinRecordSet>```