public class

StringRequestKeys

extends CaseInsensitiveRequestKeys
java.lang.Object
   ↳ com.microstrategy.web.beans.GenericRequestKeys
     ↳ com.microstrategy.web.app.beans.CaseInsensitiveRequestKeys
       ↳ com.microstrategy.web.app.StringRequestKeys

Class Overview

The StringRequestKeys class makes available to the application the values of parameters passed on a specified string, with URL format. For example, the format of the string should be like abc=1&def=one&g=false

Summary

Public Constructors
StringRequestKeys()
Constructor.
StringRequestKeys(String urlString, boolean hasTargetReference)
Constructor.
StringRequestKeys(String urlString)
Constructor.
StringRequestKeys(WebEvent webEvent, int eventElements)
Packages the information inside a WebEvent into a RequestKeys object.
Public Methods
void addKey(String key, String value)
Adds parameter into request keys.
void replaceKey(String key, String value, int index)
Replaces parameter value for any existing parameter.
Protected Methods
void initializeRequestKeys()
Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.beans.CaseInsensitiveRequestKeys
From class com.microstrategy.web.beans.GenericRequestKeys
From class java.lang.Object
From interface com.microstrategy.web.beans.RequestKeys

Public Constructors

public StringRequestKeys ()

Constructor. Initializes a new empty instance of the StringRequestKeys class.

public StringRequestKeys (String urlString, boolean hasTargetReference)

Constructor.

Parameters
urlString The URL string contains request parameters.
hasTargetReference A boolean value indicates whether there is target information included in the URL. For example, URL String abc=1&def=one doesn't contain target, but URL String http://localhost/page?abc=1&def=one contains target information. Target will be ingored when building request keys.

public StringRequestKeys (String urlString)

Constructor.

Parameters
urlString The URL string contains request parameters, such as abc=1&def=one.

public StringRequestKeys (WebEvent webEvent, int eventElements)

Packages the information inside a WebEvent into a RequestKeys object.

Parameters
webEvent The event to retrieve information from.
eventElements This parameter is used to control what should be added into request keys, such as event id, soruce, etc. The elements to add to this RequestKeys object. This is a bit-OR of the Event elements defined in EnumEventElement. EnumEventElement.

Public Methods

public void addKey (String key, String value)

Adds parameter into request keys.

Parameters
key The parameter name.
value The parameter value.

public void replaceKey (String key, String value, int index)

Replaces parameter value for any existing parameter.

Parameters
key The name of the parameter.
value The new value of the parameter.
index The position to add the key-value pair.

Protected Methods

protected void initializeRequestKeys ()

Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.