org.dspace.app.xmlui.aspect.discovery

Class AbstractSearch

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

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:

SimpleSearch

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

This is an abstract search page. It is a collection of search methods that are common between different search implementation. An implementer must implement at least three methods: addBody(), getQuery(), and generateURL().

See the SimpleSearch implementation.

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

Fields

Modifier and Type	Field and Description
protected CollectionService	collectionService
protected CommunityService	communityService
protected HandleService	handleService
protected ItemService	itemService
protected MetadataExposureService	metadataExposureService
protected MetadataFieldService	metadataFieldService
protected DiscoverQuery	queryArgs Cached query arguments
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
AbstractSearch()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addBody(Body body) Build the resulting search DRI document.
protected String	addFilterQueriesToUrl(String pageURLMask)
protected void	addMetadataField(DiscoverResult.DSpaceObjectHighlightResult highlightedResults, String metadataKey, List metadataFieldList, String value) Add the current value to the wing list
protected void	addMetadataField(List metadataFieldList, String value) Add our metadata value.
protected void	buildMainForm(Division searchDiv) Build the main form that should be the only form that the user interface requires This form will be used for all discovery queries, filters, ....
protected void	buildScopeList(Select scope) Add options to the search scope field.
protected void	buildSearchControls(Division div)
protected void	buildSearchResultsDivision(Division search) Attach a division to the given search division named "search-results" which contains results for this search query.
protected abstract String	generateURL(Map<String,String> parameters) Generate a URL to the given search implementation with the associated parameters included.
protected abstract String	getBasicUrl()
protected String[]	getFacetsList()
protected String[]	getFilterQueries() Returns all the filter queries for use by solr This method returns more expanded filter queries then the getParameterFilterQueries
Serializable	getKey() Generate the unique caching key.
protected int	getParameterEtAl()
protected Map<String,String[]>	getParameterFilterQueries() Returns a list of the filter queries for use in rendering pages, creating page more urls, ....
protected String	getParameterGroup()
protected String	getParameterOrder()
protected int	getParameterPage()
protected int	getParameterRpp()
protected String	getParameterScope()
protected String	getParameterSortBy()
protected abstract String	getQuery() Extract the query string.
protected DSpaceObject	getScope() Determine the current scope.
org.apache.excalibur.source.SourceValidity	getValidity() Generate the cache validity object.
protected void	logSearch()
void	performSearch(DSpaceObject scope) Query DSpace for a list of all items / collections / or communities that match the given search query.
DiscoverQuery	prepareQuery(DSpaceObject scope, String query, String[] fqs) Prepare DiscoverQuery given the current scope and query string
void	recycle() Recycle.
protected void	renderCollection(Collection collection, DiscoverResult.DSpaceObjectHighlightResult highlightedResults, List collectionMetadata) Render the given collection, all collection metadata is added to the list
protected void	renderCommunity(Community community, DiscoverResult.DSpaceObjectHighlightResult highlightedResults, List communityMetadata) Render the given collection, all collection metadata is added to the list
protected void	renderItem(List dspaceObjectsList, Item item, DiscoverResult.DSpaceObjectHighlightResult highlightedResults) Render the given item, all metadata is added to the given list, which metadata will be rendered where depends on the xsl
protected boolean	variableScope() Determine if the scope of the search should fixed or is changeable by the user.

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

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

queryArgs

protected DiscoverQuery queryArgs

Cached query arguments

communityService

protected CommunityService communityService

collectionService

protected CollectionService collectionService

itemService

protected ItemService itemService

metadataFieldService

protected MetadataFieldService metadataFieldService

metadataExposureService

protected MetadataExposureService metadataExposureService

handleService

protected HandleService handleService

Constructor Detail

AbstractSearch

public AbstractSearch()

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

Returns:

the key.

getValidity

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

Generate the cache validity object.

This validity object should never "over cache" because it will perform the search, and serialize the results using the DSpaceValidity object.

Specified by:

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

Returns:

the validity.

addBody

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

Build the resulting search DRI document.

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.

buildMainForm

protected void buildMainForm(Division searchDiv)
                      throws WingException,
                             SQLException

Build the main form that should be the only form that the user interface requires This form will be used for all discovery queries, filters, .... At the moment however this form is only used to track search result hits

Parameters:

searchDiv - the division to add the form to

Throws:

WingException - passed through.

SQLException - passed through.

getBasicUrl

protected abstract String getBasicUrl()
                               throws SQLException

Throws:

SQLException

buildSearchResultsDivision

protected void buildSearchResultsDivision(Division search)
                                   throws IOException,
                                          SQLException,
                                          WingException,
                                          SearchServiceException

Attach a division to the given search division named "search-results" which contains results for this search query.

Parameters:

search - The search division to contain the search-results division.

Throws:

IOException - passed through.

SQLException - passed through.

WingException - passed through.

SearchServiceException - passed through.

addFilterQueriesToUrl

protected String addFilterQueriesToUrl(String pageURLMask)
                                throws UIException

Throws:

UIException

renderItem

