ControllerStatistics (Carrot2 v3.17.0-SNAPSHOT API Documentation (JavaDoc))

java.lang.Object
- org.carrot2.core.ControllerStatistics

```
public final class ControllerStatistics
extends Object
```
Provides some statistics about processing performed in a Controller.

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`algorithmTimeAverageInWindow` Average clustering time measured within the `algorithmTimeWindowSize`.
`long`	`algorithmTimeMeasurementsInWindow` Number of algorithm time measurements within the `algorithmTimeWindowSize`.
`long`	`algorithmTimeWindowSize` Clustering average time measurement window, in milliseconds.
`Long`	`cacheHitsTotal` Number of requests served from cache.
`Long`	`cacheMisses` Number of requests that generated cache misses.
`long`	`goodQueries` Number of queries handled without an exception.
`double`	`sourceTimeAverageInWindow` Average document source processing time measured within the `sourceTimeWindowSize`.
`long`	`sourceTimeMeasurementsInWindow` Number of document source processing time measurements within the `sourceTimeWindowSize`.
`long`	`sourceTimeWindowSize` Document source average processing time measurement window, in milliseconds.
`long`	`totalQueries` Total number of queries handled, including queries resulting in an exception.
`double`	`totalTimeAverageInWindow` Average total processing time measured within the `totalTimeWindowSize`.
`long`	`totalTimeMeasurementsInWindow` Number of total processing time measurements within the `totalTimeWindowSize`.
`long`	`totalTimeWindowSize` Total average processing time measurement window, in milliseconds.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void serialize(OutputStream stream)
Serializes this statistics object as XML stream.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`serialize(OutputStream stream)` Serializes this statistics object as XML stream.

- Field Detail
  - totalQueries
```
public final long totalQueries
```
    Total number of queries handled, including queries resulting in an exception.
  - goodQueries
```
public final long goodQueries
```
    Number of queries handled without an exception.
  - algorithmTimeAverageInWindow
```
public final double algorithmTimeAverageInWindow
```
    Average clustering time measured within the algorithmTimeWindowSize.
  - algorithmTimeMeasurementsInWindow
```
public final long algorithmTimeMeasurementsInWindow
```
    Number of algorithm time measurements within the algorithmTimeWindowSize.
  - algorithmTimeWindowSize
```
public final long algorithmTimeWindowSize
```
    Clustering average time measurement window, in milliseconds.
  - sourceTimeAverageInWindow
```
public final double sourceTimeAverageInWindow
```
    Average document source processing time measured within the sourceTimeWindowSize.
  - sourceTimeMeasurementsInWindow
```
public final long sourceTimeMeasurementsInWindow
```
    Number of document source processing time measurements within the sourceTimeWindowSize.
  - sourceTimeWindowSize
```
public final long sourceTimeWindowSize
```
    Document source average processing time measurement window, in milliseconds.
  - totalTimeAverageInWindow
```
public final double totalTimeAverageInWindow
```
    Average total processing time measured within the totalTimeWindowSize.
  - totalTimeMeasurementsInWindow
```
public final long totalTimeMeasurementsInWindow
```
    Number of total processing time measurements within the totalTimeWindowSize.
  - totalTimeWindowSize
```
public final long totalTimeWindowSize
```
    Total average processing time measurement window, in milliseconds.
  - cacheMisses
```
public final Long cacheMisses
```
    Number of requests that generated cache misses. May be null if the controller does not perform caching.
  - cacheHitsTotal
```
public final Long cacheHitsTotal
```
    Number of requests served from cache. May be null if the controller does not perform caching.
- Method Detail
  - serialize
```
public void serialize(OutputStream stream)
               throws Exception
```
    Serializes this statistics object as XML stream.
    
    Throws:
    
    Exception

Class ControllerStatistics

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

totalQueries

goodQueries

algorithmTimeAverageInWindow

algorithmTimeMeasurementsInWindow

algorithmTimeWindowSize

sourceTimeAverageInWindow

sourceTimeMeasurementsInWindow

sourceTimeWindowSize

totalTimeAverageInWindow

totalTimeMeasurementsInWindow

totalTimeWindowSize

cacheMisses

cacheHitsTotal

Method Detail

serialize