no.ssb.lds.api.search.SearchIndexProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of linked-data-store-search-provider-api Show documentation

LinkedDataStore Search Provider API

There is a newer version: 0.4

Show newest version

package no.ssb.lds.api.search;

import java.util.Map;
import java.util.Set;

/**
 * Common interface for Java's SPI to set up different search engine providers.
 */
public interface SearchIndexProvider {

    /**
     * Returns a unique ID of the search engine provider
     */
    String getProviderId();

    /**
     * Returns a list of configuration keys that is used by the search engine provider
     */
    Set configurationKeys();

    /**
     * Creates and initializes the search engine with the given configuration
     */
    SearchIndex getSearchIndex(Map configuration);

}