API:EPrints/DataObj/Import

From EPrints Documentation
Jump to: navigation, search

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::Import - bulk imports logging

User Comments


DESCRIPTION

This class represents a mass import of record's (i.e. eprint data objects) into a repository.

User Comments


CORE METADATA FIELDS

User Comments


importid (counter)

Unique ID for the import.

User Comments


datestamp (timestamp)

Time import record was created.

User Comments


source_repository (text)

Source entity from which this import came.

User Comments


url (longtext)

Location of the imported content (e.g. the file name).

User Comments


description (longtext)

Human-readable description of the import.

User Comments


last_run (time)

Time the import was last started.

User Comments


last_success (time)

Time the import was last successfully completed.

User Comments


REFERENCES AND RELATED OBJECTS

User Comments


userid (itemref)

ID of the user responsible for causing the import.

User Comments


INSTANCE VARIABLES

See EPrints::DataObj.

User Comments


METHODS

User Comments


Class Methods

User Comments


get_system_field_info

$fields = EPrints::DataObj::Import->get_system_field_info

Returns an array describing the system metadata of the import dataset.

User Comments


get_dataset_id

$dataset = EPrints::DataObj::Import->get_dataset_id

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

User Comments


Object Methods

User Comments


run

$list = $import->run( $processor )

Run this bulk import. Returns a list of created eprint data objects. $processor is used for reporting errors.

User Comments


map

$import->map( $fn, $info )

Maps the function $fn onto every eprint in this import.

$info provides additonal information that may need to be processed by the function $fn.

User Comments


clear

$import->clear

Clear the contents of this bulk import.

User Comments


get_list

$list = $import->get_list

Returns a list of the items in this import.

User Comments


get_from_source

$eprint = $import->get_from_source( $sourceid )

Get the eprint that is from this import set and identified by $sourceid.

User Comments


epdata_to_dataobj

$dataobj = $import->epdata_to_dataobj( $dataset, $epdata )

Convert $epdata to an eprint data object. If an existing object exists in this import that has the same identifier that object will be used instead of creating a new object.

Also calls set_eprint_import_automatic_fields on the object before writing it to the database.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2023 University of Southampton.

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