Package org.dspace.app.iiif.service

Class WordHighlightSolrSearch

java.lang.Object

org.dspace.app.iiif.service.WordHighlightSolrSearch

All Implemented Interfaces:

SearchAnnotationService

@Scope("prototype")
@Component
public class WordHighlightSolrSearch
extends Object
implements SearchAnnotationService

This service implements methods for executing a solr search and creating IIIF search result annotations.

https://github.com/dbmdz/solr-ocrhighlighting

Constructor Summary

Constructors

Constructor	Description
WordHighlightSolrSearch()

Method Summary

Modifier and Type	Method	Description
String	getSearchResponse(UUID uuid, String query)	Executes the Search API solr query and returns iiif search result annotations.
void	initializeQuerySettings(String endpoint, String manifestId)	Initializes required values.
boolean	useSearchPlugin(String className)	Tests to see if the plugin is configured in iiif.cfg.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordHighlightSolrSearch

public WordHighlightSolrSearch()

Method Detail

useSearchPlugin

public boolean useSearchPlugin(String className)

Description copied from interface: SearchAnnotationService

Tests to see if the plugin is configured in iiif.cfg.

Specified by:

useSearchPlugin in interface SearchAnnotationService

Parameters:

className - the canonical name of class

Returns:

true if provided value matches plugin class name

initializeQuerySettings

public void initializeQuerySettings(String endpoint,
                                    String manifestId)

Description copied from interface: SearchAnnotationService

Initializes required values.

Specified by:

initializeQuerySettings in interface SearchAnnotationService

Parameters:

endpoint - the iiif service endpoint

manifestId - the id of the manifest to search within

getSearchResponse

public String getSearchResponse(UUID uuid,
                                String query)

Description copied from interface: SearchAnnotationService

Executes the Search API solr query and returns iiif search result annotations.

Specified by:

getSearchResponse in interface SearchAnnotationService

query - encoded query terms

Returns:

iiif json response