public abstract class

GeoRequestBase

extends Object
java.lang.Object
   ↳ com.microstrategy.web.app.maps.GeoRequestBase
Known Direct Subclasses

Class Overview

Request object contains all the parsed query parameters, including query target type, query fields, and basic utility functions.

Summary

Constants
String HIERARCHY_SEPERATOR
String ITEM_SPLITTER
String QUERY_BY_ALIAS
String QUERY_BY_ID
String QUERY_BY_NAME
Fields
protected String lookupKey
protected String queryField
protected String targetType
Public Methods
String getLookupKey()
String getQueryField()
String getTargetType()
static boolean matchesQueryField(String queryField, String expectingField)
Find out the whether the given query field string matches an expected field.
List<String> queryFieldHierarchy()
Protected Methods
static List<Integer> splitString2IntegerArray(String str)
static List<String> splitString2StringArray(String str)
The function splits the query field hierarchy string into a list of integers.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String HIERARCHY_SEPERATOR

Constant Value: ":"

public static final String ITEM_SPLITTER

Constant Value: ";"

public static final String QUERY_BY_ALIAS

Constant Value: "abbr"

public static final String QUERY_BY_ID

Constant Value: "id"

public static final String QUERY_BY_NAME

Constant Value: "name"

Fields

protected String lookupKey

protected String queryField

protected String targetType

Public Methods

public String getLookupKey ()

public String getQueryField ()

public String getTargetType ()

public static boolean matchesQueryField (String queryField, 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.

public List<String> queryFieldHierarchy ()

Protected Methods

protected static List<Integer> splitString2IntegerArray (String str)

protected static List<String> splitString2StringArray (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.