gemfire_statistics::StatisticsTypeFactory Class Reference

Inherited by gemfire_statistics::StatisticsFactory.

---

Detailed Description

Instances of this interface provide methods that create instances of StatisticDescriptor and StatisticsType.

Every StatisticsFactory is also a type factory.

A StatisticsTypeFactory can create a statistic of three numeric types: int, long, and double. A statistic (StatisticDescriptor) can either be a gauge meaning that its value can increase and decrease or a counter meaning that its value is strictly increasing. Marking a statistic as a counter allows the GemFire Manager Console to properly display a statistics whose value "wraps around" (that is, exceeds its maximum value).

Public Member Functions
virtual StatisticDescriptor *	createDoubleCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
	Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual StatisticDescriptor *	createDoubleGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
	Creates and returns an double gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual StatisticDescriptor *	createIntCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
	Creates and returns a long counter StatisticDescriptor with the given name, description, units,and with larger values indicating better performance.
virtual StatisticDescriptor *	createIntGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
	Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual StatisticDescriptor *	createLongCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
	Creates and returns a double counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance.
virtual StatisticDescriptor *	createLongGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
	Creates and returns an long gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual StatisticsType *	createType (const char *name, const char *description, StatisticDescriptor **stats, int32 statsLength)=0
	Creates and returns a StatisticsType with the given name, description, and StatisticDescriptor.
virtual StatisticsType *	findType (const char *name)=0
	Finds and returns an already created StatisticsType with the given name.
virtual	~StatisticsTypeFactory ()
	Creates one or more StatisticsType from the contents of the given reader.

---

Constructor & Destructor Documentation

virtual gemfire_statistics::StatisticsTypeFactory::~StatisticsTypeFactory

(

)

[inline, virtual]

Creates one or more StatisticsType from the contents of the given reader.

The created types can be found by calling findType.

Parameters:

reader

The source of the XML data which must comply with the statisticsType.dtd.

Exceptions:

	IllegalArgumentException	if a type defined in the reader already exists
	IOException	Something went wrong while reading from reader

---

Member Function Documentation

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createDoubleCounter	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = true
	)			[pure virtual]

Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createDoubleGauge	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = false
	)			[pure virtual]

Creates and returns an double gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createIntCounter	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = true
	)			[pure virtual]

Creates and returns a long counter StatisticDescriptor with the given name, description, units,and with larger values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createIntGauge	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = false
	)			[pure virtual]

Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createLongCounter	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = true
	)			[pure virtual]

Creates and returns a double counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createLongGauge	(	const char *	name,
		const char *	description,
		const char *	units,
		int8	largerBetter = false
	)			[pure virtual]

Creates and returns an long gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticsType* gemfire_statistics::StatisticsTypeFactory::createType	(	const char *	name,
		const char *	description,
		StatisticDescriptor **	stats,
		int32	statsLength
	)			[pure virtual]

Creates and returns a StatisticsType with the given name, description, and StatisticDescriptor.

Exceptions:

IllegalArgumentException

if a type with the given name already exists.

virtual StatisticsType* gemfire_statistics::StatisticsTypeFactory::findType

(

const char *

name

)

[pure virtual]

Finds and returns an already created StatisticsType with the given name.

Returns null if the type does not exist.

---