org.dspace.sword2

Class AbstractSwordContentIngester

java.lang.Object

org.dspace.sword2.AbstractSwordContentIngester

All Implemented Interfaces:

SwordContentIngester

Direct Known Subclasses:

BinaryContentIngester, SimpleZipContentIngester, SwordMETSContentIngester

public abstract class AbstractSwordContentIngester
extends Object
implements SwordContentIngester

Constructor Summary

Constructors

Constructor and Description
AbstractSwordContentIngester()

Method Summary

Methods

Modifier and Type	Method and Description
protected DCValue	configToDC(String config, String def) Utility method to turn given metadata fields of the form schema.element.qualifier into DCValue objects which can be used to access metadata in items.
protected BitstreamFormat	getFormat(Context context, String fileName)
DepositResult	ingest(Context context, org.swordapp.server.Deposit deposit, DSpaceObject dso, VerboseDescription verboseDescription) Ingest the package as described in the given Deposit object within the given DSpace Context
DepositResult	ingest(Context context, org.swordapp.server.Deposit deposit, DSpaceObject dso, VerboseDescription verboseDescription, DepositResult result)
abstract DepositResult	ingestToCollection(Context context, org.swordapp.server.Deposit deposit, Collection collection, VerboseDescription verboseDescription, DepositResult result)
abstract DepositResult	ingestToItem(Context context, org.swordapp.server.Deposit deposit, Item item, VerboseDescription verboseDescription, DepositResult result)
protected void	setSlug(Item item, String slugVal, VerboseDescription verboseDescription) Store the given slug value (which is used for suggested identifiers, and which DSpace ignores) in the item metadata.
protected void	setUpdatedDate(Item item, VerboseDescription verboseDescription) Add the current date to the item metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSwordContentIngester

public AbstractSwordContentIngester()

Method Detail

ingest

public DepositResult ingest(Context context,
                   org.swordapp.server.Deposit deposit,
                   DSpaceObject dso,
                   VerboseDescription verboseDescription)
                     throws DSpaceSwordException,
                            org.swordapp.server.SwordError,
                            org.swordapp.server.SwordAuthException,
                            org.swordapp.server.SwordServerException

Description copied from interface: SwordContentIngester

Ingest the package as described in the given Deposit object within the given DSpace Context

Specified by:

ingest in interface SwordContentIngester

Returns:

the result of the deposit

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

org.swordapp.server.SwordAuthException

org.swordapp.server.SwordServerException

ingest

public DepositResult ingest(Context context,
                   org.swordapp.server.Deposit deposit,
                   DSpaceObject dso,
                   VerboseDescription verboseDescription,
                   DepositResult result)
                     throws DSpaceSwordException,
                            org.swordapp.server.SwordError,
                            org.swordapp.server.SwordAuthException,
                            org.swordapp.server.SwordServerException

Specified by:

ingest in interface SwordContentIngester

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

org.swordapp.server.SwordAuthException

org.swordapp.server.SwordServerException

ingestToCollection

public abstract DepositResult ingestToCollection(Context context,
                               org.swordapp.server.Deposit deposit,
                               Collection collection,
                               VerboseDescription verboseDescription,
                               DepositResult result)
                                          throws DSpaceSwordException,
                                                 org.swordapp.server.SwordError,
                                                 org.swordapp.server.SwordAuthException,
                                                 org.swordapp.server.SwordServerException

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

org.swordapp.server.SwordAuthException

org.swordapp.server.SwordServerException

ingestToItem

public abstract DepositResult ingestToItem(Context context,
                         org.swordapp.server.Deposit deposit,
                         Item item,
                         VerboseDescription verboseDescription,
                         DepositResult result)
                                    throws DSpaceSwordException,
                                           org.swordapp.server.SwordError,
                                           org.swordapp.server.SwordAuthException,
                                           org.swordapp.server.SwordServerException

Throws:

DSpaceSwordException

org.swordapp.server.SwordError

org.swordapp.server.SwordAuthException

org.swordapp.server.SwordServerException

getFormat

protected BitstreamFormat getFormat(Context context,
                        String fileName)
                             throws SQLException

Throws:

SQLException

setUpdatedDate

protected void setUpdatedDate(Item item,
                  VerboseDescription verboseDescription)
                       throws DSpaceSwordException

Add the current date to the item metadata. This looks up the field in which to store this metadata in the configuration sword.updated.field

Parameters:

item -

Throws:

DSpaceSwordException

setSlug

protected void setSlug(Item item,
           String slugVal,
           VerboseDescription verboseDescription)
                throws DSpaceSwordException

Store the given slug value (which is used for suggested identifiers, and which DSpace ignores) in the item metadata. This looks up the field in which to store this metadata in the configuration sword.slug.field

Parameters:

item -

slugVal -

Throws:

DSpaceSwordException

configToDC

protected DCValue configToDC(String config,
                 String def)

Utility method to turn given metadata fields of the form schema.element.qualifier into DCValue objects which can be used to access metadata in items. The def parameter should be null, * or "" depending on how you intend to use the DCValue object.

Parameters:

config -

def -