Difference between revisions of "API:EPrints/DataObj/Import/XML"
(Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'...") |
|||
| Line 28: | Line 28: | ||
<!-- Pod2Wiki=head_methods --> | <!-- Pod2Wiki=head_methods --> | ||
==METHODS== | ==METHODS== | ||
| + | <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_constructor_methods --> | ||
| + | ===Constructor Methods=== | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <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> | <span style='display:none'>User Comments</span> | ||
| Line 36: | Line 45: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_new --> | <!-- Pod2Wiki=item_new --> | ||
| − | ===new=== | + | ====new==== |
$xml_import = EPrints::DataObj::Import::XML->new( %params ) | $xml_import = EPrints::DataObj::Import::XML->new( %params ) | ||
Create a new XML import data object using the <tt>%params</tt> provided. | Create a new XML import data object using the <tt>%params</tt> provided. | ||
| + | <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_class_methods --> | ||
| + | ===Class Methods=== | ||
| + | <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=item_warn --> | ||
| + | ====warn==== | ||
| + | |||
| + | EPrints::DataObj::Import::XML->warn | ||
| + | Suppress warnings, in particular that various imported fields do not exist in our repository. | ||
| + | |||
| + | <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_object_methods --> | ||
| + | ===Object Methods=== | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <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> | <span style='display:none'>User Comments</span> | ||
| Line 49: | Line 89: | ||
</div> | </div> | ||
<!-- Pod2Wiki=item_epdata_to_dataobj --> | <!-- Pod2Wiki=item_epdata_to_dataobj --> | ||
| − | ===epdata_to_dataobj=== | + | ====epdata_to_dataobj==== |
$dataobj = $xml_import->epdata_to_dataobj( $dataset, $epdata ) | $dataobj = $xml_import->epdata_to_dataobj( $dataset, $epdata ) | ||
| Line 63: | Line 103: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=head_see_also --> |
| − | == | + | ==SEE ALSO== |
| − | + | [[API:EPrints/Plugin/Import/XML|EPrints::Plugin::Import::XML]]. | |
| − | |||
| − | |||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
Latest revision as of 18:27, 7 January 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::DataObj::Import::XML - XML import.
DESCRIPTION
This is a utility module for importing existing eprints from an XML file. It inherits from EPrints::Plugin::Import::XML.
METHODS
Constructor Methods
new
$xml_import = EPrints::DataObj::Import::XML->new( %params )
Create a new XML import data object using the %params provided.
Class Methods
warn
EPrints::DataObj::Import::XML->warn
Suppress warnings, in particular that various imported fields do not exist in our repository.
Object Methods
epdata_to_dataobj
$dataobj = $xml_import->epdata_to_dataobj( $dataset, $epdata )
Create new data object for $dataset parsing the XML data in $epdata.
Returns the newly create data object.
SEE ALSO
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/.
