Package com.microstrategy.web.beans

Class GenericEventHandler.GenericEventKeys

java.lang.Object

com.microstrategy.web.beans.GenericRequestKeys

com.microstrategy.web.beans.GenericEventHandler.GenericEventKeys

All Implemented Interfaces:

RequestKeys

Enclosing class:

GenericEventHandler

public static class GenericEventHandler.GenericEventKeys
extends GenericRequestKeys

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

Since:

MicroStrategy Web 9.0.0

Field Summary

Fields inherited from class com.microstrategy.web.beans.GenericRequestKeys

src

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenericEventKeys(RequestKeys keys, int eventId)

Method Summary

Modifier and Type	Method	Description
protected boolean	canAddKey(java.lang.String name)	This method is called during the initializeRequestKeys() method before adding the keys to the collection.
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.
java.lang.String	getValue(java.lang.String keyName)	Returns from this collection a comma separated string of all the values mapped by the specified keyName.
java.lang.String	getValue(java.lang.String keyName, int valueIndex)	Returns the value at the specified position mapped by the specified keyName.
int	getValueCount(java.lang.String keyName)	Returns from this collection the number of values mapped with the keyName.
java.util.Enumeration	getValueObject(java.lang.String key)	Returns the collection of all the values mapped by the specified keyName.
java.lang.Object	getValueObject(java.lang.String keyName, int valueIndex)	Returns the Object at the specified position mapped by the specified keyName.
protected void	initializeRequestKeys()	Initializes the collection with the values from the Request and/or Session, according to what was specified by the keySpace.

Methods inherited from class com.microstrategy.web.beans.GenericRequestKeys

add, add, addKeyValue, addObject, getAllValues, getDebugOut, getIntValue, getIntValue, getKeyListByPrefix, getName, getNameCount, getObjectAtIndex, getSource, isEmpty, remove, setInitialized, setObjectAtIndex, setSource, setValue, setValueObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericEventKeys

protected GenericEventKeys(RequestKeys keys,
                           int eventId)

Method Detail

getOriginalKeys

protected RequestKeys getOriginalKeys()

Method returns the request keys used for creating this collection.

getEventId

protected int getEventId()

Method returns the event Id used for creating this collection.

getValue

public java.lang.String getValue(java.lang.String keyName)

Description copied from class: GenericRequestKeys

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

Specified by:

getValue in interface RequestKeys

Overrides:

getValue in class GenericRequestKeys

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.

getValueCount

public int getValueCount(java.lang.String keyName)

Description copied from class: GenericRequestKeys

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

Specified by:

getValueCount in interface RequestKeys

Overrides:

getValueCount in class GenericRequestKeys

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.

getValueObject

public java.util.Enumeration getValueObject(java.lang.String key)

Description copied from class: GenericRequestKeys

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

Specified by:

getValueObject in interface RequestKeys

Overrides:

getValueObject in class GenericRequestKeys

Parameters:

key - a key in this collection

Returns:

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

getValue

public java.lang.String getValue(java.lang.String keyName,
                                 int valueIndex)

Description copied from class: GenericRequestKeys

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

Specified by:

getValue in interface RequestKeys

Overrides:

getValue in class GenericRequestKeys

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.

getValueObject

public java.lang.Object getValueObject(java.lang.String keyName,
                                       int valueIndex)

Description copied from class: GenericRequestKeys

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

Specified by:

getValueObject in interface RequestKeys

Overrides:

getValueObject in class GenericRequestKeys

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.

initializeRequestKeys

protected void initializeRequestKeys()

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

Overrides:

initializeRequestKeys in class GenericRequestKeys

canAddKey

protected boolean canAddKey(java.lang.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