Interface SearchAnnotationService

  • All Known Implementing Classes:
    WordHighlightSolrSearch

    public interface SearchAnnotationService
    Interface for IIIF Search API implementations.
    • Method Detail

      • initializeQuerySettings

        void initializeQuerySettings​(String endpoint,
                                     String manifestId)
        Initializes required values.
        Parameters:
        endpoint - the iiif service endpoint
        manifestId - the id of the manifest to search within
      • getSearchResponse

        String getSearchResponse​(UUID uuid,
                                 String query)
        Executes the Search API solr query and returns iiif search result annotations.
        Parameters:
        query - encoded query terms
        Returns:
        iiif json response
      • useSearchPlugin

        boolean useSearchPlugin​(String className)
        Tests to see if the plugin is configured in iiif.cfg.
        Parameters:
        className - the canonical name of class
        Returns:
        true if provided value matches plugin class name