Package org.dspace.content.crosswalk

Interface StreamDisseminationCrosswalk

All Known Implementing Classes:

CreativeCommonsRDFStreamDisseminationCrosswalk, CreativeCommonsTextStreamDisseminationCrosswalk, LicenseStreamDisseminationCrosswalk, SubscriptionDsoMetadataForEmailCompose

public interface StreamDisseminationCrosswalk

A class implementing this interface crosswalk metadata directly from a DSpace Object to an output stream, in a specific format.

Stream-oriented crosswalks are intended to be used for metadata formats which are either (a) not XML-based, or (b) too bulky for the DOM-ish in-memory model developed for the METS and IMSCP packagers. The METS packagers (all subclasses of AbstractMETSDisseminator / AbstractMETSIngester are equipped to call these crosswalks as well as the XML-based ones, just refer to the desired crosswalk by its plugin name.

Version:

$Revision$

Author:

Larry Stone

Method Summary

Modifier and Type	Method	Description
boolean	canDisseminate(Context context, DSpaceObject dso)	Predicate: Can this disseminator crosswalk the given object.
void	disseminate(Context context, DSpaceObject dso, OutputStream out)	Execute crosswalk on the given object, sending output to the stream.
String	getMIMEType()

Method Detail

canDisseminate

boolean canDisseminate(Context context,
                       DSpaceObject dso)

Predicate: Can this disseminator crosswalk the given object.

Parameters:

context - context

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

Returns:

true when disseminator is capable of producing metadata.

disseminate

void disseminate(Context context,
                 DSpaceObject dso,
                 OutputStream out)
          throws CrosswalkException,
                 IOException,
                 SQLException,
                 AuthorizeException

Execute crosswalk on the given object, sending output to the stream.

Parameters:

context - the DSpace context

dso - the DSpace Object whose metadata to export.

out - output stream to write to

Throws:

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

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

IOException - I/O failure in services this calls

SQLException - Database failure in services this calls

AuthorizeException - current user not authorized for this operation.

CrosswalkException

getMIMEType

String getMIMEType()