org.dspace.app.xmlui.aspect.discovery
Class SidebarFacetsTransformer

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.SidebarFacetsTransformer

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 SidebarFacetsTransformer
extends AbstractDSpaceTransformer
implements org.apache.cocoon.caching.CacheableProcessingComponent

Renders the side bar filters in discovery

Author:

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

protected DiscoverQuery	queryArgs Cached query arguments
protected DiscoverResult	queryResults Cached query results
protected org.apache.excalibur.source.SourceValidity	validity Cached validity object

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

SidebarFacetsTransformer()

Method Summary

void	addOptions(Options options)
protected String[]	getAllFilterQueries() Returns all the filter queries for use by discovery This method returns more expanded filter queries then the getParameterFilterQueries
Serializable	getKey() Generate the unique caching key.
DiscoverQuery	getQueryArgs(Context context, DSpaceObject scope, String... filterQueries)
protected SearchService	getSearchService()
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.
void	performSearch()
void	recycle()

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

addBody, 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

queryArgs

protected DiscoverQuery queryArgs

Cached query arguments

validity

protected org.apache.excalibur.source.SourceValidity validity

Cached validity object

Constructor Detail

SidebarFacetsTransformer

public SidebarFacetsTransformer()

Method Detail

getSearchService

protected SearchService getSearchService()

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 will include the collection being viewed and all recently submitted items. This does not include the community / collection hierarch, when this changes they will not be reflected in the cache.

Specified by:

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

performSearch

public void performSearch()
                   throws SearchServiceException,
                          UIException,
                          SQLException

Throws:

SearchServiceException

UIException

SQLException

addOptions

public void addOptions(Options options)
                throws SAXException,
                       WingException,
                       SQLException,
                       IOException,
                       AuthorizeException

Specified by:

addOptions in interface DSpaceTransformer

Specified by:

addOptions in interface WingTransformer

Overrides:

addOptions in class AbstractDSpaceTransformer

Throws:

SAXException

WingException

SQLException

IOException

AuthorizeException

getQueryArgs

public DiscoverQuery getQueryArgs(Context context,
                                  DSpaceObject scope,
                                  String... filterQueries)

getAllFilterQueries

protected String[] getAllFilterQueries()

Returns all the filter queries for use by discovery This method returns more expanded filter queries then the getParameterFilterQueries

Returns:

an array containing the filter queries

recycle

public void recycle()

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer