org.dspace.app.xmlui.objectmanager

Class ContainerAdapter

java.lang.Object

org.dspace.app.xmlui.objectmanager.AbstractAdapter

org.dspace.app.xmlui.objectmanager.ContainerAdapter

public class ContainerAdapter
extends AbstractAdapter

This is an adapter which translates DSpace containers (communities and collections) into METS documents. This adapter follows the DSpace METS profile, however that profile does not define how a community or collection should be described, but we make the obvious decisions to deviate when necessary from the profile. The METS document consists of three parts: descriptive metadata section, file section, and a structural map. The descriptive metadata sections holds metadata about the item being adapted using DSpace crosswalks. This is the same way the item adapter works. However, the file section and structural map are a bit different. In these cases the the only files listed is the one logo that may be attached to a community or collection.

Author:

Scott Phillips

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionService	collectionService
protected CommunityService	communityService
protected HandleService	handleService

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

authorizeService, 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
ContainerAdapter(Context context, DSpaceObject dso, String contextPath) Construct a new CommunityCollectionMETSAdapter.

Method Summary

Modifier and Type	Method and Description
DSpaceObject	getContainer() Return the container, community or collection, object
protected String	getFileID(Bitstream bitstream)
protected String	getGroupFileID(Bitstream bitstream)
protected String	getMETSID() Use the handle as the id for this METS document.
protected String	getMETSLabel()
protected String	getMETSOBJEDIT()
protected String	getMETSOBJID()
protected String	getMETSProfile() Return the profile to use for communities and collections.
boolean	isAuthorized() Check if the current user is allowed to read the contents of the adapter.
protected void	renderDescriptiveSection() Render the METS descriptive section.
protected void	renderFileSection(Context context) Render the METS file section.
protected void	renderStructureMap() Render the container's structural map.

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

endElement, getDisseminationCrosswalk, getGenericID, isDefinedMETStype, renderAdministrativeSection, renderBehavioralSection, renderExtraSections, 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

communityService

protected CommunityService communityService

collectionService

protected CollectionService collectionService

handleService

protected HandleService handleService

Constructor Detail

ContainerAdapter

public ContainerAdapter(Context context,
                        DSpaceObject dso,
                        String contextPath)

Construct a new CommunityCollectionMETSAdapter.

Parameters:

context - session context.

dso - A DSpace Community or Collection to adapt.

contextPath - The contextPath of this webapplication.

Method Detail

getContainer

public DSpaceObject getContainer()

Return the container, community or collection, object

Returns:

the contained object.

getMETSOBJID

protected String getMETSOBJID()

Specified by:

getMETSOBJID in class AbstractAdapter

Returns:

the URL of this community/collection in the interface.

getMETSOBJEDIT

protected String getMETSOBJEDIT()

Specified by:

getMETSOBJEDIT in class AbstractAdapter

Returns:

Return the URL for editing this item

getMETSID

protected String getMETSID()

Use the handle as the id for this METS document.

Specified by:

getMETSID in class AbstractAdapter

Returns:

the id.

getMETSProfile

protected String getMETSProfile()
                         throws WingException

Return the profile to use for communities and collections.

Specified by:

getMETSProfile in class AbstractAdapter

Returns:

the constant profile name.

Throws:

WingException - never.

getMETSLabel

protected String getMETSLabel()

Specified by:

getMETSLabel in class AbstractAdapter

Returns:

a friendly label for the METS document to say we are a community or collection.

getFileID

protected String getFileID(Bitstream bitstream)

Parameters:

bitstream - the bitstream to be identified.

Returns:

a unique id for the given bitstream.

getGroupFileID

protected String getGroupFileID(Bitstream bitstream)

Parameters:

bitstream - the bitstream to be queried.

Returns:

a group id for the given 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.

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 - if items could not be counted.

SQLException - passed through.

renderFileSection

protected void renderFileSection(Context context)
                          throws SAXException,
                                 SQLException

Render the METS file section. If a logo is present for this container then that single bitstream is listed in the file section.

Example:

 <fileSec>
   <fileGrp USE="LOGO">
     <file ... >
       <fLocate ... >
     </file>
   </fileGrp>
 </fileSec>
 

Overrides:

renderFileSection in class AbstractAdapter

Parameters:

context - session context.

Throws:

SAXException - passed through.

SQLException - passed through.

renderStructureMap

protected void renderStructureMap()
                           throws SQLException,
                                  SAXException

Render the container's structural map. This includes a reference to the container's logo, if available, otherwise it is an empty division that just states it is a DSpace community or Collection.

Example:

 <structMap TYPE="LOGICAL" LABEL="DSpace">
   <div TYPE="DSpace Collection" DMDID="space-separated list of ids">
     <fptr FILEID="logo id"/>
   </div>
 </structMap>
 

Overrides:

renderStructureMap in class AbstractAdapter

Throws:

SQLException - passed through.

SAXException - passed through.

isAuthorized

public boolean isAuthorized()
                     throws SQLException

Description copied from class: AbstractAdapter

Check if the current user is allowed to read the contents of the adapter.

Specified by:

isAuthorized in class AbstractAdapter

Returns:

True if the user has sufficient permissions

Throws:

SQLException - passed through.