oracle.adf.share.perf

Class StateTracker

java.lang.Object

oracle.adf.share.logging.internal.perf.ADFPerfSensor

oracle.adf.share.perf.StateTracker

Direct Known Subclasses:

StateTrackerImpl

public abstract class StateTracker
extends ADFPerfSensor

This class is a wrapper of DMS State sensor. It encapsulates sensor group name(Noun) and sensor name.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	DOUBLE
static StateTracker	DUMMY_STATE_TRACKER An empty state tracker.
static byte	INTEGER
static byte	LONG
static byte	OBJECT

Fields inherited from class oracle.adf.share.logging.internal.perf.ADFPerfSensor

LAZY_NOUN_TYPE, mEnableDms, mEnablePerfLog, mIndex, mLevel, mSensorFullName, sIdxLogger, sLogger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StateTracker() Creates an empty StateTracker object.
protected	StateTracker(java.util.logging.Level level, java.lang.String sensorFullName) Create a StateTracker object identified by the sensorFullName.

Method Summary

Modifier and Type	Method and Description
static StateTracker	createStateTracker(java.util.logging.Level level, java.lang.String groupName, java.lang.String name, byte valueType, java.lang.String unit, java.lang.String desc) Deprecated. see overloads with the type param
static StateTracker	createStateTracker(java.util.logging.Level level, java.lang.String groupName, java.lang.String name, java.lang.String type, byte valueType, java.lang.String unit, java.lang.String desc) Create a Counter object identified by the groupName and the name.
static StateTracker	createStateTracker(java.util.logging.Level level, java.lang.String groupName, java.lang.String name, java.lang.String type, byte valueType, java.lang.String unit, java.lang.String desc, oracle.dms.instrument.SegregationType sgType) Deprecated. see AdfServerPlatformSupport::createStateTracker
protected abstract java.lang.Object	getClonedValue() access DMS state tracker current value object.
void	increment(double increasedAmount) Add increasedAmount to the value of the state.
void	increment(int increasedAmount) Add increasedAmount to the value of the state.
void	increment(long increasedAmount) Add increasedAmount to the value of the state.
void	update(double newValue) Update the value of the State.
void	update(int newValue) Update the value of the State.
void	update(long newValue) Update the value of the State.
void	update(java.lang.Object newValue) Update the value of the State.

Methods inherited from class oracle.adf.share.logging.internal.perf.ADFPerfSensor

destroy, isActive, log, reset, toString

Methods inherited from class java.lang.Object

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

Field Detail

DOUBLE

public static final byte DOUBLE

INTEGER

public static final byte INTEGER

LONG

public static final byte LONG

OBJECT

public static final byte OBJECT

DUMMY_STATE_TRACKER

public static final StateTracker DUMMY_STATE_TRACKER

An empty state tracker. Allows client code to be written in a generic way without knowing whether the code is executing in the IDE or in a deployed application.

Constructor Detail

StateTracker

protected StateTracker(java.util.logging.Level level,
                       java.lang.String sensorFullName)

Create a StateTracker object identified by the sensorFullName.

Internally, this method creates a DMS State sensor.

The DMS State sensor has following metrics: value, count, minValue, maxValue.

Parameters:

level - one of the message level identifiers, e.g. SEVERE

sensorFullName - the sensor full name, which is a container of related sensors that cover certain aspect of a feature.

StateTracker

protected StateTracker()

Creates an empty StateTracker object.

Method Detail

getClonedValue

protected abstract java.lang.Object getClonedValue()

access DMS state tracker current value object. This method is mainly for internal adf-share-base use and tests

Returns:

value object of current state tracker

increment

public void increment(double increasedAmount)

Add increasedAmount to the value of the state.

Parameters:

increasedAmount - the new value to add to the current value of the State.

increment

public void increment(int increasedAmount)

Add increasedAmount to the value of the state.

Parameters:

increasedAmount - the new value to add to the current value of the State.

increment

public void increment(long increasedAmount)

Add increasedAmount to the value of the state.

Parameters:

increasedAmount - the new value to add to the current value of the State.

update

public void update(double newValue)

Update the value of the State.

Parameters:

newValue - the new value for the State.

update

public void update(int newValue)

Update the value of the State.

Parameters:

newValue - the new value for the State.

update

public void update(long newValue)

Update the value of the State.

Parameters:

newValue - the new value for the State.

update

public void update(java.lang.Object newValue)

Update the value of the State.

Parameters:

newValue - the new value for the State.

createStateTracker

@Deprecated
public static StateTracker createStateTracker(java.util.logging.Level level,
                                                          java.lang.String groupName,
                                                          java.lang.String name,
                                                          byte valueType,
                                                          java.lang.String unit,
                                                          java.lang.String desc)

Deprecated. see overloads with the type param

Create a Counter object identified by the groupName and the name.

Developers should then call Counter's increment(), update() methods to track the state object.

Internally, this method creates a DMS Event sensor.

When called inside the IDE, always returns DUMMY_STATE_TRACKER.

Parameters:

level - one of the message level identifiers, e.g. SEVERE

groupName - the group name, which has the format of /oracle/component_id/module/subModule/... The component_id is also used as StateTracker type

name - the stateTracker name.

valueType - the type of data to be maintained in this State, which must be one of DOUBLE, LONG, INTEGER, or OBJECT.

unit - the label for the units of the value.

desc - the description for this StateTracker.

Returns:

StateTracker the new StateTracker object

createStateTracker

public static StateTracker createStateTracker(java.util.logging.Level level,
                                              java.lang.String groupName,
                                              java.lang.String name,
                                              java.lang.String type,
                                              byte valueType,
                                              java.lang.String unit,
                                              java.lang.String desc)

Create a Counter object identified by the groupName and the name.

Developers should then call Counter's increment(), update() methods to track the state object.

Internally, this method creates a DMS Event sensor.

When called inside the IDE, always returns DUMMY_STATE_TRACKER.

Parameters:

level - one of the message level identifiers, e.g. SEVERE

groupName - the group name, which has the format of /oracle/component_id/module/subModule/...

name - the stateTracker name.

type - the stateTracker type which collects all sensors with same type and display them together in a table in AggreSpy

valueType - the type of data to be maintained in this State, which must be one of DOUBLE, LONG, INTEGER, or OBJECT.

unit - the label for the units of the value.

desc - the description for this StateTracker.

Returns:

StateTracker the new StateTracker object

createStateTracker

@Deprecated
public static StateTracker createStateTracker(java.util.logging.Level level,
                                                          java.lang.String groupName,
                                                          java.lang.String name,
                                                          java.lang.String type,
                                                          byte valueType,
                                                          java.lang.String unit,
                                                          java.lang.String desc,
                                                          oracle.dms.instrument.SegregationType sgType)

Deprecated. see AdfServerPlatformSupport::createStateTracker