DataPackage-class


The DataPackage class provides methods for added and extracting
data objects from a datapackage. The contents of a package
can be determined and the package can be prepared for transport before being
uploaded to a data repository or archived.


Provides a flexible container to transport and
manipulate complex sets of data. These data may consist of multiple data files and
associated meta data and ancillary files. Individual data objects have
associated system level meta data, and data files are linked together using
the OAI-ORE standard resource map which describes the relationships between the files.
The OAI-ORE standard is described at <https://www.openarchives.org/ore>. Data packages
can be serialized and transported as structured files that have been created following
the BagIt specification. The BagIt specification is described at
<https://tools.ietf.org/html/draft-kunze-bagit-08>.

Matthew B Jones

datapack

A Flexible Container to Transport and Manipulate Data and Associated Resources

DataPackage-class function

 <dl>
<dt><code>relations</code></dt><dd>A hash containing provenance relationships of package objects</dd> <dt><code>objects</code></dt><dd>A hash containing identifiers for data object in the DataPackage</dd> <dt><code>sysmeta</code></dt><dd>A SystemMetadata class instance describing the package</dd> </dl>

Slots

 <ul>
<li><code><a rd-options="=DataPackage-initialize" href="/link/initialize?package=datapack&version=1.0.1&to=%3DDataPackage-initialize" data-mini-rdoc="=DataPackage-initialize::initialize">initialize</a></code>: Initialize a DataPackage object
 </li>
<li><code><a rd-options="" href="/link/getData?package=datapack&version=1.0.1" data-mini-rdoc="datapack::getData">getData</a></code>: Get the data content of a specified data object
 </li>
<li><code><a rd-options="" href="/link/getSize?package=datapack&version=1.0.1" data-mini-rdoc="datapack::getSize">getSize</a></code>: Get the Count of Objects in the Package
 </li>
<li><code><a rd-options="" href="/link/getIdentifiers?package=datapack&version=1.0.1" data-mini-rdoc="datapack::getIdentifiers">getIdentifiers</a></code>: Get the Identifiers of Package Members
 </li>
<li><code><a rd-options="" href="/link/addData?package=datapack&version=1.0.1" data-mini-rdoc="datapack::addData">addData</a></code>: Add a DataObject to the DataPackage
 </li>
<li><code><a rd-options="" href="/link/insertRelationship?package=datapack&version=1.0.1" data-mini-rdoc="datapack::insertRelationship">insertRelationship</a></code>: Record relationships of objects in a DataPackage
 </li>
<li><code><a rd-options="" href="/link/recordDerivation?package=datapack&version=1.0.1" data-mini-rdoc="datapack::recordDerivation">recordDerivation</a></code>: Record derivation relationships between objects in a DataPackage
 </li>
<li><code><a rd-options="" href="/link/getRelationships?package=datapack&version=1.0.1" data-mini-rdoc="datapack::getRelationships">getRelationships</a></code>: Retrieve relationships of package objects
 </li>
<li><code><a rd-options="" href="/link/containsId?package=datapack&version=1.0.1" data-mini-rdoc="datapack::containsId">containsId</a></code>: Returns true if the specified object is a member of the package
 </li>
<li><code><a rd-options="" href="/link/removeMember?package=datapack&version=1.0.1" data-mini-rdoc="datapack::removeMember">removeMember</a></code>: Remove the Specified Member from the Package
 </li>
<li><code><a rd-options="" href="/link/getMember?package=datapack&version=1.0.1" data-mini-rdoc="datapack::getMember">getMember</a></code>: Return the Package Member by Identifier
 </li>
<li><code><a rd-options="" href="/link/serializePackage?package=datapack&version=1.0.1" data-mini-rdoc="datapack::serializePackage">serializePackage</a></code>: Create an OAI-ORE resource map from the package
 </li>
<li><code><a rd-options="" href="/link/serializeToBagIt?package=datapack&version=1.0.1" data-mini-rdoc="datapack::serializeToBagIt">serializeToBagIt</a></code>: Serialize A DataPackage into a BagIt Archive File
</li>
</ul> 

DataPackage-class: A class representing a data package, which can contain data objects

Description

Arguments

Slots

Methods

See Also