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

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

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, 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:

AbstractSearch, CollectionRecentSubmissions, CommunityRecentSubmissions, ItemFacets, RelatedItems, SiteRecentSubmissions

public abstract class AbstractFiltersTransformer
extends AbstractDSpaceTransformer

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 org.apache.solr.client.solrj.SolrQuery	queryArgs Cached query arguments
protected org.apache.solr.client.solrj.response.QueryResponse	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

AbstractFiltersTransformer()

Method Summary

void	addOptions(Options options)
Serializable	getKey() Generate the unique caching key.
protected DSpaceObject	getScope() Determine the current scope.
protected SearchService	getSearchService()
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.
abstract String	getView()
abstract void	performSearch(DSpaceObject object)
protected org.apache.solr.client.solrj.SolrQuery	prepareDefaultFilters(String scope, String... filterQueries)
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 org.apache.solr.client.solrj.response.QueryResponse queryResults

Cached query results

queryArgs

protected org.apache.solr.client.solrj.SolrQuery queryArgs

Cached query arguments

validity

protected org.apache.excalibur.source.SourceValidity validity

Cached validity object

Constructor Detail

AbstractFiltersTransformer

public AbstractFiltersTransformer()

Method Detail

getView

public abstract String getView()

getSearchService

protected SearchService getSearchService()

getKey

public Serializable getKey()

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

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.

performSearch

public abstract void performSearch(DSpaceObject object)
                            throws SearchServiceException,
                                   UIException

Throws:

SearchServiceException

UIException

getScope

protected DSpaceObject getScope()
                         throws SQLException

Determine the current scope. This may be derived from the current url handle if present or the scope parameter is given. If no scope is specified then null is returned.

Returns:

The current scope.

Throws:

SQLException

prepareDefaultFilters

protected org.apache.solr.client.solrj.SolrQuery prepareDefaultFilters(String scope,
                                                                       String... filterQueries)

addOptions

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

Specified by:

addOptions in interface DSpaceTransformer

Specified by:

addOptions in interface WingTransformer

Overrides:

addOptions in class AbstractDSpaceTransformer

Throws:

SAXException

WingException

UIException

SQLException

IOException

AuthorizeException

recycle

public void recycle()

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer