de.digitalcollections.iiif.model.search

Class SearchHit

java.lang.Object

de.digitalcollections.iiif.model.search.SearchHit

public class SearchHit
extends Object

Describes a search hit on a single annotation or across multiple annotations.

See http://iiif.io/api/search/1.0/#search-api-specific-responses

Field Summary

Fields

Modifier and Type	Field and Description
String	TYPE

Constructor Summary

Constructors

Constructor and Description
SearchHit()

Method Summary

Modifier and Type	Method and Description
SearchHit	addAnnotation(Annotation first, Annotation... rest)
SearchHit	addSelector(TextQuoteSelector first, TextQuoteSelector... rest)
String	getAfter()
List<Annotation>	getAnnotations()
String	getBefore()
String	getMatch()
List<TextQuoteSelector>	getSelectors()
void	setAfter(String after)
void	setAnnotations(List<Annotation> annotations)
void	setBefore(String before)
void	setMatch(String match)
void	setSelectors(List<TextQuoteSelector> selectors)

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public final String TYPE

See Also:

Constant Field Values

Constructor Detail

SearchHit

public SearchHit()

Method Detail

getAnnotations

public List<Annotation> getAnnotations()

setAnnotations

public void setAnnotations(List<Annotation> annotations)

addAnnotation

public SearchHit addAnnotation(Annotation first,
                               Annotation... rest)

getSelectors

public List<TextQuoteSelector> getSelectors()

setSelectors

public void setSelectors(List<TextQuoteSelector> selectors)

addSelector

public SearchHit addSelector(TextQuoteSelector first,
                             TextQuoteSelector... rest)

getMatch

public String getMatch()

setMatch

public void setMatch(String match)

getBefore

public String getBefore()

setBefore

public void setBefore(String before)

getAfter

public String getAfter()

setAfter

public void setAfter(String after)