Package io.goobi.viewer.model.iiif.search

Class IIIFSearchBuilder

java.lang.Object

io.goobi.viewer.model.iiif.search.IIIFSearchBuilder

public class IIIFSearchBuilder
extends Object

Creates a IIIF Search API v1.0 response as SearchResult

Author:

florian

Constructor Summary

Constructors

Constructor	Description
IIIFSearchBuilder(AbstractApiUrlManager urls, String query, String pi, jakarta.servlet.http.HttpServletRequest request)	Initializes the builder with all required parameters

Method Summary

Modifier and Type	Method	Description
de.intranda.api.iiif.search.SearchResult	build()	Creates a SearchResult containing annotations matching getQuery() within getPi().
de.intranda.api.iiif.search.AutoSuggestResult	buildAutoSuggest()	Creates a AutoSuggestResult containing searchTerms matching getQuery() within getPi().
String	getDate()	Getter for the field date.
int	getHitsPerPage()	Getter for the field hitsPerPage.
String	getMin()	Getter for the field min.
List<String>	getMotivation()	Getter for the field motivation.
String	getMotivationAsString()
int	getPage()	Getter for the field page.
String	getPi()	Getter for the field pi.
String	getQuery()	Getter for the field query.
String	getUser()	Getter for the field user.
IIIFSearchBuilder	setDate(String date)	Setter for the field date.
IIIFSearchBuilder	setHitsPerPage(int hitsPerPage)	Setter for the field hitsPerPage.
IIIFSearchBuilder	setMin(String min)	Setter for the field min.
IIIFSearchBuilder	setMotivation(String motivation)	Setter for the field motivation.
IIIFSearchBuilder	setPage(Integer page)	Setter for the field page.
IIIFSearchBuilder	setUser(String user)	Setter for the field user.

Methods inherited from class java.lang.Object

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

Constructor Details

IIIFSearchBuilder

public IIIFSearchBuilder(AbstractApiUrlManager urls,
 String query,
 String pi,
 jakarta.servlet.http.HttpServletRequest request)

Initializes the builder with all required parameters

Parameters:

urls -

query - the query string

pi - the pi of the manifest to search

request -

Method Details

getQuery

public String getQuery()

Getter for the field query.

Returns:

the query

getPi

public String getPi()

Getter for the field pi.

Returns:

the pi

setMotivation

public IIIFSearchBuilder setMotivation(String motivation)

Setter for the field motivation.

Parameters:

motivation - the motivation to set

Returns:

a IIIFSearchBuilder object.

getMotivation

public List<String> getMotivation()

Getter for the field motivation.

Returns:

the motivation

getMotivationAsString

public String getMotivationAsString()

setUser

public IIIFSearchBuilder setUser(String user)

Setter for the field user.

Parameters:

user - the user to set

Returns:

a IIIFSearchBuilder object.

getUser

public String getUser()

Getter for the field user.

Returns:

the user

setDate

public IIIFSearchBuilder setDate(String date)

Setter for the field date.

Parameters:

date - the date to set

Returns:

a IIIFSearchBuilder object.

getDate

public String getDate()

Getter for the field date.

Returns:

the date

getMin

public String getMin()

Getter for the field min.

Returns:

the min

setMin

public IIIFSearchBuilder setMin(String min)

Setter for the field min.

Parameters:

min - the min to set

Returns:

a IIIFSearchBuilder object.

setPage

public IIIFSearchBuilder setPage(Integer page)

Setter for the field page.

Parameters:

page - the page to set

Returns:

a IIIFSearchBuilder object.

getPage

public int getPage()

Getter for the field page.

Returns:

the page

getHitsPerPage

public int getHitsPerPage()

Getter for the field hitsPerPage.

Returns:

the hitsPerPage

setHitsPerPage

public IIIFSearchBuilder setHitsPerPage(int hitsPerPage)

Setter for the field hitsPerPage.

Parameters:

hitsPerPage - the hitsPerPage to set

Returns:

a IIIFSearchBuilder object.

build

public de.intranda.api.iiif.search.SearchResult build()
                                               throws PresentationException,
IndexUnreachableException

Creates a SearchResult containing annotations matching getQuery() within getPi(). The answer may contain more than getHitsPerPage() hits if more than one motivation is searched, but no more than getHitsPerPage() hits per motivation.

Returns:

the search result

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

buildAutoSuggest

public de.intranda.api.iiif.search.AutoSuggestResult buildAutoSuggest()
                                                               throws PresentationException,
IndexUnreachableException

Creates a AutoSuggestResult containing searchTerms matching getQuery() within getPi().

Returns:

The searchTerm list

Throws:

PresentationException - if any.

IndexUnreachableException - if any.