Package globus.glsearch

Class GLSearchCategory

java.lang.Object
globus.glmap.GLNativeObject
globus.glsearch.GLSearchCategory
All Implemented Interfaces:
AutoCloseable
public class GLSearchCategory extends globus.glmap.GLNativeObject
GLSearchCategory holds information about category that can be displayed to user.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    void
    fillObjectCategory(globus.glmap.GLMapVectorObject object)
    Fills category information for a vector object using its tags.
    GLSearchCategory[]
    getChilds()
    Retrieves the child categories of this category.
    String
    getIconName()
    Retrieves the icon name of the category.
    String
    getIdentifier()
    Retrieves the stable category identifier used by online search APIs.
    GLSearchCategory
    getParent()
    Retrieves the parent category of this category.
    globus.glmap.GLMapVectorObject
    getRefObject()
    Retrieves the reference object that matches this category.
    int
    hashCode()
     
    globus.glmap.GLMapValue
    localizedName(globus.glmap.GLMapLocaleSettings localeSettings)
    Returns name of the category according language priority settings.

    Methods inherited from class globus.glmap.GLNativeObject

    close, dispose

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • localizedName

      @Nullable public globus.glmap.GLMapValue localizedName(globus.glmap.GLMapLocaleSettings localeSettings)
      Returns name of the category according language priority settings. It checks for translated name from first language in priority list to the last one until first translated name is found.
      Parameters:
      localeSettings - language order settings
      Returns:
      localized name of the category.

    • getIconName

      @Nullable public String getIconName()
      Retrieves the icon name of the category.
      Returns:
      The icon name as a String, or null if no icon is associated with the category.

    • getIdentifier

      @Nullable public String getIdentifier()
      Retrieves the stable category identifier used by online search APIs.
      Returns:
      The stable identifier as a String, or null if the category has no identifier.

    • getParent

      @Nullable public GLSearchCategory getParent()
      Retrieves the parent category of this category.
      Returns:
      The parent GLSearchCategory, or null if this category has no parent.

    • getChilds

      public GLSearchCategory[] getChilds()
      Retrieves the child categories of this category.
      Returns:
      An array of GLSearchCategory objects representing the child categories.

    • getRefObject

      @NonNull public globus.glmap.GLMapVectorObject getRefObject()
      Retrieves the reference object that matches this category.
      Returns:
      A GLMapVectorObject associated with this category.

    • fillObjectCategory

      public void fillObjectCategory(@NonNull globus.glmap.GLMapVectorObject object)
      Fills category information for a vector object using its tags.
      Parameters:
      object - Vector object to fill category

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object