Package io.goobi.viewer.model.search

Class SearchResultGroup

java.lang.Object

io.goobi.viewer.model.search.SearchResultGroup

All Implemented Interfaces:

Serializable

public class SearchResultGroup
extends Object
implements Serializable

Used for creating separate groups of search results for a single query. Each group can provide its own filter query for custom results.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SearchResultGroup(SearchResultGroup blueprint)	Creates a copy of the given SearchResultGroup, without any search results.
SearchResultGroup(String name, String query, int previewHitCount)

Method Summary

Modifier and Type	Method	Description
static SearchResultGroup	createDefaultGroup()
static SearchResultGroup	createDefaultGroup(String query)
static List<SearchResultGroup>	getConfiguredResultGroups()	Returns a list of configured result groups or a default group if none are configured.
List<Location>	getHitLocationList()
List<SearchHit>	getHits()
long	getHitsCount()
String	getName()
int	getPreviewHitCount()
String	getQuery()
boolean	isDisplayExpandUrl()
boolean	isHasGeoLocationHits()
void	setHasGeoLocationHits(boolean hasGeoLocationHits)
void	setHitLocationList(List<Location> hitLocationList)
void	setHitsCount(long hitsCount)

Methods inherited from class java.lang.Object

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

Constructor Details

SearchResultGroup

public SearchResultGroup(String name,
 String query,
 int previewHitCount)

Parameters:

name - name/identifier of this result group

query - Solr query to filter results for this group

previewHitCount - number of preview hits to show; -1 for unlimited

SearchResultGroup

public SearchResultGroup(SearchResultGroup blueprint)

Creates a copy of the given SearchResultGroup, without any search results.

Parameters:

blueprint - the SearchResultGroup to copy structure from

Method Details

createDefaultGroup

public static SearchResultGroup createDefaultGroup()

Returns:

Created SearchResultGroup

createDefaultGroup

public static SearchResultGroup createDefaultGroup(String query)

Parameters:

query - Solr query to assign to the default group

Returns:

Created SearchResultGroup

getConfiguredResultGroups

public static List<SearchResultGroup> getConfiguredResultGroups()

Returns a list of configured result groups or a default group if none are configured.

Returns:

List

isDisplayExpandUrl

public boolean isDisplayExpandUrl()

Returns:

true if not default group and hitsCount larger than previewHitCount; false otherwise

getName

public String getName()

getQuery

public String getQuery()

getPreviewHitCount

public int getPreviewHitCount()

getHitsCount

public long getHitsCount()

setHitsCount

public void setHitsCount(long hitsCount)

getHitLocationList

public List<Location> getHitLocationList()

setHitLocationList

public void setHitLocationList(List<Location> hitLocationList)

isHasGeoLocationHits

public boolean isHasGeoLocationHits()

setHasGeoLocationHits

public void setHasGeoLocationHits(boolean hasGeoLocationHits)

getHits

public List<SearchHit> getHits()