org.dspace.app.xmlui.objectmanager

Class ItemAdapter

java.lang.Object

org.dspace.app.xmlui.objectmanager.AbstractAdapter

org.dspace.app.xmlui.objectmanager.ItemAdapter

public class ItemAdapter
extends AbstractAdapter

This is an adapter which translates a DSpace item into a METS document following the DSpace METS profile, err well mostly. At least if you use the proper configuration it will be fully compliant with the profile, however this adapter will allow you to configure it to be incorrect.

When we are configured to be non-compliant with the profile, the MET's profile is changed to reflect the deviation. The DSpace profile states that metadata should be given in MODS format. However, you can configure this adapter to use any metadata crosswalk. When that case is detected we change the profile to say that we are deviating from the standard profile and it lists what metadata has been added.

There are four parts to an item's METS document: descriptive metadata, file section, structural map, and extra sections.

Request item-support

Original Concept, JSPUI version: Universidade do Minho at www.uminho.pt

Sponsorship of XMLUI version: Instituto Oceanográfico de España at www.ieo.es

Author:

Scott Phillips, Adán Román Ruiz at arvo.es (for request item support)

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeService	authorizeService
protected BitstreamService	bitstreamService
protected BundleService	bundleService
protected ItemService	itemService
protected MetadataExposureService	metadataExposureService

Fields inherited from class org.dspace.app.xmlui.objectmanager.AbstractAdapter

contentHandler, contextPath, DIM, DIM_URI, lexicalHandler, METS, METS_DEFINED_TYPES, METS_URI, namespaces, XLINK, XLINK_URI, XSI, XSI_URI

Constructor Summary

Constructors

Constructor and Description
ItemAdapter(Context context, Item item, String contextPath) Construct a new ItemAdapter

Method Summary

Modifier and Type	Method and Description
protected List<Bundle>	findEnabledBundles() Checks which Bundles of current item a user has requested.
protected static Bitstream	findOriginalBitstream(Item item, Bitstream derived) For a bitstream that's a thumbnail or extracted text, find the corresponding bitstream it was derived from, in the ORIGINAL bundle.
protected String	getAmdSecID(String admSecName, String mdType, DSpaceObject dso)
protected String	getFileID(Bitstream bitstream)
protected String	getGroupFileID(Bitstream bitstream)
Item	getItem()
protected String	getMETSID()
protected String	getMETSLabel()
protected String	getMETSOBJEDIT()
protected String	getMETSOBJID()
protected String	getMETSProfile()
protected void	renderAdministrativeSection() Render the METS administrative section.
protected void	renderAmdSubSection(String amdSecName, String mdType, DisseminationCrosswalk crosswalk, DSpaceObject dso) Render a sub-section of the administrative metadata section.
protected void	renderDescriptiveSection() Render the METS descriptive section.
protected void	renderExtraSections() Render any extra METS section.
protected void	renderFileSection(Context context) Render the METS file section.
protected void	renderFileWithAllowed(Item item, Bitstream bitstream, String fileID, String groupID, String admID) Generate a METS file element for a given bitstream.
protected void	renderStructureMap() Render the item's structural map.

Methods inherited from class org.dspace.app.xmlui.objectmanager.AbstractAdapter

endElement, getDisseminationCrosswalk, getGenericID, isDefinedMETStype, renderBehavioralSection, renderFile, renderFile, renderHeader, renderMETS, renderStructuralLink, sendCharacters, setAmdTypes, setDigiProvMDTypes, setDmdTypes, setFileGrpTypes, setRightsMDTypes, setSections, setSourceMDTypes, setStructTypes, setTechMDTypes, startElement

Methods inherited from class java.lang.Object

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

Field Detail

authorizeService

protected AuthorizeService authorizeService

itemService

protected ItemService itemService

bundleService

protected BundleService bundleService

bitstreamService

protected BitstreamService bitstreamService

metadataExposureService

protected MetadataExposureService metadataExposureService

Constructor Detail

ItemAdapter

public ItemAdapter(Context context,
                   Item item,
                   String contextPath)

Construct a new ItemAdapter

Parameters:

context - Session context.

item - The DSpace item to adapt.

contextPath - The context path for this web application.

Method Detail

getItem

public Item getItem()

Returns:

the item.

getMETSOBJID

protected String getMETSOBJID()

Specified by:

getMETSOBJID in class AbstractAdapter

Returns:

the URL of this item in the interface.

getMETSOBJEDIT

protected String getMETSOBJEDIT()

Specified by:

getMETSOBJEDIT in class AbstractAdapter

Returns:

the URL for editing this item

getMETSID

protected String getMETSID()

Specified by:

getMETSID in class AbstractAdapter

Returns:

the item's handle as the METS ID

getMETSProfile

protected String getMETSProfile()
                         throws WingException

Specified by:

getMETSProfile in class AbstractAdapter

Returns:

the official METS SIP Profile.

Throws:

WingException - never.

getMETSLabel

protected String getMETSLabel()

Specified by:

getMETSLabel in class AbstractAdapter

Returns:

a helpful label that this is a DSpace Item.

getFileID

protected String getFileID(Bitstream bitstream)

Parameters:

bitstream - a Bitstream.

Returns:

a unique id for a bitstream.

getGroupFileID

protected String getGroupFileID(Bitstream bitstream)

Parameters:

bitstream - a Bitstream.

Returns:

a group id for a bitstream.

getAmdSecID

protected String getAmdSecID(String admSecName,
                             String mdType,
                             DSpaceObject dso)

