Difference between revisions of "API:EPrints/DataObj"

Latest revision as of 16:41, 10 January 2022

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.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::DataObj - Base class for records in EPrints.

User Comments

DESCRIPTION

This is a base class that is inherited by EPrints::DataObj::EPrint, EPrints::DataObj::User, EPrints::DataObj::Subject and EPrints::DataObj::Document and various other classes representing data objects.

This class is abstract and its methods should not be called directly.

User Comments

Synopsis

$dataobj = $dataset->dataobj( $id );
$dataobj->delete;
$dataobj->commit( $force );
$dataset = $dataobj->dataset;
$repo = $dataobj->repository;
$id = $dataobj->id;
$dataobj->set_value( $fieldname, $value );
$value = $dataobj->value( $fieldname );
\@value = $dataobj->value( $fieldname ); # multiple
$boolean = $dataobj->is_set( $fieldname );
$xhtml = $dataobj->render_value( $fieldname );
$xhtml = $dataobj->render_citation( $style, %opts );
$uri = $dataobj->uri;
$string = $dataobj->export( $plugin_id, %opts );
$dataobj = $dataobj->create_subobject( $fieldname, $epdata );

User Comments

CORE METADATA FIELDS

None. This is an abstract class from which real data objects inherit and then add their metadata fields.

User Comments

REFERENCES AND RELATED OBJECTS

None. This is an abstract class from which real data objects inherit and then add their references and related objects.

User Comments

INSTANCE VARIABLES

User Comments

$self->{changed}

A reference to a hash containing the old values of metadata that has changed since his the data object was last committed.

User Comments

$self->{data}

A reference to a hash containing the metadata of this record.

User Comments

$self->{dataset}

The EPrints::DataSet to which this record belongs.

User Comments

$self->{non_volatile_change}

A boolean signifying whether the current changes include at least one change to a non-volatile field.

User Comments

$self->{session}

The current EPrints::Repository. This use to be EPrints::Session but was replaced in later versions. See EPrints::BackCompatibility.

User Comments

$self->{under_construction}

A boolean signifying if the data object is currently under construction and therefore know house-keeping should be carried out on the data object whilst set.

User Comments

METHODS

User Comments

Constructor Methods

User Comments

new

$dataobj = EPrints::DataObj->new( $session, $id, [ $dataset ] )

Return new data object, created by loading it from the database.

If $dataset is not defined uses the default dataset for this object.

User Comments

new_from_data

$dataobj = EPrints::DataObj->new_from_data( $session, $data, [ $dataset ] )

Construct and and returns a new data object based on the $data hash reference of metadata.

This is usually called by create_from_data to ensure default values are set for those field values not initially included in $data before this method constructs the data object.

$dataset is determined from the class if not provided.

User Comments

create

$dataobj = EPrints::DataObj::create( $session, @default_data )

ABSTRACT

Create a new object of this type in the database.

The syntax for @default_data depends on the type of data object.

User Comments

create_from_data

$dataobj = EPrints::DataObj->create_from_data( $session, $data, [ $dataset ] )

Creates and returns a new data object of this type in the database.

$data is a structured hash reference with multiple dimensions to encompass compound, multiple and sub-object field values.

$dataset is the dataset to which the new data object will belong. If this is not defined, it is determined from the class.

This will pull in defaults for unset field values in $data before calling new_from_data. It will also create any sub-objects as well as the main object.

Call this via:

$dataset->create_object( $session, $data )

User Comments

Class Methods

User Comments

get_system_field_info

$sys_fields = EPrints::DataObj->get_system_field_info

Return an array describing the system metadata of the this dataset.

User Comments

get_defaults

$defaults = EPrints::DataObj->get_defaults( $session, $data, [ $dataset ] )

Return default values for this object based on the starting $data. Uses the data object class to determine dataset if $dataset not set.

Should be subclassed.

User Comments

get_dataset_id

$dataset = EPrints::DataObj->get_dataset_id

Returns the ID of the EPrints::DataSet object to which this record belongs.

User Comments

xml_to_epdata

$epdata = EPrints::DataObj->xml_to_epdata( $session, $xml, %opts )

