org.dspace.app.xmlui.aspect.artifactbrowser

Class CommunityViewer

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.xml.AbstractXMLPipe

org.apache.cocoon.transformation.AbstractTransformer

org.dspace.app.xmlui.wing.AbstractWingTransformer

org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

org.dspace.app.xmlui.aspect.artifactbrowser.CommunityViewer

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.caching.CacheableProcessingComponent, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.transformation.Transformer, org.apache.cocoon.xml.XMLPipe, org.apache.cocoon.xml.XMLProducer, org.apache.excalibur.xml.sax.XMLConsumer, DSpaceTransformer, WingTransformer, ContentHandler, LexicalHandler

public class CommunityViewer
extends AbstractDSpaceTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

Display a single community. This includes a full text search, browse by list, community display and a list of recent submissions. private static final Logger log = Logger.getLogger(DSpaceFeedGenerator.class);

Author:

Scott Phillips, Kevin Van de Velde (kevin at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected CommunityService	communityService
protected ConfigurationService	configurationService
static Message	T_untitled

Fields inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

context, contextPath, eperson, knot, objectModel, parameters, servletPath, sitemapURI, url

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

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.transformation.Transformer

ROLE

Constructor Summary

Constructors

Constructor and Description
CommunityViewer()

Method Summary

Modifier and Type	Method and Description
void	addBody(Body body) Display a single community (and reference any sub communites or collections)
void	addPageMeta(PageMeta pageMeta) Add the community's title and trail links to the page's metadata
Serializable	getKey() Generate the unique caching key.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.
void	recycle() Recycle
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters parameters) Set the component up, pulling any configuration values from the sitemap parameters.

Methods inherited from class org.dspace.app.xmlui.cocoon.AbstractDSpaceTransformer

addOptions, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException

Methods inherited from class org.dspace.app.xmlui.wing.AbstractWingTransformer

createWingDocument, endDocument, endElement, endPrefixMapping, getDefaultMessageCatalogue, message, message, setupWing, startDocument, startElement, startPrefixMapping

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

characters, comment, endCDATA, endDTD, endEntity, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startCDATA, startDTD, startEntity

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.xml.sax.ContentHandler

characters, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity

Methods inherited from interface org.xml.sax.ext.LexicalHandler

comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity

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

setConsumer

Field Detail

T_untitled

public static final Message T_untitled

communityService

protected CommunityService communityService

configurationService

protected ConfigurationService configurationService

Constructor Detail

CommunityViewer

public CommunityViewer()

Method Detail

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
                  Map objectModel,
                  String src,
                  org.apache.avalon.framework.parameters.Parameters parameters)
           throws org.apache.cocoon.ProcessingException,
                  SAXException,
                  IOException

Set the component up, pulling any configuration values from the sitemap parameters.

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Overrides:

setup in class AbstractDSpaceTransformer

Parameters:

resolver - source resolver.

objectModel - object model.

src - source.

parameters - sitemap parameters.

Throws:

org.apache.cocoon.ProcessingException - passed through.

SAXException - passed through.

IOException - passed through.

getKey

public Serializable getKey()

Generate the unique caching key. This key must be unique inside the space of this component.

Specified by:

getKey in interface org.apache.cocoon.caching.CacheableProcessingComponent

getValidity

public org.apache.excalibur.source.SourceValidity getValidity()

Generate the cache validity object. This validity object includes the community being viewed, all sub-communites (one level deep), all sub-collections, and recently submitted items.

Specified by:

getValidity in interface org.apache.cocoon.caching.CacheableProcessingComponent

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws SAXException,
                        WingException,
                        UIException,
                        SQLException,
                        IOException,
                        AuthorizeException

Add the community's title and trail links to the page's metadata

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Parameters:

pageMeta - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

addBody

public void addBody(Body body)
             throws SAXException,
                    WingException,
                    UIException,
                    SQLException,
                    IOException,
                    AuthorizeException

Display a single community (and reference any sub communites or collections)

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Overrides:

addBody in class AbstractDSpaceTransformer

Parameters:

body - to be added.

Throws:

SAXException - whenever.

WingException - whenever.

UIException - whenever.

SQLException - whenever.

IOException - whenever.

AuthorizeException - whenever.

recycle

public void recycle()

Recycle

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class AbstractDSpaceTransformer