API:EPrints/Plugin/Import

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

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

Create a new Import plugin. Available options:

• accept

  Array reference of acceptable MIME types.

• 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 eprint types this plugin can produce.

• screen

  The screen id this plugin uses to provide its import UI.

• visible

  "staff" (staff only) or "all" (anyone).

$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.

$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).

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

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

Calls handler to perform the actual creation.

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/.