QDStats (QD Core API 3.342)

java.lang.Object
- com.devexperts.qd.stats.QDStats

```
public class QDStats
extends Object
```
Statistics gathering delegate.
Statistics can be gathered per different type per set of values. Value for stat is calculated as a sum of all its children nodes.
Additionally, special "sum" nodes exist, that aggregate only values for the same type. Sum nodes are used to accumulate values for closed stats and to aggregate similar type stats using "alternative" hierarchy. Sum nodes are created for each type and propagated up to the stat's root. Getting value from the sum node would aggregate only similar type stats and can be more meaningful.
Consider the following stats example:
```
 Any
   Box={name=BigBox}
     Box={name=Box1}
       Apple={name=apple1}
       Orange={name=orange1}
     Box={name=Box2}
       Apple={name=apple2}
       Orange={name=orange2}
     #Apple{sum}
     #Orange{sum}
   #Apple{sum}
   #Orange{sum}
```
In the example above box stats contain 2 other boxes keeping apples and oranges. When getting value from any of the box would aggregate statistics for all fruits. Additionally, sum nodes are created for Apple and Orange types and it is possible to calculate stats only for apples or oranges. Boxes inside a box represent the "same" type hierarchy, so no sum node is needed and if either "Box1" or "box2" would be closed then its stats would be accumulated in the "BigBox".
Use with caution! This API is old and has contradictory contract due to backward compatibility and therefore is subject to change in the future.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`QDStats.StatsLock`
`static class`	`QDStats.SType` Defines specific statistic type, including its name.
`static class`	`QDStats.SValue` Defines specific statistic value, including its name and address.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static QDStats[]`	`EMPTY_CHILDREN`
`static int`	`FLAG_COLLECTION_OF_ANYTHING` Deprecated.
`static int`	`FLAG_COLLECTION_OF_SELF` Deprecated.
`static int`	`FLAG_COUNT`
`static int`	`FLAG_IO`
`static int`	`FLAG_MEM`
`static int`	`FLAG_RID`
`protected static int`	`IO_EXTRA`
`protected static int`	`IO_STRIDE`
`protected static int`	`KIND_ADDED`
`protected static int`	`KIND_CHANGED`
`protected static int`	`KIND_FILTERED`
`protected static int`	`KIND_IO_DATA_READ_LAGS`
`protected static int`	`KIND_IO_DATA_READ_RECORDS`
`protected static int`	`KIND_IO_DATA_WRITE_LAGS`
`protected static int`	`KIND_IO_DATA_WRITE_RECORDS`
`protected static int`	`KIND_IO_READ_BYTES`
`protected static int`	`KIND_IO_READ_RTTS`
`protected static int`	`KIND_IO_SUB_READ_RECORDS`
`protected static int`	`KIND_IO_SUB_WRITE_RECORDS`
`protected static int`	`KIND_IO_WRITE_BYTES`
`protected static int`	`KIND_IO_WRITE_RTTS`
`protected static int`	`KIND_REMOVED`
`protected static int`	`KIND_SIZE`
`protected static int`	`MEM_EXTRA`
`protected static int`	`MEM_STRIDE`
`static QDStats`	`VOID` The instance of QDStats that is always empty.

Constructor Summary

Constructors
Constructor and Description
`QDStats()` Creates uninitialized stats.
`QDStats(QDStats.SType type)` Creates root stats with a given `type`.
`QDStats(QDStats.SType type, DataScheme scheme)` Creates root stats with a given `type` and `scheme`.
`QDStats(String keyProperties)` Creates uninitialized stats with a specified key properties.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected int`	`addChild(QDStats child)`
`protected void`	`addClosedStats(QDStats child)`
`void`	`addMBean(String type, Object mbean)`
`void`	`addValues(QDStats.SValue value, boolean localOnly, long[] dest)`
`void`	`close()`
`protected void`	`closeChildren()`
`protected void`	`closeImpl()`
`protected void`	`closeInternal()`
`protected void`	`closeStats()`
`QDStats`	`create(QDStats.SType type)` Creates and returns new child with the corresponding type.
`QDStats`	`create(QDStats.SType type, String keyProperties)` Creates and returns new child with the corresponding type and key properties.
`QDStats`	`create(QDStats.SType type, String keyProperties, boolean useRid)` Creates and returns new child with the corresponding type, key properties, and an optional per-record tracking of stats.
`protected QDStats`	`createInternal(QDStats.SType type, String keyProperties, boolean isSum, int ridCount, DataScheme scheme)`
`static QDStats`	`createNamedVoid(String keyProperties)` Returns an instance of `QDStats` that does not actually track anything (is always empty like `VOID` but is named).
`QDStats`	`get(QDStats.SType type)` Returns the first found child with the specified type or `null` if not found.
`QDStats`	`get(QDStats.SType type, String keyProperties)` Returns the first found child with the corresponding type and key properties or `null` if not found.
`List<QDStats>`	`getAll(QDStats.SType type)` Returns all children with the corresponding type.
`protected QDStats[]`	`getChildren()`
`String`	`getFullKeyProperties()` Returns full key properties including all parents starting from oldest ones.
`String`	`getKeyProperties()` Returns key properties that are specific to this particular instance of QDStats as they were specified during initialization of this instance.
`protected Object`	`getLock()`
`QDStats`	`getOrCreate(QDStats.SType type)` Returns the first found child with the corresponding type or `creates` new one if not found.
`QDStats`	`getOrCreate(QDStats.SType type, String keyProperties)` Returns the first found child with the corresponding type and key properties or `creates` new one if not found.
`protected QDStats`	`getOrCreateSum(QDStats.SType type)`
`QDStats`	`getOrVoid(QDStats.SType type)` Returns first found child with the corresponding type or `VOID` if not found.
`protected QDStats`	`getParent()`
`int`	`getRidCount()`
`DataScheme`	`getScheme()`
`QDStats.SType`	`getType()` Returns type of this statistics instance.
`long`	`getValue(QDStats.SValue value)`
`long`	`getValue(QDStats.SValue value, boolean localOnly)`
`protected void`	`initChild(QDStats child, QDStats.SType type, String keyProperties, int ridCount, DataScheme scheme)`
`void`	`initRoot(QDStats.SType type, DataScheme scheme)` Initializes root statistics after instantiation using no-arg constructor.
`void`	`initRoot(QDStats.SType type, int ridCount)` Deprecated. Use `initRoot(SType, DataScheme)` instead.
`protected void`	`initStats(QDStats parent, QDStats.StatsLock lock, QDStats.SType type, DataScheme scheme)` Deprecated.
`protected boolean`	`isSum()`
`protected boolean`	`isSumFor(QDStats child)`
`protected QDStats`	`newInstance(QDStats.SType type, boolean unmanaged)`
`static String`	`quoteKeyPropertyValue(String value)` Deprecated. Use `JMXNameBuilder.quoteKeyPropertyValue(String)`
`protected void`	`removeChild(QDStats child, int childIndex)`
`String`	`toDebugString()`
`String`	`toString()`
`void`	`updateAdded(int rid)`
`void`	`updateChanged(int rid)`
`void`	`updateFiltered(int rid)`
`void`	`updateIOReadBytes(long bytes)`
`void`	`updateIOReadDataLags(long sumLag)`
`void`	`updateIOReadDataRecord()`
`void`	`updateIOReadRecordBytes(int rid, long bytes)`
`void`	`updateIOReadRtts(int rtt)`
`void`	`updateIOReadSubRecord()`
`void`	`updateIOWriteBytes(long bytes)`
`void`	`updateIOWriteDataLags(long sumLag)`
`void`	`updateIOWriteDataRecord()`
`void`	`updateIOWriteRecordBytes(int rid, long bytes)`
`void`	`updateIOWriteRtts(int rtt)`
`void`	`updateIOWriteSubRecord()`
`void`	`updateRemoved(int rid)`
`void`	`updateRemoved(int rid, int count)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- EMPTY_CHILDREN
```
protected static final QDStats[] EMPTY_CHILDREN
```
- VOID
```
public static final QDStats VOID
```
  The instance of QDStats that is always empty.
- KIND_ADDED
```
protected static final int KIND_ADDED
```
  See Also:
  
  Constant Field Values
- KIND_CHANGED
```
protected static final int KIND_CHANGED
```
  See Also:
  
  Constant Field Values
- KIND_FILTERED
```
protected static final int KIND_FILTERED
```
  See Also:
  
  Constant Field Values
- KIND_REMOVED
```
protected static final int KIND_REMOVED
```
  See Also:
  
  Constant Field Values
- KIND_SIZE
```
protected static final int KIND_SIZE
```
  See Also:
  
  Constant Field Values
- MEM_EXTRA
```
protected static final int MEM_EXTRA
```
  See Also:
  
  Constant Field Values
- MEM_STRIDE
```
protected static final int MEM_STRIDE
```
  See Also:
  
  Constant Field Values
- KIND_IO_READ_RTTS
```
protected static final int KIND_IO_READ_RTTS
```
  See Also:
  
  Constant Field Values
- KIND_IO_WRITE_RTTS
```
protected static final int KIND_IO_WRITE_RTTS
```
  See Also:
  
  Constant Field Values
- KIND_IO_SUB_READ_RECORDS
```
protected static final int KIND_IO_SUB_READ_RECORDS
```
  See Also:
  
  Constant Field Values
- KIND_IO_SUB_WRITE_RECORDS
```
protected static final int KIND_IO_SUB_WRITE_RECORDS
```
  See Also:
  
  Constant Field Values
- KIND_IO_DATA_READ_RECORDS
```
protected static final int KIND_IO_DATA_READ_RECORDS
```
  See Also:
  
  Constant Field Values
- KIND_IO_DATA_WRITE_RECORDS
```
protected static final int KIND_IO_DATA_WRITE_RECORDS
```
  See Also:
  
  Constant Field Values
- KIND_IO_DATA_READ_LAGS
```
protected static final int KIND_IO_DATA_READ_LAGS
```
  See Also:
  
  Constant Field Values
- KIND_IO_DATA_WRITE_LAGS
```
protected static final int KIND_IO_DATA_WRITE_LAGS
```
  See Also:
  
  Constant Field Values
- KIND_IO_READ_BYTES
```
protected static final int KIND_IO_READ_BYTES
```
  See Also:
  
  Constant Field Values
- KIND_IO_WRITE_BYTES
```
protected static final int KIND_IO_WRITE_BYTES
```
  See Also:
  
  Constant Field Values
- IO_EXTRA
```
protected static final int IO_EXTRA
```
  See Also:
  
  Constant Field Values
- IO_STRIDE
```
protected static final int IO_STRIDE
```
  See Also:
  
  Constant Field Values
- FLAG_MEM
```
public static final int FLAG_MEM
```
  See Also:
  
  Constant Field Values
- FLAG_IO
```
public static final int FLAG_IO
```
  See Also:
  
  Constant Field Values
- FLAG_RID
```
public static final int FLAG_RID
```
  See Also:
  
  Constant Field Values
- FLAG_COLLECTION_OF_ANYTHING
```
@Deprecated
public static final int FLAG_COLLECTION_OF_ANYTHING
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- FLAG_COLLECTION_OF_SELF
```
@Deprecated
public static final int FLAG_COLLECTION_OF_SELF
```
  Deprecated.
  
  See Also:
  
  Constant Field Values
