summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/sparky/analytics/HistoricalCounter.java
blob: 47565acc701903b94a8f18561be8a782dde42561 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/**
 * ============LICENSE_START=======================================================
 * org.onap.aai
 * ================================================================================
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * Copyright © 2017 Amdocs
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 *
 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 */

package org.onap.aai.sparky.analytics;

/**
 * A simple class to model a historical counter. A set of values will be tracked and basic
 * statistics will be calculated in real time (n, min, max, avg).
 * 
 * @author davea
 */
public class HistoricalCounter {

  private double min;

  /**
   * @return the totalOfSamples
   */
  public double getTotalOfSamples() {
    return totalOfSamples;
  }

  /**
   * @param totalOfSamples the totalOfSamples to set
   */
  public void setTotalOfSamples(double totalOfSamples) {
    this.totalOfSamples = totalOfSamples;
  }

  /**
   * @return the maintainSingleValue
   */
  public boolean isMaintainSingleValue() {
    return maintainSingleValue;
  }

  /**
   * @param maintainSingleValue the maintainSingleValue to set
   */
  public void setMaintainSingleValue(boolean maintainSingleValue) {
    this.maintainSingleValue = maintainSingleValue;
  }

  /**
   * @param min the min to set
   */
  public void setMin(double min) {
    this.min = min;
  }

  /**
   * @param max the max to set
   */
  public void setMax(double max) {
    this.max = max;
  }

  /**
   * @param numSamples the numSamples to set
   */
  public void setNumSamples(long numSamples) {
    this.numSamples = numSamples;
  }

  /**
   * @param value the value to set
   */
  public void setValue(double value) {
    this.value = value;
  }

  private double max;

  private double totalOfSamples;

  private long numSamples;

  private double value;

  private boolean maintainSingleValue;

  /**
   * Instantiates a new historical counter.
   *
   * @param trackSingleValue the track single value
   */
  public HistoricalCounter(boolean trackSingleValue) {
    min = -1;
    max = 0;
    totalOfSamples = 0;
    value = 0.0;
    numSamples = 0;
    this.maintainSingleValue = trackSingleValue;
  }

  public boolean isSingleValue() {
    return maintainSingleValue;
  }

  /**
   * Update.
   *
   * @param value the value
   */
  public synchronized void update(double value) {

    if (value < 0) {
      return;
    }

    if (maintainSingleValue) {

      this.value = value;

    } else {

      if (min == -1) {
        min = value;
      }

      if (value < min) {
        min = value;
      }

      if (value > max) {
        max = value;
      }

      totalOfSamples += value;
      numSamples++;
    }
  }

  public double getValue() {
    return value;
  }

  public double getMin() {
    return min;
  }

  public double getMax() {
    return max;
  }

  public long getNumSamples() {
    return numSamples;
  }

  public double getAvg() {
    if (numSamples == 0) {
      return 0;
    }

    return (totalOfSamples / numSamples);
  }

  /**
   * Reset.
   */
  public synchronized void reset() {
    min = -1;
    max = 0;
    numSamples = 0;
    totalOfSamples = 0;
    value = 0.0;
  }

  /* (non-Javadoc)
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder(32);

    if (maintainSingleValue) {
      sb.append("[ Val=").append(value).append(" ]");
    } else {
      sb.append("[ NumSamples=").append(numSamples).append(",");
      sb.append(" Min=").append(min).append(",");
      sb.append(" Max=").append(max).append(",");
      sb.append(" Avg=").append(getAvg()).append(" ]");
    }

    return sb.toString();
  }

}