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

static class	DiscoverResult.DSpaceObjectHighlightResult
static class	DiscoverResult.FacetResult
static class	DiscoverResult.SearchDocument This class contains values from the fields searched for in DiscoveryQuery.java

Constructor Summary

DiscoverResult()

Method Summary

void	addDSpaceObject(DSpaceObject dso)
void	addFacetResult(String facetField, DiscoverResult.FacetResult... facetResults)
void	addHighlightedResult(DSpaceObject dso, DiscoverResult.DSpaceObjectHighlightResult highlightedResult)
void	addSearchDocument(DSpaceObject dso, DiscoverResult.SearchDocument searchDocument)
List<DSpaceObject>	getDspaceObjects()
List<DiscoverResult.FacetResult>	getFacetResult(String facet)
Map<String,List<DiscoverResult.FacetResult>>	getFacetResults()
DiscoverResult.DSpaceObjectHighlightResult	getHighlightedResults(DSpaceObject dso)
int	getMaxResults()
List<DiscoverResult.SearchDocument>	getSearchDocument(DSpaceObject dso) Returns all the sought after search document values
int	getSearchTime()
int	getStart()
long	getTotalSearchResults()
void	setMaxResults(int maxResults)
void	setSearchTime(int searchTime)
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

addDSpaceObject

public void addDSpaceObject(DSpaceObject dso)

getDspaceObjects

public List<DSpaceObject> getDspaceObjects()

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)

getHighlightedResults

public DiscoverResult.DSpaceObjectHighlightResult getHighlightedResults(DSpaceObject dso)

addHighlightedResult

public void addHighlightedResult(DSpaceObject dso,
                                 DiscoverResult.DSpaceObjectHighlightResult highlightedResult)

addSearchDocument

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

getSearchDocument

public List<DiscoverResult.SearchDocument> getSearchDocument(DSpaceObject dso)

Returns all the sought after search document values

Parameters:

dso - the dspace object we want our search documents for

Returns:

the search documents list