org.dspace.app.xmlui.cocoon

Class DSpaceMETSGenerator

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.dspace.app.xmlui.cocoon.DSpaceMETSGenerator

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.generation.Generator, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.xml.XMLProducer

public class DSpaceMETSGenerator
extends org.apache.cocoon.generation.AbstractGenerator

Generate a METS document for the identified item, community or collection. The object to be rendered should be identified by passing in one of the two parameters: handle or internal. If an internal ID is given then it must be of the form "type:id" i.g. item:255 or community:4 or repository:123456789. In the case of a repository the id must be the handle prefix. In addition to rendering a METS document there are several options which can be specified for how the mets document should be rendered. All parameters are a comma-separated list of values, here is a list: sections: A comma-separated list of METS sections to included. The possible values are: "metsHdr", "dmdSec", "amdSec", "fileSec", "structMap", "structLink", "behaviorSec", and "extraSec". If no list is provided then *ALL* sections are rendered. dmdTypes: A comma-separated list of metadata formats to provide as descriptive metadata. The list of available metadata types is defined in the dspace.cfg, dissemination crosswalks. If no formats are provided them DIM - DSpace Intermediate Format - is used. amdTypes: A comma-separated list of metadata formats to provide administrative metadata. DSpace does not currently support this type of metadata. fileGrpTypes: A comma-separated list of file groups to render. For DSpace a bundle is translated into a METS fileGrp, so possible values are "THUMBNAIL","CONTENT", "METADATA", etc... If no list is provided then all groups are rendered. structTypes: A comma-separated list of structure types to render. For DSpace there is only one structType: LOGICAL. If this is provided then the logical structType will be rendered, otherwise none will. The default operation is to render all structure types.

Author:

Scott Phillips

Field Summary

Fields

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

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor and Description
DSpaceMETSGenerator()

Method Summary

Methods

Modifier and Type	Method and Description
void	configureAdapter(AbstractAdapter adapter) Configure the adapter according to the supplied parameters.
void	generate() Generate the METS Document.

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Detail

handleService

protected HandleService handleService

communityService

protected CommunityService communityService

collectionService

protected CollectionService collectionService

itemService

protected ItemService itemService

Constructor Detail

DSpaceMETSGenerator

public DSpaceMETSGenerator()

Method Detail

generate

public void generate()
              throws IOException,
                     SAXException,
                     org.apache.cocoon.ProcessingException

Generate the METS Document.

Throws:

IOException - passed through.

SAXException - passed through.

org.apache.cocoon.ProcessingException - on error.

configureAdapter

public void configureAdapter(AbstractAdapter adapter)

Configure the adapter according to the supplied parameters.

Parameters:

adapter - the adapter.