Package org.jipijapa.management.spi
Interface Statistics
public interface Statistics
SPI for statistic plugins to implement.
- Author:
- Scott Marlow
-
Method Summary
Modifier and TypeMethodDescriptionget the specified children statisticsget the names of the children statistic levels (if any)getDynamicChildrenNames(EntityManagerFactoryAccess entityManagerFactoryAccess, PathAddress pathAddress) getNames()Get the statistics namesgets the key prefix for referencing descriptions of statistics/operationsfor loading descriptions of statistics/operationsGet the typegetValue(String name, EntityManagerFactoryAccess entityManagerFactoryAccess, StatisticName statisticName, PathAddress pathAddress) Get the value of the statisticsbooleanisAttribute(String name) return true if the specified name represents an attribute.booleanisOperation(String name) return true if the specified name represents an operation.booleanisWriteable(String name) return true if the specified name represents a writeable attributevoidsetValue(String name, Object newValue, EntityManagerFactoryAccess entityManagerFactoryAccess, StatisticName statisticName, PathAddress pathAddress) Set the value of the statistic (isWriteable must return true)
-
Method Details
-
getNames
Get the statistics names- Returns:
- The value
-
getDynamicChildrenNames
Collection<String> getDynamicChildrenNames(EntityManagerFactoryAccess entityManagerFactoryAccess, PathAddress pathAddress) -
getType
Get the type- Parameters:
name- of the statistic- Returns:
- The value
-
isOperation
return true if the specified name represents an operation.- Parameters:
name- of the statistic- Returns:
-
isAttribute
return true if the specified name represents an attribute.- Parameters:
name- of the statistic- Returns:
-
isWriteable
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
get the names of the children statistic levels (if any)- Returns:
- set of names
-
getChild
get the specified children statistics- Parameters:
childName- name of the statistics to return- Returns:
-