de.digitalcollections.iiif.model.search

Class SearchResult

java.lang.Object

de.digitalcollections.iiif.model.sharedcanvas.Resource

de.digitalcollections.iiif.model.sharedcanvas.AnnotationList

de.digitalcollections.iiif.model.search.SearchResult

All Implemented Interfaces:

Pageable<AnnotationList>

public class SearchResult
extends AnnotationList

An AnnotationList that contains hits for a given search query.

See http://iiif.io/api/search/1.0/#simple-lists

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT

Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.AnnotationList

TYPE

Fields inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

_context

Constructor Summary

Constructors

Constructor and Description
SearchResult(String identifier)

Method Summary

Modifier and Type	Method and Description
SearchResult	addHit(SearchHit first, SearchHit... rest)
Resource	addWithin(Resource first, Resource... rest) Add a new containing resource.
List<String>	getContext()
List<SearchHit>	getHits()
SearchResult	getNext()
SearchResult	getPrevious()
void	setHits(List<SearchHit> hits)
void	setNext(SearchResult next)
void	setPrevious(SearchResult previous)
void	setWithin(List<Resource> within) Set the list of containing resources.

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.AnnotationList

addResource, getResources, getStartIndex, getType, setNext, setPrevious, setResources, setStartIndex

Methods inherited from class de.digitalcollections.iiif.model.sharedcanvas.Resource

addAttribution, addDescription, addLabel, addLicense, addLogo, addLogo, addMetadata, addMetadata, addRelated, addRendering, addSeeAlso, addService, addThumbnail, addViewingHint, getAttribution, getAttributionString, getDescription, getDescriptionString, getFirstLicense, getIdentifier, getLabel, getLabelString, getLicenses, getLogos, getLogoUri, getMetadata, getRelated, getRenderings, getSeeAlso, getServices, getSupportedViewingHintTypes, getThumbnail, getThumbnails, getViewingHints, getWithin, setAttribution, setDescription, setIdentifier, setLabel, setLicenses, setLogos, setRelated, setRenderings, setSeeAlso, setServices, setThumbnails, setViewingHints, toString, verifyRendering

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

Constructor Detail

SearchResult

public SearchResult(String identifier)

Method Detail

getContext

public List<String> getContext()

getHits

public List<SearchHit> getHits()

setHits

public void setHits(List<SearchHit> hits)

addHit

public SearchResult addHit(SearchHit first,
                           SearchHit... rest)

setWithin

public void setWithin(List<Resource> within)
               throws IllegalArgumentException

Set the list of containing resources. Must all be instances of SearchLayer

Overrides:

setWithin in class Resource

Throws:

IllegalArgumentException - if at least one of the resources is not a SearchLayer

addWithin

public Resource addWithin(Resource first,
                          Resource... rest)
                   throws IllegalArgumentException

Add a new containing resource. Must be an instance of SearchLayer

Overrides:

addWithin in class Resource

Throws:

IllegalArgumentException - if the resource is not a SearchLayer

getNext

public SearchResult getNext()

Specified by:

getNext in interface Pageable<AnnotationList>

Overrides:

getNext in class AnnotationList

setNext

public void setNext(SearchResult next)

getPrevious

public SearchResult getPrevious()

Specified by:

getPrevious in interface Pageable<AnnotationList>

Overrides:

getPrevious in class AnnotationList

setPrevious

public void setPrevious(SearchResult previous)