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]].
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.
This document is part of a set of specifications on the Allotrope Data Format [[!ADF]]
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.
Within the ADF specifications, the following namespace prefix bindings are used:
Within this document the definitions of MUST, SHOULD and MAY are used as defined in [[!rfc2119]].
Within this document, decimal numbers will use a dot "." as the decimal mark.
The following figure illustrates the high-level structure of the Allotrope Data Format (ADF): 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.
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:
The ADF Data Package Ontology imports external ontologies:
An overview of the ADF Data Package Ontology is given in the next figure (namespaces are given in parentheses, external ontologies are in grey).
The key concepts of the ADF Data Package Ontology are
adf-dp:Folder which are both subclasses of
They are described in the following subsections.
Detailed descriptions of the entire ontology can be found in [[!AF-OWL-DOC]].
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.
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 HDF5 dataset, the containing folder and - for text files - a line separator and character encoding MUST be specified.
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 HDF5 group and the parent folder MUST be specified.