View Javadoc

1   /*
2    * Copyright 2005 the original author or authors.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package net.sf.sensor;
18  
19  import java.util.Set;
20  
21  /***
22   * 
23   * @author Age Mooy
24   */
25  public interface SensorStatistics {
26  
27    /***
28     * Returns the string that uniquely identifies one instance of SensorStatistics.
29     * @return the string that uniquely identifies one instance of SensorStatistics.
30     */
31    public String getId();
32    
33    /***
34     * Returns a Set<String> of all labels associated with an instance of SensorStatistics.
35     * @return a Set<String> of all labels associated with an instance of SensorStatistics.
36     */
37    public Set getLabels();
38    
39    /***
40     * Refresh the statistics from whatever original source they came from.
41     */
42    public void refresh();
43    
44    /***
45     * Resets the statistics to their default values.
46     */
47    public void reset();
48    
49  }