Parameters:

admSecName - section.

mdType - type.

dso - object.

Returns:

a techMD id for a bitstream.

renderDescriptiveSection

protected void renderDescriptiveSection()
                                 throws WingException,
                                        SAXException,
                                        CrosswalkException,
                                        IOException,
                                        SQLException

Render the METS descriptive section. This will create a new metadata section for each crosswalk configured. Furthermore, a special check has been added that will add MODS descriptive metadata if it is available in DSpace.

Example:

 <dmdSec>
  <mdWrap MDTYPE="MODS">
    <xmlData>
      ... content from the crosswalk ...
    </xmlDate>
  </mdWrap>
 </dmdSec
 

Overrides:

renderDescriptiveSection in class AbstractAdapter

Throws:

WingException - on XML errors.

SAXException - passed through.

CrosswalkException - passed through.

IOException - passed through.

SQLException - passed through.

renderAdministrativeSection

protected void renderAdministrativeSection()
                                    throws WingException,
                                           SAXException,
                                           CrosswalkException,
                                           IOException,
                                           SQLException

Render the METS administrative section.

Example:

 <amdSec>
  <mdWrap MDTYPE="OTHER" OTHERMDTYPE="METSRights">
    <xmlData>
      ... content from the crosswalk ...
    </xmlDate>
  </mdWrap>
 </amdSec>
 

Overrides:

renderAdministrativeSection in class AbstractAdapter

Throws:

WingException - passed through.

SAXException - passed through.

CrosswalkException - passed through.

IOException - passed through.

SQLException - passed through.

renderAmdSubSection

protected void renderAmdSubSection(String amdSecName,
                                   String mdType,
                                   DisseminationCrosswalk crosswalk,
                                   DSpaceObject dso)
                            throws WingException,
                                   SAXException,
                                   CrosswalkException,
                                   IOException,
                                   SQLException

Render a sub-section of the administrative metadata section. Valid sub-sections include: techMD, rightsMD, sourceMD, digiprovMD

Example:

 <techMD>
   <mdWrap MDTYPE="PREMIS">
     <xmlData>
       [PREMIS content ... ]
     </xmlData>
   </mdWrap>
 </techMD>
 

Parameters:

amdSecName - Name of administrative metadata section

mdType - Type of metadata section (e.g. PREMIS)

crosswalk - The DisseminationCrosswalk to use to generate this section

dso - The current DSpace object to use the crosswalk on

Throws:

WingException - on XML errors.

SAXException - passed through.

CrosswalkException - passed through.

IOException - passed through.

SQLException - passed through.

renderFileSection

protected void renderFileSection(Context context)
                          throws SQLException,
                                 SAXException

Render the METS file section. This will contain a list of all bitstreams in the item. Each bundle, even those that are not typically displayed will be listed.

Example:

 <fileSec>
   <fileGrp USE="CONTENT">
     <file ... >
       <fLocate ... >
     </file>
   </fileGrp>
   <fileGrp USE="TEXT">
     <file ... >
       <fLocate ... >
     </file>
   </fileGrp>
 </fileSec>
 

Overrides:

renderFileSection in class AbstractAdapter

Parameters:

context - session context.

Throws:

SQLException - passed through.

SAXException - passed through.

renderStructureMap

protected void renderStructureMap()
                           throws SQLException,
                                  SAXException

Render the item's structural map. This includes a list of content bitstreams, those are bitstreams that are typically viewable by the end user.

Example:

 <structMap TYPE="LOGICAL" LABEL="DSpace">
   <div TYPE="DSpace Item" DMDID="space-separated list of ids">
     <fptr FILEID="primary bitstream"/>
     ... a div for each content bitstream.
   </div>
 </structMap>
 

Overrides:

renderStructureMap in class AbstractAdapter

Throws:

SQLException - passed through.

SAXException - passed through.

renderExtraSections

protected void renderExtraSections()
                            throws SAXException,
                                   SQLException,
                                   IOException

Render any extra METS section. If the item contains a METS.xml document then all of that document's sections are included in this document's METS document.

Overrides:

renderExtraSections in class AbstractAdapter

Throws:

SAXException - passed through.

SQLException - passed through.

IOException - passed through.

findEnabledBundles

protected List<Bundle> findEnabledBundles()
                                   throws SQLException

Checks which Bundles of current item a user has requested. If none specifically requested, then all Bundles are returned.

Returns:

List of enabled bundles

Throws:

SQLException - passed through.

findOriginalBitstream

protected static Bitstream findOriginalBitstream(Item item,
                                                 Bitstream derived)
                                          throws SQLException

For a bitstream that's a thumbnail or extracted text, find the corresponding bitstream it was derived from, in the ORIGINAL bundle.

Parameters:

item - the item we're dealing with

derived - the derived bitstream

Returns:

the corresponding original bitstream (or null)

Throws:

SQLException - passed through.

renderFileWithAllowed

protected void renderFileWithAllowed(Item item,
                                     Bitstream bitstream,
                                     String fileID,
                                     String groupID,
                                     String admID)
                              throws SAXException,
                                     SQLException

Generate a METS file element for a given bitstream.

Parameters:

item - If the bitstream is associated with an item provide the item otherwise leave null.

bitstream - The bitstream to build a file element for.

fileID - The unique file id for this file.

groupID - The group id for this file, if it is derived from another file then they should share the same groupID.

admID - The IDs of the administrative metadata sections which pertain to this file

Throws:

SAXException - passed through.

SQLException - passed through.