Package org.dspace.content.crosswalk

Class METSRightsCrosswalk

java.lang.Object

org.dspace.content.crosswalk.METSRightsCrosswalk

All Implemented Interfaces:

DisseminationCrosswalk, IngestionCrosswalk

public class METSRightsCrosswalk
extends Object
implements IngestionCrosswalk, DisseminationCrosswalk

METSRights Ingestion and 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).

Examples of METSRights usage available from: http://www.loc.gov/standards/rights/

This Crosswalk provides a way to export DSpace permissions into a standard format, and then re-import or restore them into a DSpace instance.

Version:

$Revision: 2108 $

Author:

Tim Donohue

Field Summary

Fields

Modifier and Type	Field	Description
protected AuthorizeService	authorizeService
protected EPersonService	ePersonService
protected GroupService	groupService
protected ResourcePolicyService	resourcePolicyService

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

XSI_NS

Constructor Summary

Constructors

Constructor	Description
METSRightsCrosswalk()

Method Summary

Modifier and Type	Method	Description
boolean	canDisseminate(DSpaceObject dso)	Predicate: Can this disseminator crosswalk the given object.
org.jdom.Element	disseminateElement(Context context, DSpaceObject dso)	Actually Disseminate into METSRights schema.
List<org.jdom.Element>	disseminateList(Context context, DSpaceObject dso)	Execute crosswalk, returning List of XML elements.
org.jdom.Namespace[]	getNamespaces()	Get XML namespaces of the elements this crosswalk may return.
String	getSchemaLocation()	Get the XML Schema location(s) of the target metadata format.
void	ingest(Context context, DSpaceObject dso, List<org.jdom.Element> ml, boolean createMissingMetadataFields)	Ingest a List of XML elements
void	ingest(Context context, DSpaceObject dso, org.jdom.Element root, boolean createMissingMetadataFields)	Ingest a whole XML document, starting at specified root.
boolean	preferList()	Predicate: Does this disseminator prefer to return a list of Elements, rather than a single root Element?

Methods inherited from class java.lang.Object

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

Field Detail

authorizeService

protected AuthorizeService authorizeService

ePersonService

protected EPersonService ePersonService

groupService

protected GroupService groupService

resourcePolicyService

protected ResourcePolicyService resourcePolicyService

Constructor Detail

METSRightsCrosswalk

public METSRightsCrosswalk()

Method Detail

getNamespaces

public org.jdom.Namespace[] getNamespaces()

Description copied from interface: DisseminationCrosswalk

Get XML namespaces of the elements this crosswalk may return. Returns the XML namespaces (as JDOM objects) of the root element.

Specified by:

getNamespaces in interface DisseminationCrosswalk

Returns:

array of namespaces, which may be empty.

getSchemaLocation

public String getSchemaLocation()

Description copied from interface: DisseminationCrosswalk

Get the XML Schema location(s) of the target metadata format. Returns the string value of the xsi:schemaLocation attribute that should be applied to the generated XML.

It may return the empty string if no schema is known, but crosswalk authors are strongly encouraged to implement this call so their output XML can be validated correctly.

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.

canDisseminate

public boolean canDisseminate(DSpaceObject dso)

Description copied from interface: DisseminationCrosswalk

Predicate: Can this disseminator crosswalk the given object. Needed by OAI-PMH server implementation.

Specified by:

canDisseminate in interface DisseminationCrosswalk

Parameters:

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

Returns:

true when disseminator is capable of producing metadata.

disseminateElement

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

Actually Disseminate into METSRights schema. This method locates all DSpace policies (permissions) for the provided object, and translates them into METSRights PermissionTypes.

Specified by:

disseminateElement in interface DisseminationCrosswalk

Parameters:

context - context

dso - DSpace Object

Returns:

XML Element corresponding to the new <RightsDeclarationMD> translation

Throws:

CrosswalkException - if crosswalk error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

disseminateList

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

Description copied from interface: DisseminationCrosswalk

Execute crosswalk, returning List of XML elements. Returns a List of JDOM Element objects representing the XML produced by the crosswalk. This is typically called when a list of fields is desired, e.g. for embedding in a METS document xmlData field.

When there are no results, an empty list is returned, but never null.

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:

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

preferList

public boolean preferList()

Description copied from interface: DisseminationCrosswalk

Predicate: Does this disseminator prefer to return a list of Elements, rather than a single root Element?

Some metadata formats have an XML schema without a root element, for example, the Dublin Core and Qualified Dublin Core formats. This would be true for a crosswalk into QDC, since it would "prefer" to return a list, since any root element it has to produce would have to be part of a nonstandard schema. In most cases your implementation will want to return false

Specified by:

preferList in interface DisseminationCrosswalk

Returns:

true when disseminator prefers you call disseminateList().

ingest

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

Ingest a whole XML document, starting at specified root.

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - The relevant DSpace Context.

dso - DSpace object to ingest

root - root element

createMissingMetadataFields - whether to create missing fields

Throws:

CrosswalkException - if crosswalk error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

ingest

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

Ingest a List of XML elements

This method creates new DSpace Policies based on the parsed METSRights XML contents. These Policies assign permissions to DSpace Groups or EPeople.

NOTE: This crosswalk will NOT create missing DSpace Groups or EPeople. Therefore, it is recommended to use this METSRightsCrosswalk in conjunction with another Crosswalk which can create/restore missing Groups or EPeople (e.g. RoleCrosswalk).

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - context

dso - Dspace object

ml - list of elements

createMissingMetadataFields - whether to create missing fields

Throws:

CrosswalkException - if crosswalk error

IOException - if IO error

SQLException - if database error

AuthorizeException - if authorization error

See Also:

RoleCrosswalk