org.dspace.app.xmlui.aspect.discovery

Class SimpleSearch

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

org.dspace.app.xmlui.aspect.discovery.SimpleSearch

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

Perform a simple search of the repository. The user provides a simple one field query (the URL parameter is named query) and the results are processed.

Author:

Kevin Van de Velde (kevin at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com), Adán Román Ruiz <aroman@arvo.es> (Bugfix)

Field Summary

Fields inherited from class org.dspace.app.xmlui.aspect.discovery.AbstractSearch

collectionService, communityService, handleService, itemService, metadataExposureService, metadataFieldService, queryArgs, queryResults

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

Method Summary

Modifier and Type	Method and Description
void	addBody(Body body) build the DRI page representing the body of the search query.
protected void	addFilterRow(List<DiscoverySearchFilter> filterFields, int index, Row row, String selectedFilterType, String relationalOperator, String value)
void	addPageMeta(PageMeta pageMeta) Add Page metadata.
protected String	generateURL(Map<String,String> parameters) Generate a URL to the simple search.
protected String	getBasicUrl()
protected String[]	getFilterQueries() Returns all the filter queries for use by discovery This method returns more expanded filter queries then the getParameterFilterQueries
protected Map<String,String[]>	getParameterFilterQueries() Returns a list of the filter queries for use in rendering pages, creating page more urls, ....
protected String	getQuery() Get the search query from the URL parameter, if none is found the empty string is returned.
protected String	getSuggestUrl(String newQuery)

Methods inherited from class org.dspace.app.xmlui.aspect.discovery.AbstractSearch

addFilterQueriesToUrl, addMetadataField, addMetadataField, buildMainForm, buildScopeList, buildSearchControls, buildSearchResultsDivision, getFacetsList, getKey, getParameterEtAl, getParameterGroup, getParameterOrder, getParameterPage, getParameterRpp, getParameterScope, getParameterSortBy, getScope, getValidity, logSearch, performSearch, prepareQuery, recycle, renderCollection, renderCommunity, renderItem, variableScope

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

addOptions, 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.apache.cocoon.caching.CacheableProcessingComponent

getKey, getValidity

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

Constructor Detail

SimpleSearch

public SimpleSearch()

Method Detail

addPageMeta

public void addPageMeta(PageMeta pageMeta)
                 throws WingException,
                        SQLException

Add Page metadata.

Specified by:

addPageMeta in interface DSpaceTransformer

Specified by:

addPageMeta in interface WingTransformer

Overrides:

addPageMeta in class AbstractDSpaceTransformer

Parameters:

pageMeta - to be added.

Throws:

WingException - passed through.

SQLException - passed through.

addBody

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

build the DRI page representing the body of the search query. This provides a widget to generate a new query and list of search results if present.

Specified by:

addBody in interface DSpaceTransformer

Specified by:

addBody in interface WingTransformer

Specified by:

addBody in class AbstractSearch

Parameters:

body - to be added.

Throws:

SAXException - passed through.

WingException - passed through.

SQLException - passed through.

IOException - passed through.

AuthorizeException - passed through.

addFilterRow

protected void addFilterRow(List<DiscoverySearchFilter> filterFields,
                            int index,
                            Row row,
                            String selectedFilterType,
                            String relationalOperator,
                            String value)
                     throws WingException

Throws:

WingException

getBasicUrl

protected String getBasicUrl()
                      throws SQLException

Specified by:

getBasicUrl in class AbstractSearch

Throws:

SQLException

getParameterFilterQueries

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

Description copied from class: AbstractSearch

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

Overrides:

getParameterFilterQueries in class AbstractSearch

Returns:

an array containing the filter queries

getFilterQueries

protected String[] getFilterQueries()

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

Overrides:

getFilterQueries in class AbstractSearch

Returns:

an array containing the filter queries

getQuery

protected String getQuery()
                   throws UIException

Get the search query from the URL parameter, if none is found the empty string is returned.

Specified by:

getQuery in class AbstractSearch

Returns:

decoded query.

Throws:

UIException - passed through.

generateURL

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

Generate a URL to the simple search.

Specified by:

generateURL in class AbstractSearch

Parameters:

parameters - URL query parameters.

Returns:

the URL.

Throws:

UIException - passed through.

getSuggestUrl

protected String getSuggestUrl(String newQuery)
                        throws UIException

Throws:

UIException