Package com.esri.arcgisruntime.symbology

Class SymbolStyleSearchParameters

  • public final class SymbolStyleSearchParameters
extends Object
    Defines parameters used to search for symbol primitives in a SymbolStyle.

    For example, for a symbol dictionary created with mi2525d, you may want to search for any symbols where the category is "2", the name contains "destroyed", and the tags contain "Protection Lines".

    Since:
    100.0.0 for JavaSE and 100.2.0 for Android
    See Also:
    SymbolStyle.searchSymbolsAsync(SymbolStyleSearchParameters)

    • Method Detail

      • getNames

        public List<String> getNames()
        Gets the names to be matched.
        Returns:
        a list that can be updated with the names to be matched, empty by default
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isNamesStrictlyMatch

        public boolean isNamesStrictlyMatch()
        Gets whether search should enforce a strict match for names.

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Returns:
        true to enforce a strict match of names, otherwise false, default is false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • setNamesStrictlyMatch

        public void setNamesStrictlyMatch​(boolean strictlyMatch)
        Sets whether search should enforce a strict match for names added to the list from getNames().

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Parameters:
        strictlyMatch - true to enforce a strict match of names, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • getTags

        public List<String> getTags()
        Gets the tags to be matched.

        For example, tags for mil2525d include "Airspace Control Points", "Meteorological - Oceanographic".

        Returns:
        a list that can be updated with the tags to be matched, empty by default
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isTagsStrictlyMatch

        public boolean isTagsStrictlyMatch()
        Gets whether search should enforce a strict match for tags.

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Returns:
        true to enforce a strict match of tags, otherwise false, default is false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • setTagsStrictlyMatch

        public void setTagsStrictlyMatch​(boolean strictlyMatch)
        Sets whether search should enforce a strict match for tags added to the list from getTags().

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Parameters:
        strictlyMatch - true to enforce a strict match of tags, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • getSymbolClasses

        public List<String> getSymbolClasses()
        Gets the symbol classes to be matched.

        For example, with mil2525d you may want to search for symbols where the symbol classes are "3" (Point Symbol) or "7" (North Arrow).

        Returns:
        a list that can be updated with the symbol classes to be matched, empty by default
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isSymbolClassesStrictlyMatch

        public boolean isSymbolClassesStrictlyMatch()
        Gets whether search should enforce a strict match for symbol classes.

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Returns:
        true to enforce a strict match of symbol classes, otherwise false, default is false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • setSymbolClassesStrictlyMatch

        public void setSymbolClassesStrictlyMatch​(boolean strictlyMatch)
        Sets whether search should enforce a strict match for symbol classes added to the list from getSymbolClasses().

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Parameters:
        strictlyMatch - true to enforce a strict match of symbol classes, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • getKeys

        public List<String> getKeys()
        Gets the keys to be matched.

        For example, with mil2525d you may want to search for symbols where the keys are "25272100" or "2_635_1c".

        Returns:
        a list that can be updated with the keys to be matched, empty by default
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isKeysStrictlyMatch

        public boolean isKeysStrictlyMatch()
        Gets whether search should enforce a strict match for keys.

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Returns:
        true to enforce a strict match of keys, otherwise false, default is false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • setKeysStrictlyMatch

        public void setKeysStrictlyMatch​(boolean strictlyMatch)
        Sets whether search should enforce a strict match for keys added to the list from getKeys().

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Parameters:
        strictlyMatch - true to enforce a strict match of keys, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • getCategories

        public List<String> getCategories()
        Gets the categories to be matched.

        For example, with mil2525d you may want to search for symbols where the categories are "Activities : Main Icon" or "Sea Surface : Main Icon".

        Returns:
        a list that can be updated with the categories to be matched, empty by default
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isCategoriesStrictlyMatch

        public boolean isCategoriesStrictlyMatch()
        Gets whether search should enforce a strict match for categories.

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Returns:
        true to enforce a strict match of categories, otherwise false, default is false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • setCategoriesStrictlyMatch

        public void setCategoriesStrictlyMatch​(boolean strictlyMatch)
        Sets whether search should enforce a strict match for categories added to the list from getCategories().

        A strict match will force the search to use "=", otherwise SQL "LIKE" operator is used.

        Parameters:
        strictlyMatch - true to enforce a strict match of categories, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android

      • isEmpty

        public boolean isEmpty()
        Returns true if the lists for categories, keys, names, symbolClasses and tags are all empty. This does not take into account any of the strictlyMatch getters.
        Returns:
        true if the lists for categories, keys, names, symbolClasses and tags are all empty, otherwise false
        Since:
        100.0.0 for JavaSE and 100.2.0 for Android