protected void renderItem(List dspaceObjectsList,
              Item item,
              DiscoverResult.DSpaceObjectHighlightResult highlightedResults)
                   throws WingException,
                          SQLException

Render the given item, all metadata is added to the given list, which metadata will be rendered where depends on the xsl

Parameters:

dspaceObjectsList - a list of DSpace objects

item - the DSpace item to be rendered

highlightedResults - the highlighted results

Throws:

WingException - passed through.

SQLException - Database failure in services this calls

renderCollection

protected void renderCollection(Collection collection,
                    DiscoverResult.DSpaceObjectHighlightResult highlightedResults,
                    List collectionMetadata)
                         throws WingException

Render the given collection, all collection metadata is added to the list

Parameters:

collection - the collection to be rendered

highlightedResults - the highlighted results

collectionMetadata - list of metadata values.

Throws:

WingException - passed through.

renderCommunity

protected void renderCommunity(Community community,
                   DiscoverResult.DSpaceObjectHighlightResult highlightedResults,
                   List communityMetadata)
                        throws WingException

Render the given collection, all collection metadata is added to the list

Parameters:

community - the community to be rendered

highlightedResults - the highlighted results

communityMetadata - list of metadata values.

Throws:

WingException - passed through.

addMetadataField

protected void addMetadataField(DiscoverResult.DSpaceObjectHighlightResult highlightedResults,
                    String metadataKey,
                    List metadataFieldList,
                    String value)
                         throws WingException

Add the current value to the wing list

Parameters:

highlightedResults - the highlighted results

metadataKey - the metadata key {schema}.{element}.{qualifier}

metadataFieldList - the wing list we need to add the metadata value to

value - the metadata value

Throws:

WingException - passed through.

addMetadataField

protected void addMetadataField(List metadataFieldList,
                    String value)
                         throws WingException

Add our metadata value. This value will might contain the highlight ("<em></em>") tags. These will be removed and rendered as highlight WING fields.

Parameters:

metadataFieldList - the metadata list we need to add the value to.

value - the metadata value to be rendered

Throws:

WingException - passed through.

buildScopeList

protected void buildScopeList(Select scope)
                       throws SQLException,
                              WingException

Add options to the search scope field. This field determines in which communities or collections to search for the query.

The scope list will depend upon the current search scope. There are three cases:

• No current scope: All top level communities are listed.
• The current scope is a community: All collections contained within the community are listed.
• The current scope is a collection: All parent communities are listed.

Parameters:

scope - The current scope field.

Throws:

SQLException - passed through.

WingException - passed through.

prepareQuery

public DiscoverQuery prepareQuery(DSpaceObject scope,
                         String query,
                         String[] fqs)
                           throws UIException,
                                  SearchServiceException

Prepare DiscoverQuery given the current scope and query string

Parameters:

scope - the dspace object parent

query - the query.

fqs - the filter queries.

Returns:

the prepared query.

Throws:

UIException - passed through.

SearchServiceException - passed through.

performSearch

public void performSearch(DSpaceObject scope)
                   throws UIException,
                          SearchServiceException

Query DSpace for a list of all items / collections / or communities that match the given search query.

Parameters:

scope - the dspace object parent

Throws:

UIException - passed through.

SearchServiceException - passed through.

getParameterFilterQueries

protected Map<String,String[]> getParameterFilterQueries()

Returns a list of the filter queries for use in rendering pages, creating page more urls, ....

Returns:

an array containing the filter queries

getFilterQueries

protected String[] getFilterQueries()

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

Returns:

an array containing the filter queries

getFacetsList

protected String[] getFacetsList()

getParameterPage

protected int getParameterPage()

getParameterRpp

protected int getParameterRpp()

getParameterSortBy

protected String getParameterSortBy()

getParameterGroup

protected String getParameterGroup()

getParameterOrder

protected String getParameterOrder()

getParameterScope

protected String getParameterScope()

getParameterEtAl

protected int getParameterEtAl()

variableScope

protected boolean variableScope()
                         throws SQLException

Determine if the scope of the search should fixed or is changeable by the user.

The search scope when performed by URL, i.e. they are at the URL handle/xxxx/xx/search then it is fixed. However at the global level the search is variable.

Returns:

true if the scope is variable, false otherwise.

Throws:

SQLException - passed through.

getQuery

protected abstract String getQuery()
                            throws UIException

Extract the query string. Under most implementations this will be derived from the URL parameters.

Returns:

The query string.

Throws:

UIException - whenever.

generateURL

protected abstract String generateURL(Map<String,String> parameters)
                               throws UIException

Generate a URL to the given search implementation with the associated parameters included.

Parameters:

parameters - URL query parameters.

Returns:

The post URL

Throws:

UIException - whenever.

recycle

public void recycle()

Description copied from class: AbstractWingTransformer

Recycle.

Specified by:

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

Overrides:

recycle in class AbstractDSpaceTransformer

buildSearchControls

protected void buildSearchControls(Division div)
                            throws WingException,
                                   SQLException

Throws:

WingException

SQLException

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 - passed through.

logSearch

protected void logSearch()