| java.lang.Object | |
| ↳ | com.microstrategy.web.objects.admin.monitors.AbstractInstance |
Class Overview
The AbstractInstance class is a base class which can be subclassed to implement
the Instance Interface. Most usages of the API will not require for the user to create
a subclass of this class.
Summary
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AbstractInstance(AbstractCategory _ownerCategory, String _name, String _helpMessage) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Enumeration |
elements()
Returns a java.util.Enumeration containing the objects in this collection.
| ||||||||||
| Counter |
get(int i)
Returns the
Counter at the given index within the collection. | ||||||||||
| String |
getHelpMessage()
Returns the help message associated with the instance.
| ||||||||||
| Counter |
getItemByName(String name)
Returns the
Counter in the collection with the given name. | ||||||||||
| String |
getLocalizedHelpMessage(Locale locale)
Returns the localized help message associated with this instance.
| ||||||||||
| String |
getLocalizedName(Locale locale)
Returns the localized name of the instance.
| ||||||||||
| String |
getName()
Returns the name of the instance, if one exists.
| ||||||||||
| Category |
getOwnerCategory()
Returns the
Category to which this counter belongs to. | ||||||||||
| boolean |
isEmpty()
Returns whether the collection is empty.
| ||||||||||
| int |
size()
Returns the size of the collection.
| ||||||||||
| String | toString() | ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void | add(Counter c) | ||||||||||
| void | remove(Counter c) | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.microstrategy.web.objects.admin.monitors.Instance
| |||||||||||
Protected Constructors
Public Methods
public Enumeration elements ()
Returns a java.util.Enumeration containing the objects in this collection.
Returns
- An enumeration containing the objects in the collection.
public Counter get (int i)
public String getHelpMessage ()
Returns the help message associated with the instance. The help string is an optional string which describes the instance.
Returns
- The help message associated with the instance.
public Counter getItemByName (String name)
Returns the Counter in the collection with the given name.
Parameters
| name | The name of the counter to return. Note: this is the name, not the localized name of the counter. |
|---|
Returns
- The counter in the collection with the given name.
public String getLocalizedHelpMessage (Locale locale)
Returns the localized help message associated with this instance.
Parameters
| locale | Locale The locale that the help message to localized to. |
|---|
Returns
- String
public String getLocalizedName (Locale locale)
Returns the localized name of the instance.
Parameters
| locale | Locale The locale that the name to be localized to. |
|---|
Returns
- String The localized name of the instance.
public String getName ()
Returns the name of the instance, if one exists.
Returns
- The name of the instance.
public Category getOwnerCategory ()
Returns the Category to which this counter belongs to.
Returns
- The category to which this counter belongs to.
public boolean isEmpty ()
Returns whether the collection is empty.
Returns
- True if the collection is empty, false otherwise.
public int size ()
Returns the size of the collection.
Returns
- The number of counters in the collection.