public interface

ContainerStringCollection

com.microstrategy.web.platform.ContainerStringCollection
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract String getName(int index)
This returns a name at a specific numeric index in this collection.
abstract int getNameCount()
This returns the number of unique names (keys) in this collection.
abstract String getStringValue(String name, int index)
This returns a specific string value associated with a given name (key) in this collection.
abstract String getStringValue(String name)
This returns a the first string value associated with a given name (key) in this collection.
abstract int getStringValueCount(String name)
This returns the number of string values associated with a given name (key) in this collection.
abstract Object getValue(String name)
This returns a value associated with a given name (key) in this collection.

Public Methods

public abstract 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.

public abstract int getNameCount ()

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

Returns
  • An int representing the count of unique names.

public abstract String getStringValue (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(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.

public abstract String getStringValue (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.

public abstract int getStringValueCount (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.

public abstract Object getValue (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.