- FLAG_COUNT
```
public static final int FLAG_COUNT
```
  See Also:
  
  Constant Field Values

Constructor Detail
- QDStats
```
public QDStats()
```
  Creates uninitialized stats. initRoot(com.devexperts.qd.stats.QDStats.SType, int) must be called after construction.
- QDStats
```
public QDStats(String keyProperties)
```
  Creates uninitialized stats with a specified key properties. initRoot(com.devexperts.qd.stats.QDStats.SType, int) must be called after construction.
  
  Throws:
  
  IllegalArgumentException - if key properties have invalid format.
- QDStats
```
public QDStats(QDStats.SType type)
```
  Creates root stats with a given type.
- QDStats
```
public QDStats(QDStats.SType type,
               DataScheme scheme)
```
  Creates root stats with a given type and scheme.

Method Detail

createNamedVoid
```
public static QDStats createNamedVoid(String keyProperties)
```
Returns an instance of QDStats that does not actually track anything (is always empty like VOID but is named).

getParent
```
protected QDStats getParent()
```

getLock
```
protected Object getLock()
```

getType
```
public QDStats.SType getType()
```
Returns type of this statistics instance.

getRidCount
```
public int getRidCount()
```

getScheme
```
public DataScheme getScheme()
```

getChildren
```
protected QDStats[] getChildren()
```

