summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/persistent/PageFileStatistics.java
blob: df3de61226a8d209ecb226fc0a69aa55e9c5cd8b (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
package de.lmu.ifi.dbs.elki.persistent;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2012
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


/**
 * Statistics API for a Page File.
 * 
 * See {@link PageFileUtil} for related utility functions for analysing this
 * data!
 * 
 * @author Erich Schubert
 */
public interface PageFileStatistics {
  /**
   * Returns the read I/O-Accesses of this file.
   * 
   * @return Number of physical read I/O accesses
   */
  public long getReadOperations();

  /**
   * Returns the write I/O-Accesses of this file.
   * 
   * @return Number of physical write I/O accesses
   */
  public long getWriteOperations();

  /**
   * Resets the counters for page accesses of this file and flushes the cache.
   */
  public void resetPageAccess();

  /**
   * Get statistics for the inner page file, if present.
   * 
   * @return Inner page file statistics, or null.
   */
  public PageFileStatistics getInnerStatistics();
}