org.dspace.content.crosswalk

Class XSLTIngestionCrosswalk

java.lang.Object

org.dspace.core.SelfNamedPlugin

org.dspace.content.crosswalk.XSLTCrosswalk

org.dspace.content.crosswalk.XSLTIngestionCrosswalk

All Implemented Interfaces:

IngestionCrosswalk

public class XSLTIngestionCrosswalk
extends XSLTCrosswalk
implements IngestionCrosswalk

Configurable XSLT-driven ingestion Crosswalk

See the XSLTCrosswalk superclass for details on configuration.

Author:

Larry Stone

See Also:

XSLTCrosswalk

Field Summary

Fields inherited from class org.dspace.content.crosswalk.XSLTCrosswalk

CONFIG_PREFIX, DIM_NS

Constructor Summary

Constructors

Constructor and Description
XSLTIngestionCrosswalk()

Method Summary

Methods

Modifier and Type	Method and Description
static String[]	getPluginNames()
void	ingest(Context context, DSpaceObject dso, org.jdom.Element root, boolean createMissingMetadataFields) Ingest a whole document.
void	ingest(Context context, DSpaceObject dso, List<org.jdom.Element> metadata, boolean createMissingMetadataFields) Translate metadata with XSL stylesheet and ingest it.
static void	ingestDIM(Context context, DSpaceObject dso, org.jdom.Element dim, boolean createMissingMetadataFields) Ingest a DIM metadata expression directly, without translating some other format into DIM.
static void	ingestDIM(Context context, DSpaceObject dso, List<org.jdom.Element> fields, boolean createMissingMetadataFields)
static void	main(String[] argv) Simple command-line rig for testing the DIM output of a stylesheet.

Methods inherited from class org.dspace.content.crosswalk.XSLTCrosswalk

getTransformer, makeAliases

Methods inherited from class org.dspace.core.SelfNamedPlugin

getPluginInstanceName, setPluginInstanceName

Methods inherited from class java.lang.Object

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

Constructor Detail

XSLTIngestionCrosswalk

public XSLTIngestionCrosswalk()

Method Detail

getPluginNames

public static String[] getPluginNames()

ingest

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

Translate metadata with XSL stylesheet and ingest it. Translation produces a list of DIM "field" elements; these correspond directly to Item.addMetadata() calls so they are simply executed.

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - DSpace context.

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

metadata - 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

ingest

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

Ingest a whole document. Build Document object around root element, and feed that to the transformation, since it may get handled differently than a List of metadata elements.

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

ingestDIM

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

Ingest a DIM metadata expression directly, without translating some other format into DIM. The dim element is expected to be be the root of a DIM document.

Note that this is ONLY implemented for Item, Collection, and Community objects. Also only works for the "dc" metadata schema.

Parameters:

context - the context

dso - object into which to ingest metadata

dim - root of a DIM expression

Throws:

CrosswalkException

IOException

SQLException

AuthorizeException

ingestDIM

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

Throws:

CrosswalkException

IOException

SQLException

AuthorizeException

main

public static void main(String[] argv)
                 throws Exception

Simple command-line rig for testing the DIM output of a stylesheet. Usage: java XSLTIngestionCrosswalk

Throws:

Exception