Difference between revisions of "API:EPrints/Plugin/Import"

From EPrints Documentation
Jump to: navigation, search
Line 84: Line 84:
  
 
</source>
 
</source>
Turn $epdata into a [[API:EPrints/DataObj|EPrints::DataObj]] with the dataset passed in %opts.
+
Turn <code>$epdata</code> into a [[API:EPrints/DataObj|EPrints::DataObj]] using the [[API:EPrints/DataSet|dataset]] argument passed in %opts.
  
Calls handler to perform the actual creation.
+
Uses the [[API:EPrints/Plugin/Import#handler|handler]] object to perform the actual object creation.
 +
 
 +
When sub-classing you '''must''' call <code>epdata_to_dataobj</code> in order to correctly handle the parse-only and test phases during import.
  
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->

Revision as of 11:23, 2 April 2012

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::Plugin::Import


METHODS

new

$plugin = EPrints::Plugin::Import->new( %params )

Creates a new Import plugin. In addition to those parameters defined by EPrints::Plugin:

  • accept
Array reference of acceptable MIME types. By default includes application/x-eprints-import-XXX, where XXX is the case-insensitive id of the plugin.
  • actions
Array reference of named actions.
  • advertise
Boolean for whether to advertise this plugin to users.
  • arguments
Hash reference of supported arguments/default values.
  • Handler
Reference to a handler class, typically EPrints::CLIProcessor or EPrints::ScreenProcessor.
  • produce
Array reference of object types this plugin can produce.
  • screen
The screen id this plugin uses to provide its import UI.
  • visible
"staff" (staff only) or "all" (anyone).


input_fh

$plugin->input_fh( fh => FILEHANDLE [, %opts] )

Import one or more objects from filehandle FILEHANDLE. FILEHANDLE should be set to binary semantics.

This method should by subclassed.


input_file

$plugin->input_file( filename => FILENAME [, %opts] )

Opens FILENAME for reading, sets binary semantics and calls input_fh to actually read the file.

This method may be subclassed (e.g. see EPrints::Plugin::Import::TextFile).


epdata_to_dataobj

$dataobj = $plugin->epdata_to_dataobj( $epdata, %opts )

Turn $epdata into a EPrints::DataObj using the dataset argument passed in %opts.

Uses the handler object to perform the actual object creation.

When sub-classing you must call epdata_to_dataobj in order to correctly handle the parse-only and test phases during import.


COPYRIGHT

Copyright 2000-2012 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/.