Package org.dspace.discovery

Class DiscoverResult

java.lang.Object

org.dspace.discovery.DiscoverResult

public class DiscoverResult
extends Object

This class represents the result that the discovery search impl returns

Author:

Kevin Van de Velde (kevin at atmire dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DiscoverResult.FacetResult
static class	DiscoverResult.IndexableObjectHighlightResult	An utility class to represent the highlighting section of a Discovery Search
static class	DiscoverResult.SearchDocument	This class contains values from the fields searched for in DiscoveryQuery.java

Constructor Summary

Constructors

Constructor	Description
DiscoverResult()

Method Summary

Modifier and Type	Method	Description
void	addFacetResult(String facetField, DiscoverResult.FacetResult... facetResults)
void	addHighlightedResult(IndexableObject dso, DiscoverResult.IndexableObjectHighlightResult highlightedResult)
void	addIndexableObject(IndexableObject idxObj)
void	addSearchDocument(IndexableObject dso, DiscoverResult.SearchDocument searchDocument)
List<DiscoverResult.FacetResult>	getFacetResult(String facet)
List<DiscoverResult.FacetResult>	getFacetResult(DiscoverySearchFilterFacet field)
Map<String,List<DiscoverResult.FacetResult>>	getFacetResults()
DiscoverResult.IndexableObjectHighlightResult	getHighlightedResults(IndexableObject dso)
List<IndexableObject>	getIndexableObjects()
int	getMaxResults()
List<DiscoverResult.SearchDocument>	getSearchDocument(IndexableObject idxObj)	Returns all the sought after search document values
int	getSearchTime()
String	getSpellCheckQuery()
int	getStart()
long	getTotalSearchResults()
void	setMaxResults(int maxResults)
void	setSearchTime(int searchTime)
void	setSpellCheckQuery(String spellCheckQuery)
void	setStart(int start)
void	setTotalSearchResults(long totalSearchResults)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiscoverResult

public DiscoverResult()

Method Detail

addIndexableObject

public void addIndexableObject(IndexableObject idxObj)

getIndexableObjects

public List<IndexableObject> getIndexableObjects()

getTotalSearchResults

public long getTotalSearchResults()

setTotalSearchResults

public void setTotalSearchResults(long totalSearchResults)

getStart

public int getStart()

setStart

public void setStart(int start)

getMaxResults

public int getMaxResults()

setMaxResults

public void setMaxResults(int maxResults)

getSearchTime

public int getSearchTime()

setSearchTime

public void setSearchTime(int searchTime)

addFacetResult

public void addFacetResult(String facetField,
                           DiscoverResult.FacetResult... facetResults)

getFacetResults

public Map<String,List<DiscoverResult.FacetResult>> getFacetResults()

getFacetResult

public List<DiscoverResult.FacetResult> getFacetResult(String facet)

getFacetResult

public List<DiscoverResult.FacetResult> getFacetResult(DiscoverySearchFilterFacet field)

getHighlightedResults

public DiscoverResult.IndexableObjectHighlightResult getHighlightedResults(IndexableObject dso)

addHighlightedResult

public void addHighlightedResult(IndexableObject dso,
                                 DiscoverResult.IndexableObjectHighlightResult highlightedResult)

getSpellCheckQuery

public String getSpellCheckQuery()

setSpellCheckQuery

public void setSpellCheckQuery(String spellCheckQuery)

addSearchDocument

public void addSearchDocument(IndexableObject dso,
                              DiscoverResult.SearchDocument searchDocument)

getSearchDocument

public List<DiscoverResult.SearchDocument> getSearchDocument(IndexableObject idxObj)

Returns all the sought after search document values

Parameters:

idxObj - the indexable object we want our search documents for

Returns:

the search documents list