org.dspace.app.itemimport

Class ItemImport

java.lang.Object

org.dspace.app.itemimport.ItemImport

public class ItemImport
extends java.lang.Object

Import items into DSpace. The conventional use is upload files by copying them. DSpace writes the item's bitstreams into its assetstore. Metadata is also loaded to the DSpace database.

A second use assumes the bitstream files already exist in a storage resource accessible to DSpace. In this case the bitstreams are 'registered'. That is, the metadata is loaded to the DSpace database and DSpace is given the location of the file which is subsumed into DSpace.

The distinction is controlled by the format of lines in the 'contents' file. See comments in processContentsFile() below.

Modified by David Little, UCSD Libraries 12/21/04 to allow the registration of files (bitstreams) into DSpace.

Constructor Summary

Constructors

Constructor and Description
ItemImport()

Method Summary

Methods

Modifier and Type	Method and Description
void	addItems(Context c, Collection[] mycollections, java.lang.String sourceDir, java.lang.String mapFile, boolean template)
void	addItemsAtomic(Context c, Collection[] mycollections, java.lang.String sourceDir, java.lang.String mapFile, boolean template)
static void	cleanupZipTemp()
void	deleteBatchUpload(Context c, java.lang.String uploadId)
static void	emailErrorMessage(EPerson eperson, java.lang.String error) Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure.
static void	emailSuccessMessage(Context context, EPerson eperson, java.lang.String fileName) Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure.
static java.util.List<BatchUpload>	getImportsAvailable(EPerson eperson)
static java.lang.String	getImportUploadableDirectory(int ePersonID)
static java.lang.String	getTempWorkDir()
static java.io.File	getTempWorkDirFile()
static void	main(java.lang.String[] argv)
static void	processUIImport(java.lang.String filepath, Collection owningCollection, java.lang.String[] otherCollections, java.lang.String resumeDir, java.lang.String inputType, Context context) Given a local file or public URL to a zip file that has the Simple Archive Format, this method imports the contents to DSpace
static java.lang.String	unzip(java.io.File zipfile)
static java.lang.String	unzip(java.io.File zipfile, java.lang.String destDir)
static java.lang.String	unzip(java.lang.String sourcedir, java.lang.String zipfilename)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ItemImport

public ItemImport()

Method Detail

main

public static void main(java.lang.String[] argv)
                 throws java.lang.Exception

Throws:

java.lang.Exception

addItemsAtomic

public void addItemsAtomic(Context c,
                  Collection[] mycollections,
                  java.lang.String sourceDir,
                  java.lang.String mapFile,
                  boolean template)
                    throws java.lang.Exception

Throws:

java.lang.Exception

addItems

public void addItems(Context c,
            Collection[] mycollections,
            java.lang.String sourceDir,
            java.lang.String mapFile,
            boolean template)
              throws java.lang.Exception

Throws:

java.lang.Exception

unzip

public static java.lang.String unzip(java.io.File zipfile)
                              throws java.io.IOException

Throws:

java.io.IOException

unzip

public static java.lang.String unzip(java.io.File zipfile,
                     java.lang.String destDir)
                              throws java.io.IOException

Throws:

java.io.IOException

unzip

public static java.lang.String unzip(java.lang.String sourcedir,
                     java.lang.String zipfilename)
                              throws java.io.IOException

Throws:

java.io.IOException

processUIImport

public static void processUIImport(java.lang.String filepath,
                   Collection owningCollection,
                   java.lang.String[] otherCollections,
                   java.lang.String resumeDir,
                   java.lang.String inputType,
                   Context context)
                            throws java.lang.Exception

Given a local file or public URL to a zip file that has the Simple Archive Format, this method imports the contents to DSpace

Parameters:

filepath - The filepath to local file or the public URL of the zip file

owningCollection - The owning collection the items will belong to

otherCollections - The collections the created items will be inserted to, apart from the owning one

resumeDir - In case of a resume request, the directory that containsthe old mapfile and data

inputType - The input type of the data (bibtex, csv, etc.), in case of local file

context - The context

Throws:

java.lang.Exception

emailSuccessMessage

public static void emailSuccessMessage(Context context,
                       EPerson eperson,
                       java.lang.String fileName)
                                throws javax.mail.MessagingException

Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure. We accomplish this communication with email instead. Send a success email once the batch import is complete

Parameters:

context - - the current Context

eperson - - eperson to send the email to

fileName - - the filepath to the mapfile created by the batch import

Throws:

javax.mail.MessagingException

emailErrorMessage

public static void emailErrorMessage(EPerson eperson,
                     java.lang.String error)
                              throws javax.mail.MessagingException

Since the BTE batch import is done in a new thread we are unable to communicate with calling method about success or failure. We accomplis this communication with email instead. Send an error email if the batch import fails

Parameters:

eperson - - EPerson to send the error message to

error - - the error message

Throws:

javax.mail.MessagingException

getImportsAvailable

public static java.util.List<BatchUpload> getImportsAvailable(EPerson eperson)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

getImportUploadableDirectory

public static java.lang.String getImportUploadableDirectory(int ePersonID)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

deleteBatchUpload

public void deleteBatchUpload(Context c,
                     java.lang.String uploadId)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getTempWorkDir

public static java.lang.String getTempWorkDir()

getTempWorkDirFile

public static java.io.File getTempWorkDirFile()

cleanupZipTemp

public static void cleanupZipTemp()