net.anotheria.moskito.core.decorators.predefined

Class GenericStatsDecorator

java.lang.Object

net.anotheria.moskito.core.decorators.predefined.GenericStatsDecorator

All Implemented Interfaces:

IDecorator<GenericStats>, net.anotheria.util.sorter.IComparable

Direct Known Subclasses:

MBeanDecorator

public class GenericStatsDecorator
extends java.lang.Object
implements IDecorator<GenericStats>

This is a generic stats-decorator implementation - will be used by default for all 'not build-in' stats.

Author:

Michael König

Constructor Summary

Constructors

Constructor and Description
GenericStatsDecorator(java.lang.String name) Constructs an instance of GenericStatsDecorator.

Method Summary

Modifier and Type	Method and Description
void	addCaption(StatCaptionBean captionBean) Add a caption.
void	addCaption(java.lang.String name, java.lang.String type) Add a caption value.
int	compareTo(net.anotheria.util.sorter.IComparable anotherComparable, int method)
java.util.List<StatCaptionBean>	getCaptions() Returns the captions for the stat table.
java.lang.String	getExplanation(java.lang.String caption) Returns an explanation for a caption.
java.lang.String	getName() Returns the name of the decorator.
java.util.List<StatValueAO>	getValues(GenericStats stats, java.lang.String interval, TimeUnit unit) Returns transformed stats for incoming stats object.
boolean	isInitialized() can be used to determine if decorator was initialized already.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericStatsDecorator

public GenericStatsDecorator(java.lang.String name)

Constructs an instance of GenericStatsDecorator.

Method Detail

compareTo

public int compareTo(net.anotheria.util.sorter.IComparable anotherComparable,
                     int method)

Specified by:

compareTo in interface net.anotheria.util.sorter.IComparable

getCaptions

public java.util.List<StatCaptionBean> getCaptions()

Description copied from interface: IDecorator

Returns the captions for the stat table.

Specified by:

getCaptions in interface IDecorator<GenericStats>

Returns:

isInitialized

public boolean isInitialized()

can be used to determine if decorator was initialized already.

Returns:

TRUE | FALSE

addCaption

public void addCaption(StatCaptionBean captionBean)

Add a caption.

Parameters:

captionBean - caption bean to add

addCaption

public void addCaption(java.lang.String name,
                       java.lang.String type)

Add a caption value.

Parameters:

name - the caption

type - short description

getExplanation

public java.lang.String getExplanation(java.lang.String caption)

Description copied from interface: IDecorator

Returns an explanation for a caption. This is used for the explanation help page.

Specified by:

getExplanation in interface IDecorator<GenericStats>

Returns:

getName

public java.lang.String getName()

Description copied from interface: IDecorator

Returns the name of the decorator.

Specified by:

getName in interface IDecorator<GenericStats>

Returns:

getValues

public java.util.List<StatValueAO> getValues(GenericStats stats,
                                             java.lang.String interval,
                                             TimeUnit unit)

Description copied from interface: IDecorator

Returns transformed stats for incoming stats object.

Specified by:

getValues in interface IDecorator<GenericStats>

Parameters:

stats - stats to decorate.

interval - the selected interval.

unit - the selected time unit.

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object