Package com.microstrategy.web.objects.admin.monitors

Class AbstractCategory

java.lang.Object

com.microstrategy.web.objects.admin.monitors.AbstractCategory

All Implemented Interfaces:

Category

public abstract class AbstractCategory
extends java.lang.Object
implements Category

The AbstractCategory class is a base class which can be subclassed to implement the Category Interface. Most usages of the API will not require for the user to create a subclass of this class.

Since:

MicroStrategy Web 7.5.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCategory(java.lang.String _name, java.lang.String _helpMessage)

Method Summary

Modifier and Type	Method	Description
protected void	add(Instance inst)
java.util.Enumeration	elements()	Returns a java.util.Enumeration object containing the objects in the collection.
Instance	get(int i)	Returns the Instance object at the given index in the collection.
java.lang.String	getHelpMessage()	Returns the help message associated with the Category.
Instance	getItemByName(java.lang.String name)	Searches the collection for an Instance with the given name.
java.lang.String	getLocalizedHelpMessage(java.util.Locale locale)
java.lang.String	getLocalizedName(java.util.Locale locale)
java.lang.String	getName()	Returns the name of the Category.
boolean	isEmpty()	Returns whether the collection is empty.
protected void	remove(Instance inst)
int	size()	Returns the number of items in the collection.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microstrategy.web.objects.admin.monitors.Category

getLocalizedHelpMessage, getLocalizedName

Constructor Detail

AbstractCategory

protected AbstractCategory(java.lang.String _name,
                           java.lang.String _helpMessage)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Category

Returns the name of the Category.

Specified by:

getName in interface Category

Returns:

The name of the Category.

get

public Instance get(int i)

Description copied from interface: Category

Returns the Instance object at the given index in the collection.

Specified by:

get in interface Category

Parameters:

i - The index of the item to retrieve.

Returns:

The Instance object at the given index.

getItemByName

public Instance getItemByName(java.lang.String name)

Description copied from interface: Category

Searches the collection for an Instance with the given name.

Specified by:

getItemByName in interface Category

Parameters:

name - The name of the Instance to return.

Returns:

An Instance object with the given name.

size

public int size()

Description copied from interface: Category

Returns the number of items in the collection.

Specified by:

size in interface Category

Returns:

The number of items in the collection.

isEmpty

public boolean isEmpty()

Description copied from interface: Category

Returns whether the collection is empty.

Specified by:

isEmpty in interface Category

Returns:

True if the collection is empty, false otherwise.

elements

public java.util.Enumeration elements()

Description copied from interface: Category

Returns a java.util.Enumeration object containing the objects in the collection.

Specified by:

elements in interface Category

Returns:

An Enumeration containing the objects in this collection.

add

protected void add(Instance inst)

remove

protected void remove(Instance inst)

getHelpMessage

public java.lang.String getHelpMessage()

Description copied from interface: Category

Returns the help message associated with the Category. The help message is a longer description of the counter.

Specified by:

getHelpMessage in interface Category

Returns:

The help message of the Category, if one exists.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLocalizedName

public java.lang.String getLocalizedName(java.util.Locale locale)

getLocalizedHelpMessage

public java.lang.String getLocalizedHelpMessage(java.util.Locale locale)