com.sssw.rts.adminapi
Class AgoAdmStatInfo

java.lang.Object
 |
 +--com.sssw.rts.adminapi.AgoAdmStatInfo

All Implemented Interfaces:

Serializable

public class AgoAdmStatInfo

extends Object

implements Serializable

Objects of this class describe a particular statistic. A statistic is uniquely defined by its name and the element for which this statistic is available. Other attributes of a statistic are its kind and description.

See Also:

Serialized Form

Field Summary

static int	KIND_COUNTER The "counter" statistic kind.
static int	KIND_DURATION The "duration" statistic kind (a delta or elapsed time)
static int	KIND_STATIC The "static" statistic kind (a constant value)
static int	KIND_TIME The "time" statistic kind (an absolute time).
static int	KIND_VALUE The "value" statistic kind, e.g.

Constructor Summary

AgoAdmStatInfo()

Method Summary

String	getDescription() Get the description of the statistic.
String	getItemSubtype() Get the subtype of the item for which this stat info is intended.
int	getKind() Get the kind of the statistic.
String	getName() Get the name of the statistic.
String	getOwnerPath() Get the owner statistic element's path.
String	getSummaryString() Return a string summary of the stat info that contains the name, kind, description, and owner path.
void	setItemSubtype(String subtype) Set the subtype of the item for which this stat info is intended.

Methods inherited from class java.lang.Object

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

Field Detail

KIND_COUNTER

public static final int KIND_COUNTER

The "counter" statistic kind.

KIND_VALUE

public static final int KIND_VALUE

The "value" statistic kind, e.g. a minimum or a maximum

KIND_TIME

public static final int KIND_TIME

The "time" statistic kind (an absolute time).

KIND_DURATION

public static final int KIND_DURATION

The "duration" statistic kind (a delta or elapsed time)

KIND_STATIC

public static final int KIND_STATIC

The "static" statistic kind (a constant value)

Constructor Detail

AgoAdmStatInfo

public AgoAdmStatInfo()

Method Detail

getName

public String getName()

Get the name of the statistic.

getDescription

public String getDescription()

Get the description of the statistic.

getKind

public int getKind()

Get the kind of the statistic.

getOwnerPath

public String getOwnerPath()

Get the owner statistic element's path.

See Also:

AgiAdmStatElement

getItemSubtype

public String getItemSubtype()

Get the subtype of the item for which this stat info is intended.

Usage:

The item subtype may be null, meaning no subtype.

See Also:

AgiAdmStatContainer.getChildSubtypes(), AgiAdmStatContainer.getChildren(int, java.lang.String subtype)

setItemSubtype

public void setItemSubtype(String subtype)

Set the subtype of the item for which this stat info is intended.

Parameters:

subtype - the subtype

See Also:

AgiAdmStatContainer.getChildSubtypes(), AgiAdmStatContainer.getChildren(int, java.lang.String subtype)

getSummaryString

public String getSummaryString()

Return a string summary of the stat info that contains the name, kind, description, and owner path.

Returns:

String the summary