getKeyProperties
```
public String getKeyProperties()
```
Returns key properties that are specific to this particular instance of QDStats as they were specified during initialization of this instance. Use getFullKeyProperties() if you need a complete key properties, including properties inherited from parent stats.

getFullKeyProperties
```
public String getFullKeyProperties()
```
Returns full key properties including all parents starting from oldest ones. Returns an empty string if there are no key properties.

isSum
```
protected boolean isSum()
```

isSumFor

protected boolean isSumFor(QDStats child)

initStats

@Deprecated
protected void initStats(QDStats parent,
                                     QDStats.StatsLock lock,
                                     QDStats.SType type,
                                     DataScheme scheme)

Deprecated.

closeStats
```
protected void closeStats()
```

addClosedStats

protected void addClosedStats(QDStats child)

addChild

protected int addChild(QDStats child)

removeChild

protected void removeChild(QDStats child,
                           int childIndex)

closeChildren
```
protected void closeChildren()
```

newInstance

protected QDStats newInstance(QDStats.SType type,
                              boolean unmanaged)

createInternal

protected QDStats createInternal(QDStats.SType type,
                                 String keyProperties,
                                 boolean isSum,
                                 int ridCount,
                                 DataScheme scheme)

getOrCreateSum

protected QDStats getOrCreateSum(QDStats.SType type)

