Package org.dspace.content.crosswalk

Provides an API and implementations of metadata crosswalks, which are directional mappings from one schema to another, performed in the context of Item ingestion or dissemination.

See: Description

Interface Summary

Interface	Description
DisseminationCrosswalk	Dissemination Crosswalk plugin -- translate DSpace native metadata into an external XML format.
IConverter
IngestionCrosswalk	Ingestion Crosswalk plugin -- translate an external metadata format into DSpace native metadata.
StreamDisseminationCrosswalk	A class implementing this interface crosswalk metadata directly from a DSpace Object to an output stream, in a specific format.
StreamIngestionCrosswalk	A class implementing this interface can crosswalk metadata directly from a stream (assumed to be in a specific format) to the object.

Class Summary

Class	Description
AbstractPackagerWrappingCrosswalk	Packager Wrapping Crosswalk plugin A Packager Wrapping Crosswalk is a crosswalk which works with or wraps an existing Packager for all or some of its crosswalking functionality.
AIPDIMCrosswalk	Crosswalk descriptive metadata to and from DIM (DSpace Intermediate Metadata) format, strictly for the purpose of including a precise and complete record of the DMD in an AIP.
AIPTechMDCrosswalk	Crosswalk of technical metadata for DSpace AIP.
CreativeCommonsRDFStreamDisseminationCrosswalk	Export the item's Creative Commons license, RDF form.
CreativeCommonsRDFStreamIngestionCrosswalk	Ingest a Creative Commons license, RDF form.
CreativeCommonsTextStreamDisseminationCrosswalk	Export the object's Creative Commons license, text form.
DIMDisseminationCrosswalk	DIM dissemination crosswalk Produces the metadata encoded in DSpace Intermediate Format, without the overhead of XSLT processing.
DIMIngestionCrosswalk	DIM ingestion crosswalk Processes metadata encoded in DSpace Intermediate Format, without the overhead of XSLT processing.
LicenseStreamDisseminationCrosswalk	Export the object's DSpace deposit license.
LicenseStreamIngestionCrosswalk	Accept a DSpace deposit license.
METSDisseminationCrosswalk	METS dissemination crosswalk Produces a METS manifest for the DSpace item as a metadata description -- intended to work within an application like the OAI-PMH server.
METSRightsCrosswalk	METSRights Ingestion & Dissemination Crosswalk Translate between DSpace internal policies (i.e. permissions) and the METSRights metadata schema (see http://www.loc.gov/standards/rights/METSRights.xsd for details).
MODSDisseminationCrosswalk	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/.)
NullIngestionCrosswalk	"Null" ingestion crosswalk Use this crosswalk to ignore a metadata record on ingest.
NullStreamIngestionCrosswalk	A crosswalk to ignore and dispose of the ingested material.
OAIDCIngestionCrosswalk	DIM ingestion crosswalk Processes Dublic Core metadata encased in an oai_dc:dc wrapper
OREDisseminationCrosswalk	ORE dissemination crosswalk Produces an Atom-encoded ORE aggregation of a DSpace item.
OREIngestionCrosswalk	ORE ingestion crosswalk Processes an Atom-encoded ORE resource map and attemps to interpret it as a DSpace item
PREMISCrosswalk	PREMIS Crosswalk Translate between DSpace Bitstream properties and PREMIS metadata format (see http://www.oclc.org/research/projects/pmwg/ for details).
QDCCrosswalk	Configurable QDC Crosswalk This class supports multiple dissemination crosswalks from DSpace internal data to the Qualified Dublin Core XML format (see http://dublincore.org/ It registers multiple Plugin names, which it reads from the DSpace configuration as follows: Configuration Every key starting with "crosswalk.qdc.properties."
RoleCrosswalk	Role Crosswalk Translate between DSpace Group & EPeople definitions and a DSpace-specific XML export format (generated by the RoleDisseminator).
SimpleDCDisseminationCrosswalk	Disseminator for Simple Dublin Core metadata in XML format.
XHTMLHeadDisseminationCrosswalk	Crosswalk for creating appropriate <meta> elements to appear in the item display page for a particular item, for improving automated processing of the page (e.g. by search engines).
XSLTCrosswalk	Configurable XSLT-driven Crosswalk This is the superclass of the XSLT dissemination and submission crosswalks.
XSLTDisseminationCrosswalk	Configurable XSLT-driven dissemination Crosswalk See the XSLTCrosswalk superclass for details on configuration.
XSLTIngestionCrosswalk	Configurable XSLT-driven ingestion Crosswalk See the XSLTCrosswalk superclass for details on configuration.

Exception Summary

Exception	Description
CrosswalkException	Superclass for more-specific crosswalk exceptions.
CrosswalkInternalException	Something went wrong inside the crosswalk, not necessarily caused by the input or state (although it could be an incorrectly handled pathological case).
CrosswalkObjectNotSupported	Something went wrong inside the crosswalk, not necessarily caused by the input or state (although it could be an incorrectly handled pathological case).
MetadataValidationException	This indicates a problem with the input metadata (for submission) or item state (dissemination).

Package org.dspace.content.crosswalk Description

Provides an API and implementations of metadata crosswalks, which are directional mappings from one schema to another, performed in the context of Item ingestion or dissemination. Most crosswalks are driven by a mapping in a file, which reside in config/crosswalks.

Crosswalk Interfaces

The principle interfaces are for ingest and dissemination contexts, i.e. the IngestionCrosswalk interface consists of the methods:

public void ingest(Context context, DSpaceObject dso, List metadata)
public void ingest(Context context, DSpaceObject dso, Element root)

The DisseminationCrosswalk interface has methods:

public Namespace[] getNamespaces()
public String getSchemaLocation()
public boolean canDisseminate(DSpaceObject dso)
public List disseminateList(DSpaceObject dso)
public Element disseminateElement(DSpaceObject dso)

Crosswalk Implementations

Crosswalks exist for many formats, includings DC, QDC, METs, MODs, Premis, and a general implementation employing an XSLT stylesheet.