Package globus.glsearch

Class GLSearchFilter

  • public class GLSearchFilter
extends globus.glmap.GLNativeObject
    `GLSearchFilter` class contains a set of parameters that defines filter for `GLSearch`

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTag​(java.lang.String tag)
      Adds tag to search filter
      void addTagHash​(int tagHash)
      Adds tag using it's hash Tag hashes could be found in vector object returned from search or found on map
      void addTags​(java.util.List<java.lang.String> tags)
      Adds additional tags to search filter
      static GLSearchFilter createWithCategory​(GLSearchCategory category)
      Creates new filter to search objects from category
      static GLSearchFilter createWithQuery​(java.lang.String query)
      Creates new filter to search objects with string "query".
      static GLSearchFilter createWithQuery​(java.lang.String query, int tagSetMask)
      Creates new filter to search objects with string "query" inside tags sets
      static GLSearchFilter createWithQueryAndTag​(java.lang.String query, java.lang.String tag)
      Creates new filter to search objects with string "query" for key
      void setMatchType​(int matchType)
      Sets how we should compare query string with values of objects.

      • 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

      • createWithQuery

        @NonNull
public static GLSearchFilter createWithQuery​(@NonNull
                                             java.lang.String query)
        Creates new filter to search objects with string "query". Uses default tag set and match type. Default tag set is TagSetMask.ALL Default match type is MatchType.WORD_START
        Parameters:
        query - Part of word, word or phrase to search
        Returns:
        Filter instance

      • createWithQueryAndTag

        @NonNull
public static GLSearchFilter createWithQueryAndTag​(@NonNull
                                                   java.lang.String query,
                                                   @NonNull
                                                   java.lang.String tag)
        Creates new filter to search objects with string "query" for key
        Parameters:
        query - Part of word, word or phrase to search
        tag - Tag to test
        Returns:
        Filter instance

      • createWithQuery

        public static GLSearchFilter createWithQuery​(@NonNull
                                             java.lang.String query,
                                             int tagSetMask)
        Creates new filter to search objects with string "query" inside tags sets
        Parameters:
        query - Part of word, word or phrase to search
        tagSetMask - Set of tags where query could be found
        Returns:
        Filter instance

      • createWithCategory

        public static GLSearchFilter createWithCategory​(@NonNull
                                                GLSearchCategory category)
        Creates new filter to search objects from category
        Parameters:
        category - Category
        Returns:
        Filter instance

      • addTagHash

        public void addTagHash​(int tagHash)
        Adds tag using it's hash Tag hashes could be found in vector object returned from search or found on map
        Parameters:
        tagHash - Hash of the tag

      • addTag

        public void addTag​(@NonNull
                   java.lang.String tag)
        Adds tag to search filter
        Parameters:
        tag - Tag

      • addTags

        public void addTags​(@NonNull
                    java.util.List<java.lang.String> tags)
        Adds additional tags to search filter
        Parameters:
        tags - Tags array

      • setMatchType

        public void setMatchType​(int matchType)
        Sets how we should compare query string with values of objects. Default match type is MatchType.WORD_START
        Parameters:
        matchType - match type