Difference between revisions of "API:EPrints/DataSet"

From EPrints Documentation
Jump to: navigation, search
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- 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.
 
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=perl_lib/EPrints/DataSet.pm|package_name=EPrints::DataSet}}[[Category:API|DATASET]][[Category:API:EPrints/DataSet|DATASET]]<div><!-- Edit below this comment -->
__NOTOC__
 
{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataSet.pm|package_name=EPrints::DataSet}}[[Category:API|DataSet]]<div><!-- Edit below this comment -->
 
  
  
<!-- Pod2Wiki=head_name --></div>
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_synopsis --></div>
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
  my $ds = $handle-&gt;get_dataset( "inbox" );
+
<source lang="perl">my $dataset = $repository->dataset( "inbox" );
  my $ds = $repository-&gt;get_dataset( "inbox" );
+
 
 
+
print sprintf("There are %d records in the inbox\n",
  $confid = $ds-&gt;confid; # eprint
+
$dataset->count);
  $id = $ds-&gt;id;         # inbox
+
 
 
+
$string = $dataset->base_id; # eprint
  $metafield = $ds-&gt;get_field( $fieldname );
+
$string = $dataset->id; # inbox
  $metafield = $ds-&gt;get_key_field;
+
 
  $bool = $ds-&gt;has_field( $fieldname );
+
$dataobj = $dataset->create_dataobj( $data );
  @metafields = $ds-&gt;get_fields;
+
$user = $dataset->dataobj( 23 );
 
+
 
  $n = $ds-&gt;count( $handle );
+
$search = $dataset->prepare_search( %options );
  $ds-&gt;map( $handle, $fn, $info );
+
$list = $dataset->search( %options ); # prepare_search( %options )->execute
  @ids = $dataset-&gt;get_item_ids( $handle );
+
$list = $dataset->search; # match ALL
 
+
 
  $obj = $ds-&gt;create_object( $handle, $data );
+
$metafield = $dataset->field( $fieldname );
 
+
$metafield = $dataset->key_field;
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
@metafields = $dataset->fields;
<h4><span style='display:none'>User Comments</span></h4>
+
 
 +
$dataset->search->map( sub {}, $ctx );
 +
$n = $dataset->search->count;  
 +
$ids = $dataset->search->ids;
 +
