Package org.dspace.content.packager

Class DSpaceMETSIngester

java.lang.Object

org.dspace.content.packager.AbstractPackageIngester

org.dspace.content.packager.AbstractMETSIngester

org.dspace.content.packager.DSpaceMETSIngester

All Implemented Interfaces:

PackageIngester

public class DSpaceMETSIngester
extends AbstractMETSIngester

Packager plugin to ingest a METS (Metadata Encoding and Transmission Standard) package that conforms to the DSpace METS SIP (Submission Information Package) Profile. See http://www.loc.gov/standards/mets/ for more information on METS, and http://www.dspace.org/standards/METS/SIP/profilev0p9p1/metssipv0p9p1.pdf (or a similar file in the /standards/METS/SIP resource hierarchy) for more information about the DSpace METS SIP profile.

Version:

$Revision$

Author:

Larry Stone, Tim Donohue

See Also:

METSManifest, AbstractMETSIngester, AbstractPackageIngester, PackageIngester

Nested Class Summary

Nested classes/interfaces inherited from class org.dspace.content.packager.AbstractMETSIngester

AbstractMETSIngester.MdrefManager

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	PROFILE_START

Fields inherited from class org.dspace.content.packager.AbstractMETSIngester

bitstreamFormatService, bitstreamService, bundleService, collectionService, communityService, configurationService, handleService, itemService, workspaceItemService

Constructor Summary

Constructors

Constructor	Description
DSpaceMETSIngester()

Method Summary

