Abstract

The Allotrope Data Format (ADF) [ADF] consists of several APIs and taxonomies. This document constitutes the specification for the ADF Data Package Ontology (ADF-DPO) which defines the concepts for files, folders and their metadata. The ADF-DPO provides the vocabulary for the operations available by the ADF Data Package API [ADF-DP].

Disclaimer

THESE MATERIALS ARE PROVIDED "AS IS" AND ALLOTROPE EXPRESSLY DISCLAIMS ALL WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, INCLUDING, WITHOUT LIMITATION, THE WARRANTIES OF NON-INFRINGEMENT, TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Status of This Document

This section describes the status of this document at the time of its publication. Other documents may supersede this document. A list of current Allotrope publications and the latest revision of this technical report can be found in the Allotrope technical reports index at http://purl.allotrope.org/TR/.

This document is part of a set of specifications on the Allotrope Data Format [ADF]

This document was published by the Allotrope Foundation as a First Public Working Draft. This document is intended to become an Allotrope Recommendation. If you wish to make comments regarding this document, please send them to more.info@allotrope.org. All comments are welcome.

Publication as a First Public Working Draft does not imply endorsement by the Allotrope Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

Table of Contents

1. Introduction

The Allotrope Data Format (ADF) defines an interface for experimental data generated in analytical laboratory processes. It is intended for data exchange, long-term preservation and fast real-time data access. The ADF Data Package API [ADF-DP] defines an interface for storing files and folder structures and thus provides one of most essential operations of the ADF. The ADF Data Package Ontology (ADF-DPO) provides concepts and terms which are used by ADF Data Package API operations. The concepts of the ADF-DPO are also used to define consistency and integrity constraints on data files and meta-data during storage and modification.

The ontology will be available for downloaded from http://purl.allotrope.org/ontologies/datapackage .

The document is structured as follows: Next, the requirements for the ADF Data Package Ontology are listed before the key concepts of the ontology and the relation to other ontologies are described.

1.1 Document Conventions

1.1.1 Namespaces

Within the ADF specifications, the following namespace prefix bindings are used:

Prefix Namespace
owl:http://www.w3.org/2002/07/owl#
rdf:http://www.w3.org/1999/02/22-rdf-syntax-ns#
rdfs:http://www.w3.org/2000/01/rdf-schema#
xsd:http://www.w3.org/2001/XMLSchema#
skos:http://www.w3.org/2004/02/skos/core#
dct:http://purl.org/dc/terms/
ldp:http://www.w3.org/ns/ldp#
hdf:http://purl.allotrope.org/ontologies/hdf5/1.8#
adf-dp:http://purl.allotrope.org/ontologies/datapackage#

1.1.2 Indication of Requirement Levels

Within this document the definitions of MUST, SHOULD and MAY are used as defined in [rfc2119].

1.1.3 Number Formatting

Within this document, decimal numbers will use a dot "." as the decimal mark.

2. ADF High-Level Structure

The following figure illustrates the high-level structure of the Allotrope Data Format (ADF):

Fig. 1 The high-level structure of the Allotrope Data Format (ADF) API stack.
This document focuses on the ADF Data Package Ontology, which is used by the ADF Data Package API [ADF-DP] highlighted in the figure above.

3. Requirements

The scope to the ADF Data Package Ontology is the description of the metadata of files and folders within an ADF Data Package. This includes:

4. ADF Data Package Ontology High-level Structure

The ADF Data Package Ontology imports external ontologies:

Fig. 2 ADF Data Package Ontology high-level structure with imported ontologies.

5. ADF Data Package Ontology Concept Details

An overview of the ADF Data Package Ontology is given in the next figure (namespaces are given in parentheses, external ontologies are in grey).

Fig. 3 ADF Data Package Ontology high-level structure.

The key concepts of the ADF Data Package Ontology are adf-dp:File and adf-dp:Folder which are both subclasses of adf-dp:Node. They are described in the following subsections. Detailed descriptions of the entire ontology can be found in [AF-OWL-DOC].

5.1 Node

A node is a resource within the ADF Data Package.

For a node identifier, the name (title), creator and creation time MUST be specified. Modifier and modification time MAY be optionally specified.

5.2 File

A file is a node of information that is meant to store information electronically. The storage is durable in the way that the information is still available after the creating process has closed.

For a file, the same information as for a node is specified. Additionally, the file size, file format, the corresponding HDF data set, the containing folder and - for text files - a line separator and character encoding MUST be specified.

5.3 Folder

A folder is a special kind of node within the file system that is meant to create a hierarchical structure of resources by connecting to parent and child nodes.

For a folder, the same information as for a node is specified. Additionally, the corresponding HDF group and the parent folder MUST be specified.

6. Change History

Version Release Date Remarks
0.4.0 2015-06-29 Initial Working Draft Version
1.0.0 RC 2015-09-17
  • alignment with other ADF specifications
  • updated figure on ADF-DCO classes
  • added figure for ADF-DCO components
  • shortened list of requirements
1.0.0 2015-09-29
  • updated versions, dates and document status
  • fixed broken reference
1.1.0 RC 2016-03-11
  • updated versions, dates and document status
  • added section on number formatting to document conventions
  • updated Fig. 1
1.1.0 RF 2016-03-31
  • updated versions, dates and document status
1.1.5 2016-05-13
  • updated versions and dates
1.2.0 Preview 2016-09-23
  • updated versions and dates
1.2.0 RC 2016-12-07
  • updated versions and dates
1.3.0 Preview 2017-03-31
  • updated versions and dates
1.3.0 RF 2017-06-30
  • updated versions and dates
  • updated images

A. References

A.1 Normative references

[ADF]
Allotrope. Allotrope Data Format Overview. URL: http://purl.allotrope.org/TR/adf/
[ADF-DP]
Allotrope. ADF Data Package API. URL: http://purl.allotrope.org/TR/adf-dp/
[AF-OWL-DOC]
Allotrope. Allotrope Framework OWL Documentation. URL: http://purl.allotrope.org/TR/af-owl-doc/
[DC-TERMS]
Dublin Core Metadata Initiative Terms, version 1.1. 11 October 2010. DCMI Recommendation. URL: http://dublincore.org/documents/2010/10/11/dcmi-terms/
[SKOS]
W3C. SKOS Simple Knowledge Organization System . URL: http://www.w3.org/TR/skos-reference
[rfc2119]
S. Bradner. IETF. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://tools.ietf.org/html/rfc2119

A.2 Informative references

[LDP]
W3C. Linked Data Platform 1.0 Primer. URL: http://www.w3.org/TR/ldp-primer/