org.dspace.content.crosswalk

Class NullIngestionCrosswalk

java.lang.Object

org.dspace.content.crosswalk.NullIngestionCrosswalk

All Implemented Interfaces:

IngestionCrosswalk

public class NullIngestionCrosswalk
extends Object
implements IngestionCrosswalk

"Null" ingestion crosswalk

Use this crosswalk to ignore a metadata record on ingest. It was intended to be used with a package importer such as the METS packager, which may receive metadata records of types for which it hasn't got a crosswalk. The safest thing to do with these is ignore them. To do that, use the plugin configuration to map the name of the metadata type to this plugin (or within the METS ingester, use its metadata-name remapping configuration).

 # ignore LOM metadata when it comes up:
 plugin.named.org.dspace.content.crosswalk.SubmissionCrosswalk = \
   org.dspace.content.crosswalk.NullIngestionCrosswalk = NULL, LOM
 

Version:

$Revision$

Author:

Larry Stone

Constructor Summary

Constructors

Constructor and Description
NullIngestionCrosswalk()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NullIngestionCrosswalk

public NullIngestionCrosswalk()

Method Detail

ingest

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

Description copied from interface: IngestionCrosswalk

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.

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - DSpace context.

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

root - root Element of metadata document.

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

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

Description copied from interface: IngestionCrosswalk

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.

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - DSpace context.

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

ml - List of XML Elements of metadata

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

preferList

public boolean preferList()