SeriesDataset (Payara Project 5.193.1 API)

java.lang.Object
- fish.payara.monitoring.model.SeriesDataset

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConstantDataset, EmptyDataset, PartialDataset
```
public abstract class SeriesDataset
extends Object
implements Serializable
```
A SeriesDataset contains data observed so far for a particular Series.

Author:

Jan Bernitt

See Also:

EmptyDataset, ConstantDataset, StableDataset, PartialDataset, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`SeriesDataset(SeriesDataset predecessor)`
`SeriesDataset(Series series, String instance, long observedSince, int observedValues)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract SeriesDataset`	`add(long time, long value)`
`abstract int`	`capacity()`
`boolean`	`equals(Object obj)`
`abstract int`	`estimatedBytesMemory()`
`abstract long`	`firstTime()`
`String`	`getInstance()`
`BigInteger`	`getObservedAvg()`
`abstract long`	`getObservedMax()`
`abstract long`	`getObservedMin()`
`long`	`getObservedSince()`
`abstract BigInteger`	`getObservedSum()`
`abstract int`	`getObservedValueChanges()` Note that minimum is 1 (changing from unknown to know value).
`int`	`getObservedValues()` The number of times a value was observed since start of collection
`Series`	`getSeries()`
`abstract int`	`getStableCount()`
`abstract long`	`getStableSince()`
`int`	`hashCode()`
`abstract boolean`	`isOutdated()`
`boolean`	`isStable()`
`boolean`	`isStableZero()`
`abstract long`	`lastTime()`
`abstract long`	`lastValue()`
`static long[]`	`perSecond(long[] points)` Converts an array of `points()` to one reflecting the change per second.
`abstract long[]`	`points()` Example:
`abstract int`	`size()`
`String`	`toString()`

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

- Constructor Detail
  - SeriesDataset
```
public SeriesDataset(SeriesDataset predecessor)
```
  - SeriesDataset
```
public SeriesDataset(Series series,
                     String instance,
                     long observedSince,
                     int observedValues)
```
- Method Detail
  - getSeries
```
public final Series getSeries()
```
  - getInstance
```
public String getInstance()
```
  - getObservedAvg
```
public final BigInteger getObservedAvg()
```
  - getObservedSince
```
public long getObservedSince()
```
    Returns:
    
    the time of the first ever value observed by this dataset
  - getObservedValues
```
public final int getObservedValues()
```
    The number of times a value was observed since start of collection
  - getObservedValueChanges
```
public abstract int getObservedValueChanges()
```
    Note that minimum is 1 (changing from unknown to know value). Zero means no values have been observed yet. Note also that change count of 1 does not imply that the value never did change just that such a change was never observed.
    
    Returns:
    
    Number of times the value as altered since it has been monitored.
  - points
```
public abstract long[] points()
```
    Example:
```
 [t0, v0, t1, v1, t2, v2]
 
```
    Returns:
    
    this dataset as flat array with alternating time and value data.
  - add
```
public abstract SeriesDataset add(long time,
                                  long value)
```
  - getObservedMin
```
public abstract long getObservedMin()
```
    Returns:
    
    The smallest value observed so far. If no value was observed Long.MAX_VALUE.
  - getObservedMax
```
public abstract long getObservedMax()
```
    Returns:
    
    The largest value observed so far. If no value was observed Long.MIN_VALUE.
  - getObservedSum
```
public abstract BigInteger getObservedSum()
```
    Returns:
    
    sum of all observed values.
  - getStableSince
```
public abstract long getStableSince()
```
    Returns:
    
    the time of the first value that is still same as lastValue().
  - getStableCount
```
public abstract int getStableCount()
```
    Returns:
    
    the number of recent observed points that all had the same value which is same as lastValue()
  - isOutdated
```
public abstract boolean isOutdated()
```
    Returns:
    
    true in case data sharing with updated sets has caused this set to be outdated. This practically does not happen if the sets are used as intended and usually suggests misuse of a programming mistake.
  - size
```
public abstract int size()
```
    Returns:
    
    the number of actual points in the dataset. This is not the number of observed points but the number of points still known.
  - lastValue
```
public abstract long lastValue()
```
    Returns:
    
    the value of the last of the points()
  - firstTime
```
public abstract long firstTime()
```
    Returns:
    
    the time value of the first of the points()
  - lastTime
```
public abstract long lastTime()
```
    Returns:
    
    the time value of the last of the points()
  - capacity
```
public abstract int capacity()
```
    Returns:
    
    the maximum number of points in a dataset before adding a new point does remove the oldest point
  - estimatedBytesMemory
```
public abstract int estimatedBytesMemory()
```
    Returns:
    
    the estimated memory in bytes used by this dataset. Since the object layout in memory is a JVM internal this is only a rough estimation based on the fields. References are assumed to use 8 bytes. Padding is not included.
  - isStable
```
public boolean isStable()
```
  - isStableZero
```
public boolean isStableZero()
```
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - perSecond
```
public static long[] perSecond(long[] points)
```
    Converts an array of points() to one reflecting the change per second. For each pair of points this is the delta between the earlier and later point of the pair. Since this is a delta the result array contains one less point.
    
    Parameters:
    
    points - point data as returned by points()
    
    Returns:
    
    Points representing the delta or per-second change of the provided input data. The delta is associated with the end point time of each pair.

Class SeriesDataset

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SeriesDataset

SeriesDataset

Method Detail

getSeries

getInstance

getObservedAvg

getObservedSince

getObservedValues

getObservedValueChanges

points

add

getObservedMin

getObservedMax

getObservedSum

getStableSince

getStableCount

isOutdated

size

lastValue

firstTime

lastTime

capacity

estimatedBytesMemory

isStable

isStableZero

toString

equals

hashCode

perSecond