Package org.jipijapa.management.spi

Interface Statistics

public interface Statistics

SPI for statistic plugins to implement.

Author:

Scott Marlow

Method Summary

Modifier and Type	Method	Description
Statistics	getChild(String childName)	get the specified children statistics
Set<String>	getChildrenNames()	get the names of the children statistic levels (if any)
Collection<String>	getDynamicChildrenNames(EntityManagerFactoryAccess entityManagerFactoryAccess, PathAddress pathAddress)
Set<String>	getNames()	Get the statistics names
String	getResourceBundleKeyPrefix()	gets the key prefix for referencing descriptions of statistics/operations
String	getResourceBundleName()	for loading descriptions of statistics/operations
Class	getType(String name)	Get the type
Object	getValue(String name, EntityManagerFactoryAccess entityManagerFactoryAccess, StatisticName statisticName, PathAddress pathAddress)	Get the value of the statistics
boolean	isAttribute(String name)	return true if the specified name represents an attribute.
boolean	isOperation(String name)	return true if the specified name represents an operation.
boolean	isWriteable(String name)	return true if the specified name represents a writeable attribute
void	setValue(String name, Object newValue, EntityManagerFactoryAccess entityManagerFactoryAccess, StatisticName statisticName, PathAddress pathAddress)	Set the value of the statistic (isWriteable must return true)

Method Detail

getNames

Set<String> getNames()

Get the statistics names

Returns:

The value

getDynamicChildrenNames

Collection<String> getDynamicChildrenNames(EntityManagerFactoryAccess entityManagerFactoryAccess,
                                           PathAddress pathAddress)

getType

Class getType(String name)

Get the type

Parameters:

name - of the statistic

Returns:

The value

isOperation

boolean isOperation(String name)

return true if the specified name represents an operation.

Parameters:

name - of the statistic

Returns:

isAttribute

boolean isAttribute(String name)

return true if the specified name represents an attribute.

Parameters:

name - of the statistic

Returns:

isWriteable

boolean isWriteable(String name)

return true if the specified name represents a writeable attribute

Parameters:

name - of the statistics

Returns:

getResourceBundleName

String getResourceBundleName()

for loading descriptions of statistics/operations

Returns:

name of resource bundle name

getResourceBundleKeyPrefix

String getResourceBundleKeyPrefix()

gets the key prefix for referencing descriptions of statistics/operations

Returns:

getValue

Object getValue(String name,
                EntityManagerFactoryAccess entityManagerFactoryAccess,
                StatisticName statisticName,
                PathAddress pathAddress)

Get the value of the statistics

Parameters:

name - The name of the statistics

Returns:

The value

setValue

void setValue(String name,
              Object newValue,
              EntityManagerFactoryAccess entityManagerFactoryAccess,
              StatisticName statisticName,
              PathAddress pathAddress)

Set the value of the statistic (isWriteable must return true)

Parameters:

name -

newValue -

getChildrenNames

Set<String> getChildrenNames()

get the names of the children statistic levels (if any)

Returns:

set of names

getChild

Statistics getChild(String childName)

get the specified children statistics

Parameters:

childName - name of the statistics to return

Returns: