API:EPrints/DataSet - Revision history

Tdb01r at 09:56, 22 January 2013

2013-01-22T09:56:14Z

Show changes

Tdb01r at 15:26, 16 December 2011

2011-12-16T15:26:04Z

Tdb01r at 12:27, 1 December 2011

2011-12-01T12:27:42Z

Tdb01r at 11:41, 14 September 2011

2011-09-14T11:41:18Z

Show changes

Tdb01r at 11:40, 14 September 2011

2011-09-14T11:40:05Z

Tdb01r at 10:46, 25 August 2011

2011-08-25T10:46:36Z

Pm705 at 17:23, 31 December 2010

2010-12-31T17:23:26Z

Show changes

Tdb01r at 13:05, 17 June 2010

2010-06-17T13:05:27Z

Tdb01r at 15:12, 25 February 2010

2010-02-25T15:12:31Z

Show changes

Pm705@zepler.net at 16:33, 12 February 2010

2010-02-12T16:33:57Z

Show changes

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
 This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataSet.pm|package_name=EPrints::DataSet}}[[Category:API|DATASET]][[Category:API:EPrints/DataSet|DATASET]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/DataSet.pm|package_name=EPrints::DataSet}}[[Category:API|DATASET]][[Category:API:EPrints/DataSet|DATASET]]<div><!-- Edit below this comment -->

@@ Line 58: / Line 58: @@
 The fields contained in a dataset are defined by the data object and by any additional fields defined in cfg.d. Some datasets don't have any fields.
-Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "deletion" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains [[API:EPrints/DataObj/EPrints|EPrints::DataObj::EPrints]]. You can define your  own virtual datasets which opperate on existing datasets.
+Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "deletion" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]]. You can define your  own virtual datasets which opperate on existing datasets.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints::DataSet''' - a dataset is a set of records in the eprints system with the same metadata.
+'''EPrints::DataSet''' - a set of records with the same metadata scheme
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_synopsis -->
 ==SYNOPSIS==
-   my $dataset = $repository-&gt;get_dataset( "inbox" );
+   my $dataset = $repository-&gt;dataset( "inbox" );
    print sprintf("There are %d records in the inbox\n",
@@ Line 50: / Line 50: @@
 <!-- Pod2Wiki=head_description -->
 ==DESCRIPTION==
-This module describes an EPrint dataset.
+This module describes a dataset.
-A repository has several datasets that make up the repository's database. The list of dataset ids can be obtained from the repository object (see [[API:EPrints/Repository|EPrints::Repository]]).
+A repository has several datasets that make up the repository's metadata schema. The list of dataset ids can be obtained from the repository object (see [[API:EPrints/Repository|EPrints::Repository]]).
-A normal dataset (eg. "user") has a package associated with it  (eg. [[API:EPrints/DataObj/User|EPrints::DataObj::User]]) which must be a subclass of [[API:EPrints/DataObj|EPrints::DataObj]]  and a number of SQL tables which are prefixed with the dataset name. Most datasets also have a set of associated [[API:EPrints/MetaField|EPrints::MetaField]]'s which may be optional or compulsary depending on the type eg. books have editors but posters don't but they are both EPrints.
+A normal dataset (eg. "user") has a package associated with it  (eg. [[API:EPrints/DataObj/User|EPrints::DataObj::User]]) which must be a subclass of [[API:EPrints/DataObj|EPrints::DataObj]]  and a number of SQL tables which are prefixed with the dataset name. Most datasets also have a set of associated [[API:EPrints/MetaField|EPrints::MetaField]]'s which may be optional or required depending on the type eg. books have editors but posters don't but they are both EPrints.
 The fields contained in a dataset are defined by the data object and by any additional fields defined in cfg.d. Some datasets don't have any fields.
-Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "retired" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains [[API:EPrints/DataObj/EPrints|EPrints::DataObj::EPrints]]. You can define your  own virtual datasets which opperate on existing datasets.
+Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "deletion" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains [[API:EPrints/DataObj/EPrints|EPrints::DataObj::EPrints]]. You can define your  own virtual datasets which opperate on existing datasets.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

@@ Line 54: / Line 54: @@
 A repository has several datasets that make up the repository's database. The list of dataset ids can be obtained from the repository object (see [[API:EPrints/Repository|EPrints::Repository]]).
-A normal dataset (eg. "user") has a package associated with it  (eg. EPrints::DataObj::User) which must be a subclass of EPrints::DataObj  and a number of SQL tables which are prefixed with the dataset name. Most datasets also have a set of associated EPrints::MetaField's which may be optional or compulsary depending on the type eg. books have editors but posters don't but they are both EPrints.
+A normal dataset (eg. "user") has a package associated with it  (eg. [[API:EPrints/DataObj/User|EPrints::DataObj::User]]) which must be a subclass of [[API:EPrints/DataObj|EPrints::DataObj]]  and a number of SQL tables which are prefixed with the dataset name. Most datasets also have a set of associated [[API:EPrints/MetaField|EPrints::MetaField]]'s which may be optional or compulsary depending on the type eg. books have editors but posters don't but they are both EPrints.
 The fields contained in a dataset are defined by the data object and by any additional fields defined in cfg.d. Some datasets don't have any fields.
-Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "retired" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains EPrints::DataObj::EPrints. You can define your  own virtual datasets which opperate on existing datasets.
+Some datasets are "virtual" datasets made from others. Examples include  "inbox", "archive", "buffer" and "retired" which are all virtual datasets  of of the "eprint" dataset. That is to say "inbox" is a subset of "eprint"  and by inference contains [[API:EPrints/DataObj/EPrints|EPrints::DataObj::EPrints]]. You can define your  own virtual datasets which opperate on existing datasets.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 82: / Line 82: @@
    $id = $ds-&gt;base_id; # returns "eprint"
-Returns the identifier of the base dataset for this dataset (same as {{API:PodLink|file=|package_name=|section=id|text=/id}} unless this dataset is virtual).
+Returns the identifier of the base dataset for this dataset (same as [[API:EPrints/DataSet#id|id]] unless this dataset is virtual).
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 222: / Line 222: @@
 ====$list = $ds-&gt;search( %options )====
-Short-cut to {{API:PodLink|file=|package_name=|section=prepare_search|text=/prepare_search}}( %options )-&gt;execute.
+Short-cut to [[API:EPrints/DataSet#prepare_search|prepare_search]]( %options )-&gt;execute.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 236: / Line 296: @@
 Returns a [[API:EPrints/List|EPrints::List]] for this dataset for the given $ids list.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

@@ Line 487: / Line 487: @@
   @fields = $ds-&gt;fields
-Returns a list of the [[API:EPrints/Metafield|EPrints::Metafield]]s belonging to this dataset.
+Returns a list of the [[API:EPrints/MetaField|EPrints::MetaField]]s belonging to this dataset.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 775: / Line 775: @@
   $fields = $dataset-&gt;columns()
 Returns the default list of fields to show the user when browsing this dataset in a table. Returns an array ref of [[API:EPrints/MetaField|EPrints::MetaField]] objects.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>