Difference between revisions of "API:EPrints/DataSet"

From EPrints Documentation
Jump to: navigation, search
 
Line 8: Line 8:
 
'''EPrints::DataSet''' - a set of records with the same metadata scheme
 
'''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%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_synopsis -->
 
<!-- Pod2Wiki=head_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
  my $dataset = $repository-&gt;dataset( "inbox" );
+
<source lang="perl">my $dataset = $repository->dataset( "inbox" );
 
+
 
  print sprintf("There are %d records in the inbox\n",
+
print sprintf("There are %d records in the inbox\n",
    $dataset-&gt;count);
+
$dataset->count);
 
+
 
  $string = $dataset-&gt;base_id; # eprint
+
$string = $dataset->base_id; # eprint
  $string = $dataset-&gt;id; # inbox
+
$string = $dataset->id; # inbox
 
+
 
  $dataobj = $dataset-&gt;create_dataobj( $data );
+
$dataobj = $dataset->create_dataobj( $data );
  $user = $dataset-&gt;dataobj( 23 );
+
$user = $dataset->dataobj( 23 );
 
+
 
  $search = $dataset-&gt;prepare_search( %options );
+
$search = $dataset->prepare_search( %options );
  $list = $dataset-&gt;search( %options ); # prepare_search( %options )-&gt;execute
+
$list = $dataset->search( %options ); # prepare_search( %options )->execute
  $list = $dataset-&gt;search; # match ALL
+
$list = $dataset->search; # match ALL
 
+
 
  $metafield = $dataset-&gt;field( $fieldname );
+
$metafield = $dataset->field( $fieldname );
  $metafield = $dataset-&gt;key_field;
+
$metafield = $dataset->key_field;
  @metafields = $dataset-&gt;fields;  
+
@metafields = $dataset->fields;
 
+
 
  $dataset-&gt;search-&gt;map( sub {}, $ctx );
+
$dataset->search->map( sub {}, $ctx );
  $n = $dataset-&gt;search-&gt;count;  
+
$n = $dataset->search->count;  
  $ids = $dataset-&gt;search-&gt;ids;
+
$ids = $dataset->search->ids;
  $list = $dataset-&gt;list( \@ids );
+
$list = $dataset->list( \@ids );</source>
 
+
 
<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>
+
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_description -->
 
<!-- Pod2Wiki=head_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
Line 60: Line 54:
 
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.
 
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%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_creating_custom_datasets -->
 
<!-- Pod2Wiki=head_creating_custom_datasets -->
 
==CREATING CUSTOM DATASETS==
 
==CREATING CUSTOM DATASETS==
 
New datasets can be defined in a configuration file, e.g.
 
New datasets can be defined in a configuration file, e.g.
  
  $c-&gt;{datasets}-&gt;{bread} = {
+
<pre>  $c-&gt;{datasets}-&gt;{bread} = {
 
     class =&gt; "EPrints::DataObj::Bread",
 
     class =&gt; "EPrints::DataObj::Bread",
 
     sqlname =&gt; "bread",
 
     sqlname =&gt; "bread",
   };
+
   };</pre>
 
+
 
This defines a dataset with the id <tt>bread</tt> (must be unique). The dataobj package (class) to instantiate objects with is <tt>EPrints::DataObj::Bread</tt>, 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_'.
+
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_'.
  
 
Other optional properties:
 
Other optional properties:
  
  columns - an array ref of field ids to default the user view to
+
<pre>  columns - an array ref of field ids to default the user view to
 
   datestamp - field id to use to sort this dataset
 
   datestamp - field id to use to sort this dataset
 
   import - is the dataset importable?
 
   import - is the dataset importable?
 
   index - is the dataset text-indexed?
 
   index - is the dataset text-indexed?
 
   order - is the dataset orderable?
 
   order - is the dataset orderable?
   virtual - completely virtual dataset (no database tables)
+
   virtual - completely virtual dataset (no database tables)</pre>
 
+
 
 
To make one dataset a virtual dataset of another (as 'inbox' is to 'eprint') use the following properties:
 
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
+
<pre>  confid - the super-dataset this is a virtual sub-dataset of
 
   dataset_id_field - the field containing the sub-dataset id
 
   dataset_id_field - the field containing the sub-dataset id
   filters - an array ref of filters to apply when retrieving records
+
   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:
 
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:
  
  $c-&gt;add_dataset_field(
+
<pre>  $c-&gt;add_dataset_field(
 
     "bread",
 
     "bread",
 
     { name =&gt; "breadid", type =&gt; "counter", sql_counter =&gt; "bread" }
 
     { name =&gt; "breadid", type =&gt; "counter", sql_counter =&gt; "bread" }
Line 106: Line 97:
 
     "bread",
 
     "bread",
 
     { name =&gt; "description", type =&gt; "text", }
 
     { name =&gt; "description", type =&gt; "text", }
   );
+
   );</pre>
 
+
 
See [[API:EPrints/RepositoryConfig#add_dataset_field|EPrints::RepositoryConfig/add_dataset_field]] for details on <tt>add_dataset_field</tt>.
+
See [[API:EPrints/RepositoryConfig#add_dataset_field|EPrints::RepositoryConfig/add_dataset_field]] for details on <code>add_dataset_field</code>.
  
Creating a fully-operational dataset will require more configuration files. You will probably want at least a {{API:PodLink|file=EPrints/Workflow|package_name=EPrints::Workflow|section=|text=workflow}}, {{API:PodLink|file=EPrints/Citation|package_name=EPrints::Citation|section=|text=citations}} for the summary page, search results etc, and permissions and searching settings:
+
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:
  
  push @{$c-&gt;{user_roles}-&gt;{admin}}, qw(
+
<pre>  push @{$c-&gt;{user_roles}-&gt;{admin}}, qw(
 
     +bread/create
 
     +bread/create
 
     +bread/edit
 
     +bread/edit
Line 130: Line 121:
 
       )],
 
       )],
 
     },
 
     },
   };
+
   };</pre>
 
+
 
<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>
+
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_methods -->
 
<!-- Pod2Wiki=head_methods -->
 
==METHODS==
 
==METHODS==
<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>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_class_methods -->
 
<!-- Pod2Wiki=head_class_methods -->
 
===Class Methods===
 
===Class Methods===
<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>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_object_methods -->
 
<!-- Pod2Wiki=head_object_methods -->
 
===Object Methods===
 
===Object Methods===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #ccepadding: 0em 1em 0em 1em; font-size: 80%; '>
+
$id = $ds-&gt;base_id
<span style='display:none'>User Comments</span>
+
<pre> $ds = $repo-&gt;dataset( "inbox" );
<!-- Edit below this comment -->
+
  $id = $ds-&gt;base_id; # returns "eprint"</pre>
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_base_id -->
 
====base_id====
 
 
$id = $ds-&gt;base_id
 
  $ds = $repo-&gt;dataset( "inbox" );
 
  $id = $ds-&gt;base_id; # returns "eprint"
 
 
 
 
Returns the identifier of the base dataset for this dataset (same as [[API:EPrints/DataSet#id|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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_field -->
 
====field====
 
  
 
  $metafield = $ds-&gt;field( $fieldname )
 
  $metafield = $ds-&gt;field( $fieldname )
 
Returns the [[API:EPrints/MetaField|EPrints::MetaField]] from this dataset with the given name, or undef.
 
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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_id -->
 
====id====
 
  
 
  $id = $ds-&gt;id
 
  $id = $ds-&gt;id
 
Return the id of this dataset.
 
Return the id of 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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_count -->
 
====count====
 
  
 
  $n = $ds-&gt;count( $session )
 
  $n = $ds-&gt;count( $session )
 
Return the number of records in this dataset.
 
Return the number of records in 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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_fields -->
 
====fields====
 
  
 
  @fields = $ds-&gt;fields
 
  @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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_key_field -->
 
====key_field====
 
  
 
  $field = $ds-&gt;key_field
 
  $field = $ds-&gt;key_field
Line 241: Line 163:
  
 
Always the first field.
 
Always the first field.
 
<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>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_make_dataobj -->
 
====make_dataobj====
 
  
 
  $dataobj = $ds-&gt;make_dataobj( $epdata )
 
  $dataobj = $ds-&gt;make_dataobj( $epdata )
Line 258: Line 170:
  
 
Returns $epdata if no class is associated with 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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_create_dataobj -->
 
====create_dataobj====
 
  
 
  $obj = $ds-&gt;create_dataobj( $data )
 
  $obj = $ds-&gt;create_dataobj( $data )
Line 273: Line 175:
  
 
If $data describes sub-objects then those will also be created.
 
If $data describes sub-objects then those will also be created.
 
<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>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_dataobj -->
 
====dataobj====
 
  
 
  $dataobj = $ds-&gt;dataobj( $id )
 
  $dataobj = $ds-&gt;dataobj( $id )
 
Returns the object from this dataset with the given id, or undefined.
 
Returns the object from this dataset with the given id, or undefined.
 
<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>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_repository -->
 
====repository====
 
  
 
  $repository = $ds-&gt;repository
 
  $repository = $ds-&gt;repository
 
Returns the [[API:EPrints/Repository|EPrints::Repository]] to which this dataset belongs.
 
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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_prepare_search -->
 
====prepare_search====
 
  
 
  $searchexp = $ds-&gt;prepare_search( %options )
 
  $searchexp = $ds-&gt;prepare_search( %options )
 
Returns a [[API:EPrints/Search|EPrints::Search]] for this dataset with %options.
 
Returns a [[API:EPrints/Search|EPrints::Search]] for this dataset with %options.
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
$list = $ds-&gt;search( %options )
<span style='display:none'>User Comments</span>
+
Short-cut to [[API:EPrints/DataSet#prepare_search|prepare_search]]( %options )-&gt;execute.
<!-- Edit below this comment -->
+
  
 +
* satisfy_all
 +
<pre>  satisfy_all"=&gt;1</pre>
  
<!-- Pod2Wiki= -->
+
: Satify all conditions specified. 0 means satisfy any of the conditions specified. Default is 1
</div>
+
<!-- Pod2Wiki=item_search -->
+
====search====
+
  
  $list = $ds-&gt;search( %options )
+
* staff
Short-cut to [[API:EPrints/DataSet#prepare_search|prepare_search]]( %options )-&gt;execute.
+
<pre> "staff"=&gt;1</pre>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: Do search as an adminstrator means you get everything back
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
* custom_order
 +
<pre>  "custom_order" =&gt; "field1/-field2/field3"</pre>
  
<!-- Pod2Wiki= -->
+
: Order the search results by field order. prefixing the field name with a "-" results in reverse ordering
</div>
+
<!-- Pod2Wiki=item_satisfy_all_1 -->
+
====satisfy_all_1====
+
  
  "satisfy_all"=&gt;1
+
* filters
Satify all conditions specified. 0 means satisfy any of the conditions specified. Default is 1
+
<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>
  
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
: This searchs for 'bees' in <code>field1</code> or <code>field2</code> or <code>document.field3</code>, and 'honey' in <code>field4</code>
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
: For details on the <code>merge</code> and <code>match</code> parameters, refer to [[API:EPrints/Search/Field|EPrints::Search::Field]]
  
<!-- Pod2Wiki= -->
+
<pre>  "limit" =&gt; 10</pre>
</div>
+
<!-- Pod2Wiki=item_staff_1 -->
+
====staff_1====
+
  
"staff"=&gt;1
+
Only return 10 results
Do search as an adminstrator means you get everything back
+
  
<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>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_list -->
<!-- Pod2Wiki=item_custom_order_field1_field2_field3 -->
+
===list===
====custom_order_field1_field2_field3====
+
  
"custom_order" =&gt; "field1/-field2/field3"
+
<source lang="perl">$list = $ds->list( $ids )
Order the search results by field order. prefixing the field name with a "-" results in reverse ordering
+
 
 +
</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%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_search_config -->
<!-- Pod2Wiki=item_search_fields_meta_fields_field1_field2_document_field3_merge_any_match_ex_value_bees_meta_fields_field4_value_honey -->
+
===search_config===
====search_fields_meta_fields_field1_field2_document_field3_merge_any_match_ex_value_bees_meta_fields_field4_value_honey====
+
  
"search_fields" =&gt; \@({meta_fields=&gt;[ "field1", "field2" "document.field3" ], merge=&gt;"ANY", match=&gt;"EX", value=&gt;"bees"}, {meta_fields=&gt;[ "field4" ], value=&gt;"honey"});
+
<source lang="perl">$sconf = $dataset->search_config( $searchid )
Return values where field1 field2 or field3 is "bees" and field2  is "honey" (assuming satisfy all is set)
+
 
 +
</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%; '>
 
<span style='display:none'>User Comments</span>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=head_copyright -->
<!-- Pod2Wiki=item_limit_10 -->
+
==COPYRIGHT==
====limit_10====
+
Copyright 2000-2011 University of Southampton.
  
"limit" =&gt; 10
+
This file is part of EPrints http://www.eprints.org/.
Only return 10 results
+
  
<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.
<span style='display:none'>User Comments</span>
+
<!-- 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= -->
+
You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.
</div>
+
<!-- Pod2Wiki=item_list -->
+
====list====
+
 
+
  $list = $ds-&gt;list( $ids )
+
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>
 
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
+
<!-- Pod2Wiki=_postamble_ -->
<!-- Pod2Wiki=head_copyright -->
+
==COPYRIGHT==
+
<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>
+
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- 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/.