org.dspace.app.xmlui.aspect.discovery

Class AbstractRecentSubmissionTransformer

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.discovery.AbstractRecentSubmissionTransformer

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

Direct Known Subclasses:

CollectionRecentSubmissions, CommunityRecentSubmissions, SiteRecentSubmissions

public abstract class AbstractRecentSubmissionTransformer
extends AbstractDSpaceTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

An abstract class containing the shared methods which all recent submission transformers use

Author:

Kevin Van de Velde (kevin at atmire dot com)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxRecentSubmissions The maximum number of recent submissions read from configuration.
protected DiscoverResult	queryResults Cached query results

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addViewMoreLink(Division recentSubmissionDiv, DSpaceObject dso) Add a view more link at the bottom of a recent submission view
Serializable	getKey() Generate the unique caching key.
protected void	getRecentlySubmittedItems(DSpaceObject dso) Retrieves the recent submitted items of the given scope
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.
void	recycle() Recyle

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

addBody, addOptions, addPageMeta, addUserMeta, decodeFromURL, dispose, encodeForURL, generateURL, getComponentName, getObjectManager, handleException, setup

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

queryResults

protected DiscoverResult queryResults

Cached query results

maxRecentSubmissions

protected int maxRecentSubmissions

The maximum number of recent submissions read from configuration.

Constructor Detail

AbstractRecentSubmissionTransformer

public AbstractRecentSubmissionTransformer()

Method Detail

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. The validity object all recently submitted items. This does not include the community / collection hierarchy, when this changes they will not be reflected in the cache.

Specified by:

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

getRecentlySubmittedItems

protected void getRecentlySubmittedItems(DSpaceObject dso)

Retrieves the recent submitted items of the given scope

Parameters:

dso - the DSpace object can either be null (indicating home page), a collection or a community

addViewMoreLink

protected void addViewMoreLink(Division recentSubmissionDiv,
                   DSpaceObject dso)
                        throws WingException

Add a view more link at the bottom of a recent submission view

Parameters:

recentSubmissionDiv - recent submission div to which we are to add the link

dso - the site/community/collection on who's home page we are

Throws:

WingException - ...

recycle

public void recycle()

Description copied from class: AbstractDSpaceTransformer

Recyle

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer