|
|
| Line 1: |
Line 1: |
| <!-- Pod2Wiki=_preamble_
| |
| This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
| |
| -->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Import.pm|package_name=EPrints::DataObj::Import}}[[Category:API|Import]]<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_name -->=NAME=
| |
| '''EPrints::DataObj::Import''' - bulk imports logging
| |
|
| |
|
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_description -->=DESCRIPTION=
| |
| Inherits from [[API:EPrints/DataObj|EPrints::DataObj]].
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_instance_variables -->=INSTANCE VARIABLES=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "data" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "dataset" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "session" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_core_fields -->=CORE FIELDS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_importid -->==importid==
| |
|
| |
| Unique id for the import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_datestamp -->==datestamp==
| |
|
| |
| Time of import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_userid -->==userid==
| |
|
| |
| Id of the user responsible for causing the import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_source_repository -->==source_repository==
| |
|
| |
| Source entity from which this import came.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_url -->==url==
| |
|
| |
| Location of the imported content (e.g. the file name).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_description -->==description==
| |
|
| |
| Human-readable description of the import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_methods -->=METHODS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
| |
|
| |
| $thing = EPrints::DataObj::Import->get_system_field_info
| |
|
| |
| Core fields contained in a Web import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new -->===new===
| |
|
| |
| $thing = EPrints::DataObj::Import->new( $session, $importid )
| |
|
| |
| The data object identified by $importid.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new_from_data -->===new_from_data===
| |
|
| |
| $thing = EPrints::DataObj::Import->new_from_data( $session, $known )
| |
|
| |
| A new <tt>EPrints::DataObj::Import</tt> object containing data $known (a hash reference).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_class_methods -->==Class Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove_all -->===remove_all===
| |
|
| |
| EPrints::DataObj::Import::remove_all( $session )
| |
|
| |
| Remove all records from the license dataset.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_defaults -->===get_defaults===
| |
|
| |
| $defaults = EPrints::DataObj::Import->get_defaults( $session, $data )
| |
|
| |
| Return default values for this object based on the starting data.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_object_methods -->==Object Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_remove -->===remove===
| |
|
| |
| $foo = $thing->remove()
| |
|
| |
| Remove this record from the data set (see [[API:EPrints/Database|EPrints::Database]]).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_run -->===run===
| |
|
| |
| $list = $import->run( $processor )
| |
|
| |
| Run this bulk import. Returns a list of EPrints created. $processor is used for reporting errors.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_clear -->===clear===
| |
|
| |
| $import->clear()
| |
|
| |
| Clear the contents of this bulk import.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_from_source -->===get_from_source===
| |
|
| |
| $eprint = $import->get_from_source( $sourceid )
| |
|
| |
| Get the $eprint that is from this import set and identified by $sourceid.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_see_also -->=SEE ALSO=
| |
| [[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
| |