GLSearchCategories (GLSearch unspecified)

java.lang.Object

globus.glmap.GLNativeObject

globus.glsearch.GLSearchCategories

public class GLSearchCategories extends globus.glmap.GLNativeObject

GLSearchCategories class holds a set of `GLSearchCategory` that will be used to sort search results by priority.

Method Summary

Modifier and Type

Method

Description

GLSearchCategory

findByIconName(String iconName)

GLSearchCategory

findByName(String name)

static GLSearchCategories

getShared()

Shared categories.

GLSearchCategory[]

getStartedWith(String[] words, globus.glmap.GLMapLocaleSettings localeSettings)

Returns categories that starts with given words

GLSearchCategory[]

getTop()

Methods inherited from class globus.glmap.GLNativeObject
dispose

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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()
  
  Returns:
  
  Returns top categories
- getStartedWith
  
  @Nullable public GLSearchCategory[] getStartedWith(@NonNull String[] words, @NonNull globus.glmap.GLMapLocaleSettings localeSettings)
  
  Returns categories that starts with given words
  
  Parameters:
  
  words - Words array
  
  localeSettings - Language priority settings
  
  Returns:
  
  Matched array of categories
- findByName
  
  @Nullable public GLSearchCategory findByName(@NonNull String name)
  
  Parameters:
  
  name - name of category
  
  Returns:
  
  Returns category with given name.
- findByIconName
  
  @Nullable public GLSearchCategory findByIconName(@NonNull String iconName)
  
  Parameters:
  
  iconName - Icon name
  
  Returns:
  
  Returns category with given name.