$list = $dataset->list( \@ids );</source>
 +
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=head_description --></div>
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
This module describes an EPrint dataset.
+
This module describes a dataset.
 +
 
 +
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 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. [[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.
  
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.
+
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.
  
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 while others may just be "virtual" datasets made from others.
+
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_cachemap_counter --></div>
+
<!-- Pod2Wiki= -->
===cachemap, counter===
+
<!-- Pod2Wiki=head_creating_custom_datasets -->
 +
==CREATING CUSTOM DATASETS==
 +
New datasets can be defined in a configuration file, e.g.
  
Don't have a package or metadata fields associated.
+
<pre>  $c-&gt;{datasets}-&gt;{bread} = {
 +
    class =&gt; "EPrints::DataObj::Bread",
 +
    sqlname =&gt; "bread",
 +
  };</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
This defines a dataset with the id <code>bread</code> (must be unique). The dataobj package (class) to instantiate objects with is <code>EPrints::DataObj::Bread</code>, which must be a sub-class of [[API:EPrints/DataObj|EPrints::DataObj]]. Lastly, the database tables used by the dataset will be called 'bread' or prefixed 'bread_'.
<h4><span style='display:none'>User Comments</span></h4>
 
<!-- Edit below this comment -->
 
  
 +
Other optional properties:
  
<!-- Pod2Wiki=item_archive_buffer_inbox_deletion --></div>
+
<pre>  columns - an array ref of field ids to default the user view to
===archive, buffer, inbox, deletion===
+
  datestamp - field id to use to sort this dataset
 +
  import - is the dataset importable?
 +
  index - is the dataset text-indexed?
 +
  order - is the dataset orderable?
 +
  virtual - completely virtual dataset (no database tables)</pre>
  
All have the same package and metadata fields as '''eprints''', but are filtered by '''eprint_status'''.
+
To make one dataset a virtual dataset of another (as 'inbox' is to 'eprint') use the following properties:
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<pre>  confid - the super-dataset this is a virtual sub-dataset of
<h4><span style='display:none'>User Comments</span></h4>
+
  dataset_id_field - the field containing the sub-dataset id
<!-- Edit below this comment -->
+
  filters - an array ref of filters to apply when retrieving records</pre>
  
 +
As with system datasets, the [[API:EPrints/MetaField|EPrints::MetaField]]s can be defined via [[API:EPrints/DataObj#get_system_field_info|EPrints::DataObj/get_system_field_info]] or via configuration:
  
<!-- Pod2Wiki=head_methods --></div>
+
<pre>  $c-&gt;add_dataset_field(
==METHODS==
+
    "bread",
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
+
    { name =&gt; "breadid", type =&gt; "counter", sql_counter =&gt; "bread" }
<h4><span style='display:none'>User Comments</span></h4>
+
  );
<!-- Edit below this comment -->
+
  $c-&gt;add_dataset_field(
 +
    "bread",
 +
    { name =&gt; "toasted", type =&gt; "bool", }
 +
  );
 +
  $c-&gt;add_dataset_field(
 +
    "bread",
 +
    { name =&gt; "description", type =&gt; "text", }
 +
  );</pre>
  
 +
See [[API:EPrints/RepositoryConfig#add_dataset_field|EPrints::RepositoryConfig/add_dataset_field]] for details on <code>add_dataset_field</code>.
  
<!-- Pod2Wiki=item_get_field --></div>
+
Creating a fully-operational dataset will require more configuration files. You will probably want at least a [[API:EPrints/Workflow|workflow]], [[API:EPrints/Citation|citations]] for the summary page, search results etc, and permissions and searching settings:
===$metafield = $ds-&gt;get_field( $fieldname )===
 
  
Return a MetaField object describing the asked for field in this dataset, or undef if there is no such field.
+
<pre>  push @{$c-&gt;{user_roles}-&gt;{admin}}, qw(
 +
    +bread/create
 +
    +bread/edit
 +
    +bread/view
 +
    +bread/destroy
 +
    +bread/details
 +
  );
 +
  push @{$c-&gt;{plugins}-&gt;{"Export::SummaryPage"}-&gt;{params}-&gt;{accept}}, qw(
 +
    dataobj/bread
 +
  );
 +
  $c-&gt;{datasets}-&gt;{bread}-&gt;{search}-&gt;{simple} = {
 +
    search_fields =&gt; {
 +
      id =&gt; "q",
 +
      meta_fields =&gt; [qw(
 +
        breadid
 +
        description
 +
      )],
 +
    },
 +
  };</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_has_field --></div>
+
<!-- Pod2Wiki= -->
===$bool = $ds-&gt;has_field( $fieldname )===
+
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<!-- Edit below this comment -->
  
True if the dataset has a field of that name.
 
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<!-- Pod2Wiki= -->
<h4><span style='display:none'>User Comments</span></h4>
+
<!-- Pod2Wiki=head_class_methods -->
 +
===Class Methods===
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_confid --></div>
+
<!-- Pod2Wiki= -->
===$confid = $ds-&gt;confid===
+
<!-- Pod2Wiki=head_object_methods -->
 +
===Object Methods===
 +
$id = $ds-&gt;base_id
 +
<pre>  $ds = $repo-&gt;dataset( "inbox" );
 +
  $id = $ds-&gt;base_id; # returns "eprint"</pre>
  
Return the string to use when getting configuration for this dataset.
+
Returns the identifier of the base dataset for this dataset (same as [[API:EPrints/DataSet#id|id]] unless this dataset is virtual).
  
archive, buffer, inbox and deletion all return "eprint" as they must have the same configuration.
+
$metafield = $ds-&gt;field( $fieldname )
 +
Returns the [[API:EPrints/MetaField|EPrints::MetaField]] from this dataset with the given name, or undef.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
$id = $ds-&gt;id
<h4><span style='display:none'>User Comments</span></h4>
+
Return the id of this dataset.
<!-- Edit below this comment -->
 
  
 +
$n = $ds-&gt;count( $session )
 +
Return the number of records in this dataset.
  
<!-- Pod2Wiki=item_id --></div>
+
@fields = $ds-&gt;fields
===$id = $ds-&gt;id===
+
Returns a list of the [[API:EPrints/MetaField|EPrints::MetaField]]s belonging to this dataset.
  
Return the id of this dataset. Unlike confid the buffer dataset will  return "buffer".  
+
$field = $ds-&gt;key_field
 +
Return the [[API:EPrints/MetaField|EPrints::MetaField]] representing the primary key field.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
Always the first field.
<h4><span style='display:none'>User Comments</span></h4>
 
<!-- Edit below this comment -->
 
  
 +
$dataobj = $ds-&gt;make_dataobj( $epdata )
 +
Return an object of the class associated with this dataset, always a subclass of [[API:EPrints/DataObj|EPrints::DataObj]].
  
<!-- Pod2Wiki=item_count --></div>
+
$epdata is a hash of values for fields in this dataset.
===$n = $ds-&gt;count( $handle )===
 
  
Return the number of records in this dataset.
+
Returns $epdata if no class is associated with 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%; '>
+
$obj = $ds-&gt;create_dataobj( $data )
<h4><span style='display:none'>User Comments</span></h4>
+
Returns a new object in this dataset based on $data or undef on failure.
<!-- Edit below this comment -->
 
  
 +
If $data describes sub-objects then those will also be created.
  
<!-- Pod2Wiki=item_get_fields --></div>
+
$dataobj = $ds-&gt;dataobj( $id )
===@fields = $ds-&gt;get_fields===
+
Returns the object from this dataset with the given id, or undefined.
  
Returns a list of the EPrints::Metafields belonging to this dataset.
+
$repository = $ds-&gt;repository
 +
Returns the [[API:EPrints/Repository|EPrints::Repository]] to which this dataset belongs.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
$searchexp = $ds-&gt;prepare_search( %options )
<h4><span style='display:none'>User Comments</span></h4>
+
Returns a [[API:EPrints/Search|EPrints::Search]] for this dataset with %options.
<!-- Edit below this comment -->
 
  
 +
$list = $ds-&gt;search( %options )
 +
Short-cut to [[API:EPrints/DataSet#prepare_search|prepare_search]]( %options )-&gt;execute.
  
<!-- Pod2Wiki=item_get_key_field --></div>
+
* satisfy_all
===$field = $ds-&gt;get_key_field===
+
<pre>   satisfy_all"=&gt;1</pre>
  
Return the EPrints::MetaField representing the primary key field. Always the first field.
+
: Satify all conditions specified. 0 means satisfy any of the conditions specified. Default is 1
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* staff
<h4><span style='display:none'>User Comments</span></h4>
+
<pre> "staff"=&gt;1</pre>
<!-- Edit below this comment -->
 
  
 +
: Do search as an adminstrator means you get everything back
  
<!-- Pod2Wiki=item_create_object --></div>
+
* custom_order
===$obj = $ds-&gt;create_object( $handle, $data )===
+
<pre>  "custom_order" =&gt; "field1/-field2/field3"</pre>
  
Create a new object in the given dataset. Return the new object.
+
: Order the search results by field order. prefixing the field name with a "-" results in reverse ordering
  
Return undef if the object could not be created.
+
* filters
 +
<pre>  "filters" =&gt; \@(
 +
                        { meta_fields=&gt;[ "field1", "field2" "document.field3" ],
 +
                          merge=&gt;"ANY", match=&gt;"EX",
 +
                          value=&gt;"bees"
 +
                        },
 +
                        { meta_fields=&gt;[ "field4" ],
 +
                          value=&gt; qw( honey ),
 +
                          match=&gt;"IN"
 +
                        }
 +
                      );</pre>
  
If $data describes sub-objects too then those will also be created.
+
: This searchs for 'bees' in <code>field1</code> or <code>field2</code> or <code>document.field3</code>, and 'honey' in <code>field4</code>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: For details on the <code>merge</code> and <code>match</code> parameters, refer to [[API:EPrints/Search/Field|EPrints::Search::Field]]
<h4><span style='display:none'>User Comments</span></h4>
 
<!-- Edit below this comment -->
 
  
 +
<pre>  "limit" =&gt; 10</pre>
  
<!-- Pod2Wiki=item_render_name --></div>
+
Only return 10 results
===$xhtml = $ds-&gt;render_name( $handle )===
 
  
Return a piece of XHTML describing this dataset, in the language of the given handle.
+
<!-- Edit below this comment -->
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
<!-- Edit below this comment -->
 
  
 +
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=head_list -->
 +
===list===
  
<!-- Pod2Wiki=item_map --></div>
+
<source lang="perl">$list = $ds->list( $ids )
===$ds-&gt;map( $handle, $fn, $info )===
 
  
Maps the function $fn onto every record in this dataset. See  EPrints::List for a full explanation.
+
</source>
 +
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%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_repository --></div>
+
<!-- Pod2Wiki= -->
===$repository = $ds-&gt;get_repository===
+
<!-- Pod2Wiki=head_search_config -->
 +
===search_config===
 +
 
 +
<source lang="perl">$sconf = $dataset->search_config( $searchid )
  
Returns the EPrints::Repository to which this dataset belongs.
+
</source>
 +
Retrieve the search configuration $searchid for this dataset. This typically contains a set of fields to search over, order values and rendering parameters.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=item_get_item_ids --></div>
+
<!-- Pod2Wiki= -->
===@ids = $dataset-&gt;get_item_ids( $handle )===
+
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
Copyright 2000-2011 University of Southampton.
  
Return a list of the id's of all items in this set.
+
This file is part of EPrints http://www.eprints.org/.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
<h4><span style='display:none'>User Comments</span></h4>
 
<!-- Edit below this comment -->
 
  
 +
EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
  
<!-- Pod2Wiki=head_see_also --></div>
+
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
==SEE ALSO==
 
EPrints::MetaField, EPrints::DataObj
 
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 
<h4><span style='display:none'>User Comments</span></h4>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
+
<!-- Pod2Wiki= -->
 +
<!-- Pod2Wiki=_postamble_ -->
 +
<!-- Edit below this comment -->

Latest revision as of 09:56, 22 January 2013

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataSet - a set of records with the same metadata scheme


SYNOPSIS

my $dataset = $repository->dataset( "inbox" );

print sprintf("There are %d records in the inbox\n",
	$dataset->count);

$string = $dataset->base_id; # eprint
$string = $dataset->id; # inbox

$dataobj = $dataset->create_dataobj( $data );
$user = $dataset->dataobj( 23 );

$search = $dataset->prepare_search( %options );
$list = $dataset->search( %options ); # prepare_search( %options )->execute
$list = $dataset->search; # match ALL

$metafield = $dataset->field( $fieldname );
$metafield = $dataset->key_field;
@metafields = $dataset->fields;

$dataset->search->map( sub {}, $ctx );
$n = $dataset->search->count; 
$ids = $dataset->search->ids;
$list = $dataset->list( \@ids );


DESCRIPTION

This module describes a dataset.

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 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 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 "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 EPrints::DataObj::EPrint. You can define your own virtual datasets which opperate on existing datasets.


CREATING CUSTOM DATASETS

New datasets can be defined in a configuration file, e.g.

  $c->{datasets}->{bread} = {
    class => "EPrints::DataObj::Bread",
    sqlname => "bread",
  };

This defines a dataset with the id bread (must be unique). The dataobj package (class) to instantiate objects with is EPrints::DataObj::Bread, which must be a sub-class of EPrints::DataObj. Lastly, the database tables used by the dataset will be called 'bread' or prefixed 'bread_'.

Other optional properties:

  columns - an array ref of field ids to default the user view to
  datestamp - field id to use to sort this dataset
  import - is the dataset importable?
  index - is the dataset text-indexed?
  order - is the dataset orderable?
  virtual - completely virtual dataset (no database tables)

To make one dataset a virtual dataset of another (as 'inbox' is to 'eprint') use the following properties:

  confid - the super-dataset this is a virtual sub-dataset of
  dataset_id_field - the field containing the sub-dataset id
  filters - an array ref of filters to apply when retrieving records

As with system datasets, the EPrints::MetaFields can be defined via EPrints::DataObj/get_system_field_info or via configuration:

  $c->add_dataset_field(
    "bread",
    { name => "breadid", type => "counter", sql_counter => "bread" }
  );
  $c->add_dataset_field(
    "bread",
    { name => "toasted", type => "bool", }
  );
  $c->add_dataset_field(
    "bread",
    { name => "description", type => "text", }
  );

See EPrints::RepositoryConfig/add_dataset_field for details on add_dataset_field.

Creating a fully-operational dataset will require more configuration files. You will probably want at least a workflow, citations for the summary page, search results etc, and permissions and searching settings:

  push @{$c->{user_roles}->{admin}}, qw(
    +bread/create
    +bread/edit
    +bread/view
    +bread/destroy
    +bread/details
  );
  push @{$c->{plugins}->{"Export::SummaryPage"}->{params}->{accept}}, qw(
    dataobj/bread
  );
  $c->{datasets}->{bread}->{search}->{simple} = {
    search_fields => {
      id => "q",
      meta_fields => [qw(
        breadid
        description
      )],
    },
  };


METHODS

Class Methods

Object Methods

$id = $ds->base_id
  $ds = $repo->dataset( "inbox" );
  $id = $ds->base_id; # returns "eprint"

Returns the identifier of the base dataset for this dataset (same as id unless this dataset is virtual).

$metafield = $ds->field( $fieldname )

Returns the EPrints::MetaField from this dataset with the given name, or undef.

$id = $ds->id

Return the id of this dataset.

$n = $ds->count( $session )

Return the number of records in this dataset.

@fields = $ds->fields

Returns a list of the EPrints::MetaFields belonging to this dataset.

$field = $ds->key_field

Return the EPrints::MetaField representing the primary key field.

Always the first field.

$dataobj = $ds->make_dataobj( $epdata )

Return an object of the class associated with this dataset, always a subclass of EPrints::DataObj.

$epdata is a hash of values for fields in this dataset.

Returns $epdata if no class is associated with this dataset.

$obj = $ds->create_dataobj( $data )

Returns a new object in this dataset based on $data or undef on failure.

If $data describes sub-objects then those will also be created.

$dataobj = $ds->dataobj( $id )

Returns the object from this dataset with the given id, or undefined.

$repository = $ds->repository

Returns the EPrints::Repository to which this dataset belongs.

$searchexp = $ds->prepare_search( %options )

Returns a EPrints::Search for this dataset with %options.

$list = $ds->search( %options )

Short-cut to prepare_search( %options )->execute.

  • satisfy_all
   satisfy_all"=>1
Satify all conditions specified. 0 means satisfy any of the conditions specified. Default is 1
  • staff
  "staff"=>1
Do search as an adminstrator means you get everything back
  • custom_order
  "custom_order" => "field1/-field2/field3"
Order the search results by field order. prefixing the field name with a "-" results in reverse ordering
  • filters
  "filters" => \@(
                         { meta_fields=>[ "field1", "field2" "document.field3" ],
                           merge=>"ANY", match=>"EX",
                           value=>"bees"
                         },
                         { meta_fields=>[ "field4" ],
                           value=> qw( honey ),
                           match=>"IN"
                         }
                       );
This searchs for 'bees' in field1 or field2 or document.field3, and 'honey' in field4
For details on the merge and match parameters, refer to EPrints::Search::Field
  "limit" => 10

Only return 10 results


list

$list = $ds->list( $ids )

Returns a EPrints::List for this dataset for the given $ids list.


search_config

$sconf = $dataset->search_config( $searchid )

Retrieve the search configuration $searchid for this dataset. This typically contains a set of fields to search over, order values and rendering parameters.


COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.