org.dspace.content.crosswalk

Class MODSDisseminationCrosswalk

java.lang.Object

org.dspace.core.SelfNamedPlugin

org.dspace.content.crosswalk.MODSDisseminationCrosswalk

All Implemented Interfaces:

DisseminationCrosswalk

public class MODSDisseminationCrosswalk
extends SelfNamedPlugin
implements DisseminationCrosswalk

Configurable MODS Crosswalk

This class supports multiple dissemination crosswalks from DSpace internal data to the MODS XML format (see http://www.loc.gov/standards/mods/.)

It registers multiple Plugin names, which it reads from the DSpace configuration as follows:

Configuration

Every key starting with "crosswalk.mods.properties." describes a MODS crosswalk. Everything after the last period is the plugin name, and the value is the pathname (relative to dspace.dir/config) of the crosswalk configuration file.

You can have two names point to the same crosswalk, just add two configuration entries with the same value, e.g.

    crosswalk.mods.properties.MODS = crosswalks/mods.properties
    crosswalk.mods.properties.default = crosswalks/mods.properties
 

The first line creates a plugin with the name "MODS" which is configured from the file dspace-dir/config/crosswalks/mods.properties.

Since there is significant overhead in reading the properties file to configure the crosswalk, and a crosswalk instance may be used any number of times, we recommend caching one instance of the crosswalk for each name and simply reusing those instances. The PluginService does this by default.

Version:

$Revision$

Author:

Larry Stone, Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionService	collectionService
protected CommunityService	communityService
protected ItemService	itemService
static org.jdom.Namespace	MODS_NS MODS namespace.
static String	MODS_XSD URL of MODS XML Schema

Fields inherited from interface org.dspace.content.crosswalk.DisseminationCrosswalk

XSI_NS

Constructor Summary

Constructors

Constructor and Description
MODSDisseminationCrosswalk()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDisseminate(DSpaceObject dso) ModsCrosswalk can disseminate: Items, Collections, Communities, and Site.
protected List<MockMetadataValue>	collection2Metadata(Collection collection) Generate a list of metadata elements for the given DSpace collection.
protected List<MockMetadataValue>	community2Metadata(Community community) Generate a list of metadata elements for the given DSpace community.
protected MockMetadataValue	createDCValue(String element, String qualifier, String value)
org.jdom.Element	disseminateElement(Context context, DSpaceObject dso) Disseminate an Item, Collection, or Community to MODS.
List<org.jdom.Element>	disseminateList(Context context, DSpaceObject dso) Returns object's metadata in MODS format, as List of XML structure nodes.
org.jdom.Namespace[]	getNamespaces() Return the MODS namespace
static String[]	getPluginNames()
String	getSchemaLocation() Return the MODS schema
protected List<MockMetadataValue>	item2Metadata(Item item) Generate a list of metadata elements for the given DSpace item.
boolean	preferList() ModsCrosswalk prefer's element form over list.
protected List<MockMetadataValue>	site2Metadata(Site site) Generate a list of metadata elements for the given DSpace site.

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

Field Detail

communityService

protected final CommunityService communityService

collectionService

protected final CollectionService collectionService

itemService

protected final ItemService itemService

MODS_NS

public static final org.jdom.Namespace MODS_NS

MODS namespace.

MODS_XSD

public static final String MODS_XSD

URL of MODS XML Schema

See Also:

Constant Field Values

Constructor Detail

MODSDisseminationCrosswalk

public MODSDisseminationCrosswalk()

Method Detail

getPluginNames

public static String[] getPluginNames()

getNamespaces

public org.jdom.Namespace[] getNamespaces()

Return the MODS namespace

Specified by:

getNamespaces in interface DisseminationCrosswalk

Returns:

array of namespaces, which may be empty.

getSchemaLocation

public String getSchemaLocation()

Return the MODS schema

Specified by:

getSchemaLocation in interface DisseminationCrosswalk

Returns:

SchemaLocation string, including URI namespace, followed by whitespace and URI of XML schema document, or empty string if unknown.

disseminateList

public List<org.jdom.Element> disseminateList(Context context,
                                     DSpaceObject dso)
                                       throws CrosswalkException,
                                              IOException,
                                              SQLException,
                                              AuthorizeException

Returns object's metadata in MODS format, as List of XML structure nodes.

Specified by:

disseminateList in interface DisseminationCrosswalk

Parameters:

context - context

dso - the DSpace Object whose metadata to export.

Returns:

results of crosswalk as list of XML elements.

Throws:

CrosswalkException

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

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

disseminateElement

public org.jdom.Element disseminateElement(Context context,
                                  DSpaceObject dso)
                                    throws CrosswalkException,
                                           IOException,
                                           SQLException,
                                           AuthorizeException

Disseminate an Item, Collection, or Community to MODS.

Specified by:

disseminateElement in interface DisseminationCrosswalk

Parameters:

context - context

dso - the DSpace Object whose metadata to export.

Returns:

root Element of the target metadata, never null

Throws:

CrosswalkException - if crosswalk error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

canDisseminate

public boolean canDisseminate(DSpaceObject dso)

ModsCrosswalk can disseminate: Items, Collections, Communities, and Site.

Specified by:

canDisseminate in interface DisseminationCrosswalk

Parameters:

dso - dspace object, e.g. an Item.

Returns:

true when disseminator is capable of producing metadata.

preferList

public boolean preferList()

ModsCrosswalk prefer's element form over list.

Specified by:

preferList in interface DisseminationCrosswalk

Returns:

true when disseminator prefers you call disseminateList().

site2Metadata

protected List<MockMetadataValue> site2Metadata(Site site)

Generate a list of metadata elements for the given DSpace site.

Parameters:

site - The site to derive metadata from

Returns:

list of metadata

community2Metadata

protected List<MockMetadataValue> community2Metadata(Community community)

Generate a list of metadata elements for the given DSpace community.

Parameters:

community - The community to derive metadata from

Returns:

list of metadata

collection2Metadata

protected List<MockMetadataValue> collection2Metadata(Collection collection)

Generate a list of metadata elements for the given DSpace collection.

Parameters:

collection - The collection to derive metadata from

Returns:

list of metadata

item2Metadata

protected List<MockMetadataValue> item2Metadata(Item item)

Generate a list of metadata elements for the given DSpace item.

Parameters:

item - The item to derive metadata from

Returns:

list of metadata

createDCValue

protected MockMetadataValue createDCValue(String element,
                              String qualifier,
                              String value)