Package globus.glsearch

Class GLSearchCategories

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(java.lang.String iconName)
GLSearchCategory	findByName(java.lang.String name)
static GLSearchCategories	getShared()
GLSearchCategory[]	getStartedWith(java.lang.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 Detail

getShared

@NonNull
public static GLSearchCategories getShared()

getTop

@NonNull
public GLSearchCategory[] getTop()

Returns:

Returns top categories

getStartedWith

@Nullable
public GLSearchCategory[] getStartedWith(@NonNull
                                         java.lang.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
                                   java.lang.String name)

Parameters:

name - name of category

Returns:

Returns category with given name.

findByIconName

@Nullable
public GLSearchCategory findByIconName(@NonNull
                                       java.lang.String iconName)

Parameters:

iconName - Icon name

Returns:

Returns category with given name.