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

[Expand]

Inherited Fields

From class com.microstrategy.web.beans.GenericRequestKeys

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.
Source	getSource(String key) Determines where a given request key was sourced from.
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

String	add(String key, String value) Appends a value to a collection mapped by the key specified.
String	add(String key, String value, String delimiter) Appends a value to a collection mapped by the key specified.
LinkedList	addKeyValue(String key, Object value) Adds an Object to the collection defined by the key.
Object	addObject(String key, Object value) Appends an Object to a collection mapped by the key specified.
LinkedList	getAllValues(String keyName) Retrieves all values associated with the key.
MarkupOutput	getDebugOut() Get the Debug Information into the output
int	getIntValue(String keyName, int valueIndex) Parses the value of given request key to an integer.
int	getIntValue(String keyName, int valueIndex, int defaultValue) Parses the value of given request key to an integer.
Enumeration	getKeyListByPrefix(String prefix) Returns an enumeration over all the keys with the specified prefix.
String	getName(int nameIndex) Returns the key at the specified position from the current collection.
int	getNameCount() Returns the total number of keys stored in the collection.
Object	getObjectAtIndex(String keyName, int valueIndex) Retrieves the Object located at a specific index within the collection defined by keyName.
Source	getSource(String key) Determines where a given request key was sourced from.
String	getValue(String keyName) Returns from this collection a comma separated string of all the values mapped by the specified `keyName`.
String	getValue(String keyName, int valueIndex) Returns the value at the specified position mapped by the specified `keyName`.
int	getValueCount(String keyName) Returns from this collection the number of values mapped with the `keyName`.
Object	getValueObject(String keyName, int valueIndex) Returns the Object at the specified position mapped by the specified `keyName`.
Enumeration	getValueObject(String key) Returns the collection of all the values mapped by the specified `keyName`.
void	initializeRequestKeys() Initializes the key-value collection from various sources.
boolean	isEmpty() Returns whether the value collection is empty.
void	remove(String key) Removes the argument with the given key.
void	setInitialized(boolean initialized) Sets a flag indicating whether this collection has been initialized.
void	setObjectAtIndex(String key, Object value, int index) Used by setValue and setValueObject to do the actual work.
void	setSource(String key, Source source)
void	setValue(String key, String value, int index) Replaces the value at a specific index for a given key.
void	setValueObject(String key, Object value, int index) Replaces the Object at a specific index for a given key.
String	toString()

From class java.lang.Object

From interface com.microstrategy.web.beans.RequestKeys

abstract String	add(String key, String value) Adds a key/value pair to this collection.
abstract Object	addObject(String key, Object value) Adds a key/value pair to this collection.
abstract MarkupOutput	getDebugOut() Get the Debug Information into the output
abstract int	getIntValue(String key, int index) Parses the value of given request key to an integer.
abstract int	getIntValue(String keyName, int valueIndex, int defaultValue) Parses the value of given request key to an integer.
abstract Enumeration	getKeyListByPrefix(String prefix) Returns an enumeration over all the keys with the specified prefix.
abstract String	getName(int nameIndex) Returns the name at the specified index from the current collection.
abstract int	getNameCount() Returns the number of names stored in the current collection.
abstract Source	getSource(String key) Determines where a given request key was sourced from.
abstract String	getValue(String keyName) Returns from this collection a comma separated string of all the values mapped by the specified `keyName`.
abstract String	getValue(String keyName, int valueIndex) Returns at the specified index the value from the collection mapped by the specified keyName.
abstract int	getValueCount(String keyName) Returns the number of values from the collection mapped by the specified keyName.
abstract Object	getValueObject(String key, int index) Returns at the specified index the value from the collection mapped by the specified key.
abstract Enumeration	getValueObject(String key) Returns from this collection a list of all the objects mapped by the specified `key`.
abstract boolean	isEmpty() Returns a boolean value indicating whether the current collection is empty
abstract void	remove(String key) Removes the argument with the given key.
abstract void	setValue(String key, String value, int index) Replaces the value at a specific index for a given key.
abstract void	setValueObject(String key, Object value, int index) Replaces the Object at a specific index for a given key.

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 Source getSource (String key)

Determines where a given request key was sourced from.

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.

Interfaces

Classes

Exceptions

StringRequestKeys

Class Overview

Summary

Public Constructors

public StringRequestKeys ()

public StringRequestKeys (String urlString, boolean hasTargetReference)

Parameters

public StringRequestKeys (String urlString)

Parameters

public StringRequestKeys (WebEvent webEvent, int eventElements)

Parameters

Public Methods

public void addKey (String key, String value)

Parameters

public Source getSource (String key)

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

Parameters

Protected Methods

protected void initializeRequestKeys ()