Populates $epdata based on $xml using options in %opts. This is the inverse of to_xml but doesn't create a new object.

User Comments

export_fieldlist

EPrints::DataObj->export_fieldlist

Returns fields to be exported by plugins that do not have pre-defined fields to export, (e.g. Export::XML).

User Comments

in_export_fieldlist

EPrints::DataObj->in_export_fieldlist

Returns whether a field is in the export fieldlist for a particular data object. Returns true if there is no fieldlist restriction.

User Comments

start_element

EPrints::DataObj->start_element( $data, $epdata, $state )

Consumes a SAX event.

$data is the SAX node data.

$epdata is an EPrints data structure to write values to.

$state maintains state between SAX calls but must contain at least:

   dataset - the dataset the class belongs to

User Comments

end_element

EPrints::DataObj->end_element( $data, $epdata, $state )

Ends element from start_element.

User Comments

characters

EPrints::DataObj->characters( $data, $epdata, $state )

Consumes characters within start_element.

User Comments

Object Methods

User Comments

clone

$clone = $dataobj->clone

Clone the current data object, by creating a new data object of the same type and metadata but a new ID.

User Comments

create_subdataobj

$subdataobj = $dataobj->create_subdataobj( $fieldname, $epdata )

Creates and returns a new data object that is a sub-object of this object in field $fieldname with initial data $epdata.

Clears the sub-object cache for this $fieldname which is equivalent to:

$dataobj->set_value( $fieldname, undef );

User Comments

local_path

$local_path = $dataobj->local_path

Return local_path string for the history of the data object.

Should be subclassed.

User Comments

update_triggers

$dataobj->update_triggers

Update all the stuff that needs to be updated before the data object is written to the database.

User Comments

delete

$success = $dataobj->delete

Delete this data object from the database and any sub-objects or related files.

Alias for:

$dataobj->remove

Return true if successful.

User Comments

empty

$dataobj->empty

Remove all of this object's values that may be imported.

User Comments

update

$dataobj->update( $epdata [, %opts ] )

Update this object's values from $epdata. Ignores any values that do not exist in the dataset or do not have the 'import' property set.

 include_subdataobjs - replace sub-dataobjs if given
 
 # replaces all documents in $dataobj
 $dataobj->update( {
   title => "Wombats on Fire",
   documents => [{
     main => "wombat.pdf",
     ...
   }],
 }, include_subdataobjs => 1 );

User Comments

set_under_construction

$dataobj->set_under_construction( $boolean )

Set a flag to indicate this object is being constructed and any house keeping will be handled by the method constructing it so don't do it elsewhere.

User Comments

under_construction

$boolean = $dataobj->under_construction

Returns c<true> if this object is part way through being constructed.

User Comments

clear_changed

$dataobj->clear_changed

Clear any changed fields, which will result in them not being committed unless force is used.

This method is used by the EPrints::Database to avoid unnecessary commits.

User Comments

clear_citationcaches

$dataobj->clear_citationcaches

Clear any EPrints::DataObj::CitationCache objects associated with the data object.

User Comments

commit

$success = $dataobj->commit( [ $force ] )

Write this object to the database and reset the changed fields.

If $force isn't true then it only actually modifies the database if one or more fields have been changed.

Commit may also queue indexer jobs or log changes, depending on the object.

User Comments

value

$value = $dataobj->value( $fieldname )

Get a the value of a metadata field with $fieldname. If the field is not set then it returns undef unless the field has the property multiple set, in which case it returns [] (a reference to an empty a rray).

Alias for:

$dataobj->get_value( $fieldname )

User Comments

set_value

$dataobj->set_value( $fieldname, $value )

Set the $value of the named metadata field $fieldname for this data object.

User Comments

set_value_raw

$dataobj->set_value_raw( $fieldname, $value )

Set the $value of the named metadata field $fieldname for this data object by directly modifying its data hash reference. Use with care!

User Comments

get_values

@values = $dataobj->get_values( $fieldnames )

Returns a list of all the values in this record of all the $fields specified by $fieldnames. These should be in the format used by browse views, using / to seperate individual field names with an optional .id suffix to indicate the ID part rather than the main part.

