Interface ISearchDomainService

  • All Known Implementing Classes:
    AbstractSearchDomainService, BlastDatabase, EchoDatabase, FileSearchDomain

    public interface ISearchDomainService
    Interface for a search domain service. Implementing classes should have a public constructor with two arguments: First is an instance of Properties and second is an instance of File which points to the root of the data set store.
    • Method Detail

      • getLabel

        java.lang.String getLabel()
        Returns the label of this search domain service instance. It can be used for human readable output. Will be used to populated SearchDomain instances of the search result..
      • getPossibleSearchOptionsKey

        java.lang.String getPossibleSearchOptionsKey()
        Returns the key used in optionalParametersOrNull if this service supports different SearchDomainSearchOptions.
        Returns:
        null if no such options supported.
      • isAvailable

        boolean isAvailable()
        Returns true if this service is available. For example, a local BLAST sequence search service is available if the external BLAST tools are available.
      • search

        java.util.List<SearchDomainSearchResult> search​(java.lang.String searchString,
                                                        java.util.Map<java.lang.String,​java.lang.String> optionalParametersOrNull)
        Searches this service for the specified search string.
        Parameters:
        optionalParametersOrNull - Optional parameters which might be used. Can be null.
        Returns:
        an empty list if nothing be found.