interface: ExportHandler

public abstract <<interface>> interface: ExportHandler
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:16:32; Modified: 16.07.2009 15:16:32;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {6E13D297-E34B-47b6-A808-B37C01E57D63}
 

Goto: Fields, Methods

See also: Export, ExportHandlerBean, ExportIntegrationTest

Appears in: exportmanager

Connections
 
ExportHandler Attributes
Attribute Details
package String
  SERVICE_NAME
Initial: "ejb/de/mpg/escidoc/services/exportmanager/ExportHandler"
Notes: The name to obtain this service.
 
ExportHandler Methods
Operation Details
package
calculateItemListFileSizes(
   String itemList):long
Sequential
Tags: throws=ExportManagerException
Notes: Calculates complete sum of the file sizes referenced from the itemList. The following elements are taken for the size calculation: {http://www.escidoc.de/schemas/metadatarecords/0.4}md-records/{http://escidoc.mpg.de/metadataprofile/schema/0.1/file}file/{http://purl.org/dc/terms/}extent
@return Sum of the file sizes
package
explainFormatsXML():String
Sequential
Tags: throws=ExportManagerException,IOException
Notes: This method provides XML formatted output of the supported export formats
package
generateArchive(
   String exportFormat,
   String archiveFormat,
   byte[] description,
   String itemListFiltered):byte
Sequential
Tags: throws=ExportManagerException,IOException
Notes: Generates archive, put the following issues in it: 1) All files, referenced via URIs in the <code>itemListFiltered</code> XML 2) Description of the list, content of the <code>description</code> 3) License agreement
@return archive as byte[]
package
generateArchive(
   String archiveFormat,
   String itemListFiltered):byte
Sequential
Tags: throws=ExportManagerException,IOException
Notes: Generates archive, put the following issues in it: 1) All files, referenced via URIs in the <code>itemListFiltered</code> XML 2) License agreement
@return archive as byte[]
package
generateArchiveFile(
   String exportFormat,
   String archiveFormat,
   byte[] description,
   String itemListFiltered):File
Sequential
Tags: throws=ExportManagerException,IOException
Notes: Generates archive, put the following issues in it: 1) All files, referenced via URIs in the <code>itemListFiltered</code> XML 2) Description of the list, content of the <code>description</code> 3) License agreement To be used in case of the huge sizes, which can be precalculated with {@link calculateItemListFileSizes(java.lang.String) calculateItemListFileSizes} P.S. Please delete generated File since processing of it will be finished!
@return archive as <code>java.io.File</code> reference
package
getOutput(
   String exportFormat,
   String outputFormat,
   String archiveFormat,
   String filteredItemList):byte
Sequential
Tags: throws=ExportManagerException,IOException
Notes: Returns data presenting the items in export format.
@return export as byte[]
package
getOutputFile(
   String exportFormat,
   String outputFormat,
   String archiveFormat,
   String filteredItemList):File
Sequential
Tags: throws=ExportManagerException,IOException
Notes: Returns data presenting the items in export format. Used in the cases of the huge sizes.
@link generateArchiveFile(java.lang.String, java.lang.String, byte[], java.lang.String) generateArchiveFile}. If <code>null</code>, the archive will not be created.
@return export as <code>java.io.File</code>