Package com.microstrategy.web.app.maps

Class GeoRequestBase

  • Direct Known Subclasses:
    LookupRequest, QueryRequest
    public abstract class GeoRequestBase
extends java.lang.Object
    Request object contains all the parsed query parameters, including query target type, query fields, and basic utility functions.

    • Field Detail

      • HIERARCHY_SEPERATOR

        public static final java.lang.String HIERARCHY_SEPERATOR
        See Also:
        Constant Field Values

      • lookupKey

        protected java.lang.String lookupKey

      • targetType

        protected java.lang.String targetType

      • queryField

        protected java.lang.String queryField

    • Method Detail

      • getLookupKey

        public java.lang.String getLookupKey()

      • getTargetType

        public java.lang.String getTargetType()

      • getQueryField

        public java.lang.String getQueryField()

      • queryFieldHierarchy

        public java.util.List<java.lang.String> queryFieldHierarchy()

      • matchesQueryField

        public static boolean matchesQueryField​(java.lang.String queryField,
                                        java.lang.String expectingField)
        Find out the whether the given query field string matches an expected field.
        Parameters:
        queryField - A given query field in string format
        expectingField - The expecting query field. The value can be QUERY_BY_ID, QUERY_BY_NAME, or QUERY_BY_ALIAS
        Returns:
        true if the string matches the expected query field. Otherwise, it returns false.

      • splitString2StringArray

        protected static java.util.List<java.lang.String> splitString2StringArray​(java.lang.String str)
        The function splits the query field hierarchy string into a list of integers. The string tokens should be connected with the separator ':'.
        Parameters:
        str - The query field hierarchy string that contains the ':' separator.
        Returns:
        A list of Integer represents the query field values in hierarchy.

      • splitString2IntegerArray

        protected static java.util.List<java.lang.Integer> splitString2IntegerArray​(java.lang.String str)