E.g. author.id/editor.id would return a list of all author and editor IDs from this record.

User Comments

repository

$session = $dataobj->repository

Returns the EPrints::Repository object to which this record belongs.

Alias for:

$dataobj->get_session

User Comments

get_data

$data = $dataobj->get_data

Returns a reference to the hash of all the metadata for this record keyed by fieldname.

User Comments

get_dataset

$dataset = $dataobj->get_dataset

Returns the EPrints::DataSet object to which this record belongs.

User Comments

is_set

$boolean = $dataobj->is_set( $fieldname )

Returns true if the field with $fieldname is set in this record, otherwise false.

Warns if the field with $fieldname does not exist.

User Comments

exists_and_set

$boolean = $dataobj->exists_and_set( $fieldname )

Returns true if the field with $fieldname is set in this record, otherwise false.

If the field does not exist, just return false.

This method is useful for plugins which may operate on multiple repositories, when field not existing is not an issue for a particular repository.

User Comments

id

$id = $dataobj->id

Returns the value of the primary key of this record.

Alias for:

$dataobj->get_id

User Comments

get_gid

$gid = $dataobj->get_gid

DEPRECATED (see uri)

Returns the globally referential fully-qualified identifier for this data object or undef if this object can not be externally referenced.

User Comments

get_datestamp

$datestamp = $dataobj->get_datestamp

Returns the datestamp of this object in "YYYY-MM-DD hh:mm:ss" format.

User Comments

render_value

$xhtml = $dataobj->render_value( $fieldname, [ $showall ] )

Returns the rendered version of the value of the given $fieldname as appropriate for the current session. If $showall is true then all values are rendered - this is usually used for staff viewing data.

User Comments

render_citation

$xhtml = $dataobj->render_citation( [ $style, %params ] )

Renders the record as a citation. If $style is set then it uses that citation style from the citations config file. Otherwise $style defaults to the type of this record. If $params{url} is set then the citation will link to the specified URL.

If $style is unset then use default.

User Comments

render_citation_link

$xhtml = $dataobj->render_citation_link( [ $style, %params ] )

Renders a citation as like render_citation but as a link to the URL for this item. E.g. the abstract page of an eprint.

$params{url} is set to data object's URL if not set.

User Comments

render_citation_link

$xhtml = $dataobj->render_citation_link( [ $style, %params ] )

Renders a citation as like render_citation but as a link to the control URL for this item. E.g. for items that are not yet in the live archive.

User Comments

render_description

$xhtml = $dataobj->render_description

Returns a short description of this object using the brief citation style for this dataset or the default citation style of the former does not exist.

User Comments

render

( $xhtml, $title ) = $dataobj->render

Return a chunk of XHTML DOM describing this object in the normal way. This is the public view of the record, not the staff view.

User Comments

render_full

$xhtml = $dataobj->render_full

Return an XHTML table in DOM describing this record. All values of all fields are listed. This is the staff view.

User Comments

render_export_links

$xhtml_ul_list = $dataobj->render_export_links( [ $staff ] )

Return a <ul> list containing links to all the formats this eprint is available in.

If $staff is true then show all formats available to staff and link to the staff export URL.

User Comments

render_export_bar

$xhtml = $dataobj->render_export_bar( [ $staff ] )

Returns a rendered drop-down list of exports.

If $staff is true then include both public and staff visible export options.

User Comments

uri

$url = $dataobj->uri

Returns a unique URI for this object. Not certain to resolve as a URL.

If $c-{dataobj_uri}->{eprint}> is a function, call that to work it out.

User Comments

internal_uri

$uri = $dataobj->internal_uri

Return an internal URI for this object (independent of repository hostname).

To retrieve an object by internal URI use EPrints::DataSet::get_object_from_uri().

User Comments

path

$path = $dataobj->path

Returns the relative path to this object from the repository's base URL, if the object has a URL.

Does not include any leading slash.

User Comments

url

$url = $dataobj->url

Returns the URL for this record, e.g.the URL of the abstract page of an eprint.