closeInternal
```
protected void closeInternal()
```

initChild

protected void initChild(QDStats child,
                         QDStats.SType type,
                         String keyProperties,
                         int ridCount,
                         DataScheme scheme)

updateIOReadBytes

public final void updateIOReadBytes(long bytes)

updateIOReadRecordBytes

public final void updateIOReadRecordBytes(int rid,
                                          long bytes)

updateIOReadSubRecord

public final void updateIOReadSubRecord()

updateIOReadDataRecord

public final void updateIOReadDataRecord()

updateIOReadRtts

public final void updateIOReadRtts(int rtt)

updateIOReadDataLags

public final void updateIOReadDataLags(long sumLag)

updateIOWriteBytes

public final void updateIOWriteBytes(long bytes)

updateIOWriteRecordBytes

public final void updateIOWriteRecordBytes(int rid,
                                           long bytes)

updateIOWriteSubRecord

public final void updateIOWriteSubRecord()

updateIOWriteDataRecord

public final void updateIOWriteDataRecord()

updateIOWriteRtts

public final void updateIOWriteRtts(int rtt)

updateIOWriteDataLags

public final void updateIOWriteDataLags(long sumLag)

updateAdded

public final void updateAdded(int rid)

updateChanged

public final void updateChanged(int rid)

updateFiltered

public final void updateFiltered(int rid)

updateRemoved

public final void updateRemoved(int rid)

updateRemoved

public final void updateRemoved(int rid,
                                int count)

getValue

public long getValue(QDStats.SValue value)

getValue

public long getValue(QDStats.SValue value,
                     boolean localOnly)

addValues

public void addValues(QDStats.SValue value,
                      boolean localOnly,
                      long[] dest)

initRoot

@Deprecated
public void initRoot(QDStats.SType type,
                                 int ridCount)

Deprecated. Use initRoot(SType, DataScheme) instead.

initRoot

public void initRoot(QDStats.SType type,
                     DataScheme scheme)

Initializes root statistics after instantiation using no-arg constructor.

