Package 

Interface SearchService

  • All Implemented Interfaces:
    org.readium.r2.shared.publication.Publication.Service , org.readium.r2.shared.util.Closeable 
    
public interface SearchService
 implements Publication.Service

    Provides a way to search terms in a publication.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      public final class SearchService.Options

      Holds the available search options and their current values.

    • Method Summary

      Modifier and Type Method Description
      abstract SearchIterator search(String query, SearchService.Options options) Starts a new search through the publication content, with the given query.
      abstract SearchService.Options getOptions() Default value for the search options of this service.

      • Methods inherited from class org.readium.r2.shared.publication.services.search.SearchService

        close

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getOptions

         abstract SearchService.Options getOptions()

        Default value for the search options of this service.

        If an option does not have a value, it is not supported by the service.