Alias for:

$dataobj->get_url

User Comments

get_control_url

$url = $dataobj->get_control_url

Returns the URL for the control page for this object.

User Comments

get_type

$type = $dataobj->get_type

ABSTRACT.

Returns the type of this data object. This not the dataset it belongs to but the specific type within the dataset (e.g. c<user> could be editor, admin, etc.).

User Comments

to_xml

$xmlfragment = $dataobj->to_xml( %opts )

Convert this object into an XML fragment using options %opts.

Options:

no_xmlns - Do not include a xmlns attribute in the outer element. 
(This assumes this chunk appears in a larger tree where the xmlns is 
already set correctly.
showempty - Fields with no value are shown.
embed - Include the data of a file, not just it's URL.

User Comments

to_sax

$dataobj->to_sax( %opts )

Stream this object to a SAX handler using the options in $opts.

Options:

Handler - the SAX handler to build the output.
revision_generation - Generate XML for revision files rather than 
export.

This does not output any document-level events.

User Comments

export

$plugin_output = $dataobj->export( $plugin_id, %params )

Apply an export plugin with $plugin_id to this data object, using the parameters provided by %params and supplying them to the output_dataobj method of the EPrints::Plugin:Export plugin.

Return the output of the export plugin.

User Comments

queue_changes

$dataobj->queue_changes

Add all the changed fields into the indexers todo queue.

User Comments

queue_all

$dataobj->queue_all

Add all the fields into the indexers todo queue.

User Comments

queue_fulltext

$dataobj->queue_fulltext

Add a fulltext index into the indexers todo queue.

User Comments

queue_removed

$dataobj->queue_removed

Add an index removed event to the indexer's queue.

User Comments

has_owner

$boolean = $dataobj->has_owner( $user )

Return true if $user owns this record. Normally this means they created it, but a group of users could count as owners of the same record if you wanted.

It's false on most data objects, except those which override this method.

User Comments

permit

$rc = $dataobj->permit( $priv, [ $user ] )
 # current user can edit via editorial role
 if( $dataobj->permit( "xxx/edit", $user ) & 8 )
 {
   ...
 }
 # anyone can view this object
 if( $dataobj->permit( "xxx/view" ) )
 {
 }

Returns true if the specified $user (or 'anybody') can perform this action.

Returns a bit mask where:

 0 - not permitted
 1 - anybody
 2 - logged in user
 4 - user as owner
 8 - user as editor

User Comments

in_editorial_scope_of

$boolean = $dataobj->in_editorial_scope_of( $user )

As for has_owner, but if the $user is identified as someone with an editorial scope which includes this record.

Defaults to true. Which doesn't mean that they have the right to edit it, just that their scope matches. You also need editor rights to use this. It's currently used just to filter eprint editors so that only ones with appropriate scope and privilege can edit.

User Comments

validate

$problems = $dataobj->validate( $for_archive )

Validate this data object. Not used on all sub-classed. $for_archive being true indicates that the item is beting validated to go live.

Returns a reference to an array of XHTML DOM objects describing validation problems with the entire data object for the supplied $for_archive archive ID.

A reference to an empty array indicates no problems.

User Comments

get_warnings

$warnings = $dataobj->get_warnings

Returns a reference to an array of XHTML DOM objects describing problems with the entire data object.

A reference to an empty array indicates no problems.

User Comments

validate_field

@problems = $dataobj->validate_field( $fieldname )

Check if a field named $fieldname is valid.

Returns a reference to an array of XHTML problems.

A reference to an empty array indicates no problems.

User Comments

tidy

$dataobj->tidy

Cleans up any multiple fields with gaps.

User Comments

add_stored_file

$file = $dataobj->add_stored_file( $filename, $filehandle, $filesize )

Convenience method to add (or replace) the file record for $filename to this object. Reads $filesize bytes from $filehandle.

Returns the file object or undef if the storage failed.

User Comments

stored_file

$file = $dataobj->stored_file( $filename )

Get the file object for $filename.

Returns the file object or undef if the file doesn't exist.

Has alias:

$dataobj->get_stored_file( $filename )

User Comments

add_dataobj_relations

$dataobj->add_dataobj_relations( $target, %relations )

Add a relation from this data object to the $target data object using predicates defined in the keys of the %relations hash. If values are defined in the hash reciprocal relationships from the $target data object to this data object are also.

You must commit $target data object after calling this method.

Has alias:

$dataobj->add_object_relations( $target, %relations )

User Comments

has_dataobj_relations

$boolean = $dataobj->has_dataobj_relations( $target, @required )

Returns true if this object is related to $target by all @required.

If @required is empty will return true if any relationships exist.

Has alias:

$dataobj->has_object_relations( $target, @required )

User Comments

has_related_dataobjs

$boolean = $dataobj->has_related_dataobjs( @required )

Returns true if related_dataobjs would return some objects but without actually retrieving the related objects from the database.

Has alias:

$dataobj->has_related_objects( @required )

User Comments

related_dataobjs

@dataobjs = $dataobj->related_dataobjs( @required )

Returns a list of objects related to this data object by a relation in @required.

Has alias:

$dataobj->get_related_objects( @required )

User Comments

remove_dataobj_relations

$dataobj->remove_dataobj_relations( $target, %relations )

Remove relations between this data object and the $target data object. If %relations is not empty only remove those relationships which are keys in this hash.

You must commit this object and $target to write the changes.

Has alias:

$dataobj->remove_object_relations( $target, %relations )

User Comments

COPYRIGHT

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

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

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 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 3.4. If not, see http://www.gnu.org/licenses/.

User Comments

@@ Line 46: / Line 46: @@
   $dataobj = $dataobj-&gt;create_subobject( $fieldname, $epdata );
+<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=head_core_metadata_fields -->
+==CORE METADATA FIELDS==
+None. This is an abstract class from which real data objects  inherit and then add their metadata fields.
+<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=head_references_and_related_objects -->
+==REFERENCES AND RELATED OBJECTS==
+None. This is an abstract class from which real data objects inherit and then add their references and related objects.
 <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 113: / Line 135: @@
 ===$self-&gt;{session}===
-The current [[API:EPrints/Repository|EPrints::Repository]]. This use to be  [[API:EPrints/Session|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatability|EPrints::BackCompatability]].
+The current [[API:EPrints/Repository|EPrints::Repository]]. This use to be [[API:EPrints/Session|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatibility|EPrints::BackCompatibility]].
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 125: / Line 147: @@
 ===$self-&gt;{under_construction}===
-A boolean signifying if the data object is currently under  construction and therefore know house-keeping should be carried out  on the data object whilst set.
+A boolean signifying if the data object is currently under construction and therefore know house-keeping should be carried out on the data object whilst set.
-<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=head_core_metadata_fields -->
-==CORE METADATA FIELDS==
-None. This is an abstract class from which real data objects  inherit and then add their metadata fields.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

Difference between revisions of "API:EPrints/DataObj"

Latest revision as of 16:41, 10 January 2022

Contents

NAME

DESCRIPTION

Synopsis

CORE METADATA FIELDS

REFERENCES AND RELATED OBJECTS

INSTANCE VARIABLES

$self->{changed}

$self->{data}

$self->{dataset}

$self->{non_volatile_change}

$self->{session}

$self->{under_construction}

METHODS

Constructor Methods

new

new_from_data

create

create_from_data

Class Methods

get_system_field_info

get_defaults

get_dataset_id

xml_to_epdata

export_fieldlist

in_export_fieldlist

start_element

end_element

characters

Object Methods

clone

create_subdataobj

local_path

update_triggers

delete

empty

update

set_under_construction

under_construction

clear_changed

clear_citationcaches

commit

value

set_value

set_value_raw

get_values

repository

get_data

get_dataset

is_set

exists_and_set

id

get_gid

get_datestamp

render_value

render_citation

render_citation_link

render_citation_link

render_description

render

render_full

render_export_links

render_export_bar

uri

internal_uri

path

url

get_control_url

get_type

to_xml

to_sax

export

queue_changes

queue_all

queue_fulltext

queue_removed

has_owner

permit