Package org.dspace.content.crosswalk

Interface IngestionCrosswalk

All Known Implementing Classes:

AIPDIMCrosswalk, AIPTechMDCrosswalk, DIMIngestionCrosswalk, METSRightsCrosswalk, NullIngestionCrosswalk, OAIDCIngestionCrosswalk, OREIngestionCrosswalk, PREMISCrosswalk, QDCCrosswalk, RoleCrosswalk, XSLTIngestionCrosswalk

public interface IngestionCrosswalk

Ingestion Crosswalk plugin -- translate an external metadata format into DSpace native metadata.

This describes a plugin that translates an external XML metadata format (e.g. MODS) into the DSpace internal metadata representation. A crosswalk plugin may operate on different kinds of DSpace Objects, so the concept of "metadata" encompasses the qualified Dublin Core fields on Items, properties of Bitstreams, and metadata on Collections and Communities.

Version:

$Revision$

Author:

Larry Stone

Method Summary

Modifier and Type	Method	Description
void	ingest(Context context, DSpaceObject dso, List<org.jdom.Element> metadata, boolean createMissingMetadataFields)	Crosswalk metadata from external XML representation to DSpace internal representations.
void	ingest(Context context, DSpaceObject dso, org.jdom.Element root, boolean createMissingMetadataFields)	Crosswalk metadata from external XML representation to DSpace internal representations.

Method Detail

ingest

void ingest(Context context,
            DSpaceObject dso,
            List<org.jdom.Element> metadata,
            boolean createMissingMetadataFields)
     throws CrosswalkException,
            IOException,
            SQLException,
            AuthorizeException

Crosswalk metadata from external XML representation to DSpace internal representations. This version accepts metadata as a List of JDOM XML elements. It interprets the contents of each element and adds the appropriate values to the DSpace Object's internal metadata represenation.

Note that this method may be called several times for the same target Item, if the metadata comes as several lists of elements, so it should not add fixed metadata values on each or they may appear multiples times.

NOTE:
Most XML metadata standards (e.g. MODS) are defined as a "root" element which contains a sequence of "fields" that have the descriptive information. Some metadata containers have a "disembodied" list of fields, rather than the root element, so this ingest method is intended to accept that bare list of fields. However, it must also accept a list containing only the "root" element for the metadata structure (e.g. the "mods:mods" wrapper in a MODS expression) as a member of the list. It can handle this case by calling the single-element version of ingest() on the "root" element.

Some callers of the crosswalk plugin may not be careful about (or capable of) choosing whether the list or element version should be called.

Parameters:

context - DSpace context.

dso - DSpace Object (Item, Bitstream, etc) to which new metadata gets attached.

metadata - List of XML Elements of metadata

createMissingMetadataFields - whether to create missing fields

Throws:

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

CrosswalkObjectNotSupported - (CrosswalkException) Cannot crosswalk into this kind of DSpace object.

MetadataValidationException - (CrosswalkException) metadata format was not acceptable or missing required elements.

IOException - I/O failure in services this calls

SQLException - Database failure in services this calls

AuthorizeException - current user not authorized for this operation.

CrosswalkException

ingest

void ingest(Context context,
            DSpaceObject dso,
            org.jdom.Element root,
            boolean createMissingMetadataFields)
     throws CrosswalkException,
            IOException,
            SQLException,
            AuthorizeException

Crosswalk metadata from external XML representation to DSpace internal representations. This version accepts a single "root" element of the XML metadata.

It is otherwise just like the List form of ingest() above.

Parameters:

context - DSpace context.

dso - DSpace Object (usually an Item) to which new metadata gets attached.

root - root Element of metadata document.

createMissingMetadataFields - whether to create missing fields

Throws:

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

CrosswalkObjectNotSupported - (CrosswalkException) Cannot crosswalk into this kind of DSpace object.

MetadataValidationException - (CrosswalkException) metadata format was not acceptable or missing required elements.

IOException - I/O failure in services this calls

SQLException - Database failure in services this calls

AuthorizeException - current user not authorized for this operation.

CrosswalkException