Package com.apple.foundationdb.record.lucene.synonym

Interface SynonymMapConfig

All Known Implementing Classes:
EnglishSynonymMapConfig, EnglishSynonymMapConfig.AuthoritativeOnlyEnglishSynonymMapConfig, EnglishSynonymMapConfig.ExpandedEnglishSynonymMapConfig
@API(EXPERIMENTAL) public interface SynonymMapConfig
Configuration of the synonym map, which is built from a file.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    expand()
    Whether to include all synonyms of the original phrases in the map or only the authoritative one.
    String
    getName()
    Get the name of the synonymMap to build.
    InputStream
    getSynonymInputStream()
    Get solr format input stream to build the synonymMap.
    static InputStream
    openFile(String file)
     

  • Method Details

    • getName

      String getName()
      Get the name of the synonymMap to build.
      Returns:
      the name

    • getSynonymInputStream

      InputStream getSynonymInputStream()
      Get solr format input stream to build the synonymMap.
      Returns:
      the input stream

    • expand

      boolean expand()
      Whether to include all synonyms of the original phrases in the map or only the authoritative one. The SynonymGraphFilter needs to be included in both index and query analyzer if this returns false.
      Returns:
      true if all synonyms are included

    • openFile

      @Nonnull static InputStream openFile(@Nonnull String file)