Package com.microstrategy.web.platform

Interface ContainerStringCollection

All Known Implementing Classes:

AbstractConfigurableContainerServices.AbstractContainerStringCollection

public interface ContainerStringCollection

This is a generic collection of string data which came from a Web Container. It may house a set of Query String parameters, Form Data, Cookies, Session Variables, etc.

Since:

MicroStrategy Web 7.3.1 or earlier

See Also:

ContainerServices

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName(int index)	This returns a name at a specific numeric index in this collection.
int	getNameCount()	This returns the number of unique names (keys) in this collection.
Source	getSource()
java.lang.String	getStringValue(java.lang.String name)	This returns a the first string value associated with a given name (key) in this collection.
java.lang.String	getStringValue(java.lang.String name, int index)	This returns a specific string value associated with a given name (key) in this collection.
int	getStringValueCount(java.lang.String name)	This returns the number of string values associated with a given name (key) in this collection.
java.lang.Object	getValue(java.lang.String name)	This returns a value associated with a given name (key) in this collection.

Method Detail

getNameCount

int getNameCount()

This returns the number of unique names (keys) in this collection.

Returns:

An int representing the count of unique names.

getName

java.lang.String getName(int index)

This returns a name at a specific numeric index in this collection.

Parameters:

index - An int representing the index of the name to return.

Returns:

The String representing the name at this index.

getStringValueCount

int getStringValueCount(java.lang.String name)

This returns the number of string values associated with a given name (key) in this collection. For most collections (such as the Query String collection, the Form Data collection and the Cookie collection), all values are represented as strings. However, for the Session collection, many of the values are not Strings and do not contribute to this count.

Parameters:

name - A String representing the name of the key in this collection.

Returns:

An int representing the count of values.

getStringValue

java.lang.String getStringValue(java.lang.String name)

This returns a the first string value associated with a given name (key) in this collection.

Parameters:

name - A String representing the name of the key in this collection.

Returns:

A String representing the value of the first string.

getStringValue

java.lang.String getStringValue(java.lang.String name,
                                int index)

This returns a specific string value associated with a given name (key) in this collection. Valid indices range from 0 to 1 less than the value returned by getStringValueCount(java.lang.String).

Parameters:

name - A String representing the name of the key in this collection.

index - An int representing the specific value to retrieve.

Returns:

A String representing the value at that index.

getValue

java.lang.Object getValue(java.lang.String name)

This returns a value associated with a given name (key) in this collection.

Parameters:

name - A String representing the name of the key in this collection.

Returns:

A Object representing the value for the given name.

getSource

Source getSource()

Returns:

Source of the strings.