get
```
public QDStats get(QDStats.SType type)
```
Returns the first found child with the specified type or null if not found.

get

public QDStats get(QDStats.SType type,
                   String keyProperties)

Returns the first found child with the corresponding type and key properties or null if not found.

getAll
```
public List<QDStats> getAll(QDStats.SType type)
```
Returns all children with the corresponding type.

getOrCreate
```
public QDStats getOrCreate(QDStats.SType type)
```
Returns the first found child with the corresponding type or creates new one if not found. The result is VOID for closed or void stats.

getOrCreate
```
public QDStats getOrCreate(QDStats.SType type,
                           String keyProperties)
```
Returns the first found child with the corresponding type and key properties or creates new one if not found. The result is VOID for closed or void stats.

getOrVoid
```
public QDStats getOrVoid(QDStats.SType type)
```
Returns first found child with the corresponding type or VOID if not found.

create
```
public final QDStats create(QDStats.SType type)
```
Creates and returns new child with the corresponding type. The result is VOID for closed or void stats.

create
```
public final QDStats create(QDStats.SType type,
                            String keyProperties)
```
Creates and returns new child with the corresponding type and key properties. This child's stats will inherit per-record stats tracking from parent. The result is VOID for closed or void stats.

Parameters:

type - The type of this stat.

keyProperties - The JMX key=value list of properties for naming of JMX beans (when JMX stats are used).

create
```
public QDStats create(QDStats.SType type,
                      String keyProperties,
                      boolean useRid)
```
Creates and returns new child with the corresponding type, key properties, and an optional per-record tracking of stats. The result is VOID for closed or void stats.

Parameters:

type - The type of this stat.

keyProperties - The JMX key=value list of properties for naming of JMX beans (when JMX stats are used).

useRid - when true, then per-record stats tracking is inherited from parent, when false it is turned off in the created stats and in all its children.

close
```
public void close()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

closeImpl
```
protected void closeImpl()
```

addMBean

public void addMBean(String type,
                     Object mbean)

quoteKeyPropertyValue
```
public static String quoteKeyPropertyValue(String value)
```
Deprecated. Use JMXNameBuilder.quoteKeyPropertyValue(String)

Quotes key property value so that it can be safely used in keyProperties of create(type, keyProperties).

toDebugString
```
public String toDebugString()
```

Class QDStats

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_CHILDREN

VOID

KIND_ADDED

KIND_CHANGED

KIND_FILTERED

KIND_REMOVED

KIND_SIZE

MEM_EXTRA

MEM_STRIDE

KIND_IO_READ_RTTS

KIND_IO_WRITE_RTTS

KIND_IO_SUB_READ_RECORDS

KIND_IO_SUB_WRITE_RECORDS

KIND_IO_DATA_READ_RECORDS

KIND_IO_DATA_WRITE_RECORDS

KIND_IO_DATA_READ_LAGS

KIND_IO_DATA_WRITE_LAGS

KIND_IO_READ_BYTES

KIND_IO_WRITE_BYTES

IO_EXTRA

IO_STRIDE

FLAG_MEM

FLAG_IO

FLAG_RID

FLAG_COLLECTION_OF_ANYTHING

FLAG_COLLECTION_OF_SELF

FLAG_COUNT

Constructor Detail

QDStats

QDStats

QDStats

QDStats

Method Detail

createNamedVoid

getParent

getLock

getType

getRidCount

getScheme

getChildren

getKeyProperties

getFullKeyProperties

isSum

isSumFor

initStats

closeStats

addClosedStats

addChild

removeChild

closeChildren

newInstance

createInternal

getOrCreateSum

closeInternal

initChild

updateIOReadBytes

updateIOReadRecordBytes

updateIOReadSubRecord

updateIOReadDataRecord

updateIOReadRtts

updateIOReadDataLags

updateIOWriteBytes

updateIOWriteRecordBytes

updateIOWriteSubRecord

updateIOWriteDataRecord

updateIOWriteRtts

updateIOWriteDataLags

updateAdded

updateChanged

updateFiltered

updateRemoved

updateRemoved

getValue