Summary: Protected Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public static class

GenericEventHandler.GenericEventKeys

extends GenericRequestKeys

java.lang.Object
↳	com.microstrategy.web.beans.GenericRequestKeys
	↳	com.microstrategy.web.beans.GenericEventHandler.GenericEventKeys

Class Overview

This inner class is an implementation of the request keys specific for an event. The collection contains the keys for a particular event.

Summary

Protected Constructors
	GenericEventHandler.GenericEventKeys(RequestKeys keys, int eventId)

Public Methods
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`.

Protected Methods
boolean	canAddKey(String name) This method is called during the `initializeRequestKeys()` method before adding the keys to the collection.
int	getEventId() Method returns the event Id used for creating this collection.
RequestKeys	getOriginalKeys() Method returns the request keys used for creating this collection.
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.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, int defaultValue) Parses the value of given request key to an integer.
int	getIntValue(String keyName, int valueIndex) 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.
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	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 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.

Protected Constructors

protected GenericEventHandler.GenericEventKeys (RequestKeys keys, int eventId)

Public Methods

public String getValue (String keyName)

Returns from this collection a comma separated string of all the values mapped by the specified keyName.

Parameters

keyName	a key in this collection

Returns

all the values mapped to the keyName, separated by the character comma; null if the key does not exist.

public String getValue (String keyName, int valueIndex)

Returns the value at the specified position mapped by the specified keyName.

Parameters

keyName	a key in this collection
valueIndex	the index of a value mapped to the key specified

Returns

the value at the specified position mapped by the specified key; null if the key does not exist.

public int getValueCount (String keyName)

Returns from this collection the number of values mapped with the keyName.

Parameters

keyName	a key to a value collection

Returns

the count of values to which the specified key is mapped in this collection; 0 if the key is not found.

public Object getValueObject (String keyName, int valueIndex)

Returns the Object at the specified position mapped by the specified keyName.

Parameters

keyName	a key in this collection
valueIndex	the index of an Object mapped to the key specified

Returns

the Object at the specified position mapped by the specified key; null if the key does not exist.

public Enumeration getValueObject (String key)

Returns the collection of all the values mapped by the specified keyName.

Parameters

key	a key in this collection

Returns

all the values mapped to the keyName; null if the key does not exist.

Protected Methods

protected boolean canAddKey (String name)

This method is called during the initializeRequestKeys() method before adding the keys to the collection.

Parameters

name	- key name to check

Returns

true if the key

protected int getEventId ()

Method returns the event Id used for creating this collection.

protected RequestKeys getOriginalKeys ()

Method returns the request keys used for creating this collection.

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

GenericEventHandler.GenericEventKeys

Class Overview

Summary

Protected Constructors

protected GenericEventHandler.GenericEventKeys (RequestKeys keys, int eventId)

Public Methods

public String getValue (String keyName)

Parameters

Returns

public String getValue (String keyName, int valueIndex)

Parameters

Returns

public int getValueCount (String keyName)

Parameters

Returns

public Object getValueObject (String keyName, int valueIndex)

Parameters

Returns

public Enumeration getValueObject (String key)

Parameters

Returns

Protected Methods

protected boolean canAddKey (String name)

Parameters

Returns

protected int getEventId ()

protected RequestKeys getOriginalKeys ()

protected void initializeRequestKeys ()