Package org.dspace.content.crosswalk

Class RoleCrosswalk

java.lang.Object

org.dspace.content.crosswalk.AbstractPackagerWrappingCrosswalk

org.dspace.content.crosswalk.RoleCrosswalk

All Implemented Interfaces:

DisseminationCrosswalk, IngestionCrosswalk

public class RoleCrosswalk
extends AbstractPackagerWrappingCrosswalk
implements IngestionCrosswalk, DisseminationCrosswalk

Role Crosswalk

Translate between DSpace Group and EPeople definitions and a DSpace-specific XML export format (generated by the RoleDisseminator). This is primarily used for AIPs, but may be used by other Packagers as necessary.

This crosswalk allows you to export DSpace Groups and EPeople to this XML structured format. It also allows you to import an XML file of this format in order to restore DSpace Groups and EPeople defined within it.

This is just wrappers; the real work is done in RoleDisseminator and RoleIngester.

Author:

mwood, Tim Donohue

See Also:

RoleDisseminator, RoleIngester, AbstractPackagerWrappingCrosswalk, IngestionCrosswalk, DisseminationCrosswalk

Field Summary

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

XSI_NS

Constructor Summary

Constructors

Constructor	Description
RoleCrosswalk()

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)	Execute crosswalk, returning one XML root element as a JDOM Element object.
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> metadata, 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 org.dspace.content.crosswalk.AbstractPackagerWrappingCrosswalk

getIngestionLicense, getPackagingParameters, setIngestionLicense, setPackagingParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleCrosswalk

public RoleCrosswalk()

Method Detail

getNamespaces

public org.jdom.Namespace[] getNamespaces()

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()

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)

Predicate: Can this disseminator crosswalk the given object.

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()

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

Specified by:

preferList in interface DisseminationCrosswalk

Returns:

true when disseminator prefers you call disseminateList().

disseminateList

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

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.

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

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

CrosswalkException

disseminateElement

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

Execute crosswalk, returning one XML root element as a JDOM Element object. This is typically the root element of a document.

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:

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.

CrosswalkInternalException - (CrosswalkException) failure of the crosswalk itself.

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

CrosswalkException

ingest

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

Ingest a List of XML elements

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - context

dso - DSpaceObject

metadata - list of metadata

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,
                   org.jdom.Element root,
                   boolean createMissingMetadataFields)
            throws CrosswalkException,
                   IOException,
                   SQLException,
                   AuthorizeException

Ingest a whole XML document, starting at specified root.

This essentially just wraps a call to the configured Role PackageIngester.

Specified by:

ingest in interface IngestionCrosswalk

Parameters:

context - context

dso - DSpaceObject

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