Package globus.glsearch

Class GLSearchCategories

java.lang.Object
globus.glmap.GLNativeObject
globus.glsearch.GLSearchCategories
public class GLSearchCategories extends GLNativeObject
GLSearchCategories class holds a set of `GLSearchCategory` that will be used to sort search results by priority.

  • Method Details

    • getShared

      @NonNull public static GLSearchCategories getShared()
      Shared categories. Call GLSearch.Initialize before using this method.
      Returns:
      shared categories

    • getTop

      @NonNull public GLSearchCategory[] getTop()
      Retrieves the top-level categories.
      Returns:
      An array of GLSearchCategory objects representing the top categories.

    • getStartedWith

      @Nullable public GLSearchCategory[] getStartedWith(@NonNull String[] words, @NonNull GLMapLocaleSettings localeSettings)
      Finds categories that start with the given words.
      Parameters:
      words - An array of words to match the beginning of category names.
      localeSettings - The language priority settings for the search.
      Returns:
      An array of matched GLSearchCategory objects, or null if no matches are found.

    • findByName

      @Nullable public GLSearchCategory findByName(@NonNull String name)
      Finds a category by its name.
      Parameters:
      name - The name of the category to search for.
      Returns:
      The GLSearchCategory with the given name, or null if no such category exists.

    • findByIconName

      @Nullable public GLSearchCategory findByIconName(@NonNull String iconName)
      Finds a category by its icon name.
      Parameters:
      iconName - The icon name associated with the category to search for.
      Returns:
      The GLSearchCategory with the given icon name, or null if no such category exists.