Modifier and Type	Method	Description
void	addLicense(Context context, Item item, String license, Collection collection, PackageParameters params)	Policy: For DSpace deposit license, take deposit license supplied by explicit argument first, else use collection's default deposit license.
void	crosswalkObjectDmd(Context context, DSpaceObject dso, METSManifest manifest, AbstractMETSIngester.MdrefManager callback, org.jdom2.Element[] dmds, PackageParameters params)	Choose DMD section(s) to crosswalk.
void	finishBitstream(Context context, Bitstream bs, org.jdom2.Element mfile, METSManifest manifest, PackageParameters params)	Take a second pass over files to correct names of derived files (e.g.
void	finishObject(Context context, DSpaceObject dso, PackageParameters params)	Hook for final "finishing" operations on the new Object.
String	getConfigurationName()	Returns keyword that makes the configuration keys of this subclass unique, e.g.
int	getObjectType(METSManifest manifest)	Determines what type of DSpace object is represented in this METS doc.
String	getParameterHelp()	Returns a user help string which should describe the additional valid command-line options that this packager implementation will accept when using the -o or --option flags with the Packager script.
boolean	probe(Context context, InputStream in, PackageParameters params)

Methods inherited from class org.dspace.content.packager.AbstractMETSIngester

addBitstreams, addContainerLogo, addManifestBitstream, addTemplateItem, decodeHandleURN, getFileInputStream, getManifestBitstreamFormat, getObjectHandle, getObjectID, getParentObject, ingest, ingestObject, parsePackage, preserveManifest, removeObject, replace, replaceObject, useCollectionTemplate

Methods inherited from class org.dspace.content.packager.AbstractPackageIngester

addPackageReference, addToIngestedMap, getIngestedList, getIngestedMap, getPackageReferences, ingestAll, replaceAll

Methods inherited from class java.lang.Object

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

Field Detail

PROFILE_START

protected static final String PROFILE_START

See Also:

Constant Field Values

Constructor Detail

DSpaceMETSIngester

public DSpaceMETSIngester()

Method Detail

crosswalkObjectDmd

public void crosswalkObjectDmd(Context context,
                               DSpaceObject dso,
                               METSManifest manifest,
                               AbstractMETSIngester.MdrefManager callback,
                               org.jdom2.Element[] dmds,
                               PackageParameters params)
                        throws CrosswalkException,
                               PackageValidationException,
                               AuthorizeException,
                               SQLException,
                               IOException

Choose DMD section(s) to crosswalk.

The algorithm is:
1. Use whatever the dmd parameter specifies as the primary DMD.
2. If (1) is unspecified, find MODS (preferably) or DC as primary DMD.
3. If (1) or (2) succeeds, crosswalk it and ignore all other DMDs with same GROUPID
4. Crosswalk remaining DMDs not eliminated already.

Specified by:

crosswalkObjectDmd in class AbstractMETSIngester

Parameters:

context - the DSpace context

dso - DSpace Object

manifest - the METSManifest

callback - the MdrefManager (manages all external metadata files referenced by METS mdref elements)

dmds - array of Elements, each a METS dmdSec that applies to the Item as a whole.

params - Packager Parameters

Throws:

CrosswalkException - if crosswalk error

PackageValidationException - if validation error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

addLicense

public void addLicense(Context context,
                       Item item,
                       String license,
                       Collection collection,
                       PackageParameters params)
                throws PackageValidationException,
                       AuthorizeException,
                       SQLException,
                       IOException

Policy: For DSpace deposit license, take deposit license supplied by explicit argument first, else use collection's default deposit license. For Creative Commons, look for a rightsMd containing a CC license.

Specified by:

addLicense in class AbstractMETSIngester

Parameters:

context - the DSpace context

item - Item

license - optional user-supplied Deposit License text (may be null)

collection - DSpace Collection to which the item is being submitted.

params - Packager Parameters

Throws:

PackageValidationException - if validation error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

finishObject

public void finishObject(Context context,
                         DSpaceObject dso,
                         PackageParameters params)
                  throws PackageValidationException,
                         CrosswalkException,
                         AuthorizeException,
                         SQLException,
                         IOException

Description copied from class: AbstractMETSIngester

Hook for final "finishing" operations on the new Object. This method is called when the new Object is otherwise complete and ready to be returned. The implementation should use this opportunity to make whatever final checks and modifications are necessary.

Specified by:

finishObject in class AbstractMETSIngester

Parameters:

context - the DSpace context

dso - the DSpace Object

params - the Packager Parameters

Throws:

PackageValidationException - if package validation error

CrosswalkException - if crosswalk error

AuthorizeException - if authorization error

SQLException - if database error

IOException - if IO error

getObjectType

public int getObjectType(METSManifest manifest)
                  throws PackageValidationException

Description copied from class: AbstractMETSIngester

Determines what type of DSpace object is represented in this METS doc.

Specified by:

getObjectType in class AbstractMETSIngester

Parameters:

manifest - METS manifest

Returns:

one of the object types in Constants.

Throws:

PackageValidationException - if package validation error

finishBitstream

public void finishBitstream(Context context,
                            Bitstream bs,
                            org.jdom2.Element mfile,
                            METSManifest manifest,
                            PackageParameters params)
                     throws MetadataValidationException,
                            SQLException,
                            AuthorizeException,
                            IOException

Take a second pass over files to correct names of derived files (e.g. thumbnails, extracted text) to what DSpace expects:

Specified by:

finishBitstream in class AbstractMETSIngester

Parameters:

context - context

bs - bitstream

mfile - element

manifest - METS manifest

params - package params

Throws:

MetadataValidationException - if validation error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

getConfigurationName

public String getConfigurationName()

Description copied from class: AbstractMETSIngester

Returns keyword that makes the configuration keys of this subclass unique, e.g. if it returns NAME, the key would be: "mets.NAME.ingest.preserveManifest = true"

Specified by:

getConfigurationName in class AbstractMETSIngester

Returns:

name

probe

public boolean probe(Context context,
                     InputStream in,
                     PackageParameters params)

getParameterHelp

public String getParameterHelp()

Returns a user help string which should describe the additional valid command-line options that this packager implementation will accept when using the -o or --option flags with the Packager script.

Specified by:

getParameterHelp in interface PackageIngester

Overrides:

getParameterHelp in class AbstractMETSIngester

Returns:

a string describing additional command-line options available with this packager