public class

Archive

extends Object
java.lang.Object
   ↳ org.rrd4j.core.Archive

Class Overview

Class to represent single RRD archive in a RRD with its internal state. Normally, you don't need methods to manipulate archive objects directly because Rrd4j framework does it automatically for you.

Each archive object consists of three parts: archive definition, archive state objects (one state object for each datasource) and round robin archives (one round robin for each datasource). API (read-only) is provided to access each of theese parts.

Summary

Fields
protected final RrdString consolFun
protected final RrdInt rows
protected final RrdInt steps
protected final RrdDouble xff
Public Methods
void copyStateTo(RrdUpdater other)
Copies object's internal state to another Archive object.
ArcState getArcState(int dsIndex)
Returns the underlying archive state object.
long getArcStep()
Returns archive time step in seconds.
ConsolFun getConsolFun()
Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").
long getEndTime()
Returns current ending timestamp.
Robin getRobin(int dsIndex)
Returns the underlying round robin archive.
int getRows()
Returns the number of archive rows.
RrdAllocator getRrdAllocator()
Required to implement RrdUpdater interface.
RrdBackend getRrdBackend()
Returns the underlying storage (backend) object which actually performs all I/O operations.
long getStartTime()
Returns current starting timestamp.
int getSteps()
Returns the number of archive steps.
double getXff()
Returns archive X-files factor.
void setXff(double xff)
Sets X-files factor to a new value.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

protected final RrdString consolFun

protected final RrdInt rows

protected final RrdInt steps

protected final RrdDouble xff

Public Methods

public void copyStateTo (RrdUpdater other)

Copies object's internal state to another Archive object.

Parameters
other New Archive object to copy state to
Throws
IOException Thrown in case of I/O error

public ArcState getArcState (int dsIndex)

Returns the underlying archive state object. Each datasource has its corresponding ArcState object (archive states are managed independently for each RRD datasource).

Parameters
dsIndex Datasource index
Returns
  • Underlying archive state object

public long getArcStep ()

Returns archive time step in seconds. Archive step is equal to RRD step multiplied with the number of archive steps.

Returns
  • Archive time step in seconds
Throws
IOException Thrown in case of I/O error.

public ConsolFun getConsolFun ()

Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").

Returns
  • Archive consolidation function.
Throws
IOException Thrown in case of I/O error.

public long getEndTime ()

Returns current ending timestamp. This value is not constant.

Returns
  • Timestamp corresponding to the last archive row
Throws
IOException Thrown in case of I/O error.

public Robin getRobin (int dsIndex)

Returns the underlying round robin archive. Robins are used to store actual archive values on a per-datasource basis.

Parameters
dsIndex Index of the datasource in the RRD.
Returns
  • Underlying round robin archive for the given datasource.

public int getRows ()

Returns the number of archive rows.

Returns
  • Number of archive rows.
Throws
IOException Thrown in case of I/O error.

public RrdAllocator getRrdAllocator ()

Required to implement RrdUpdater interface. You should never call this method directly.

Returns
  • Allocator object

public RrdBackend getRrdBackend ()

Returns the underlying storage (backend) object which actually performs all I/O operations.

Returns
  • I/O backend object

public long getStartTime ()

Returns current starting timestamp. This value is not constant.

Returns
  • Timestamp corresponding to the first archive row
Throws
IOException Thrown in case of I/O error.

public int getSteps ()

Returns the number of archive steps.

Returns
  • Number of archive steps.
Throws
IOException Thrown in case of I/O error.

public double getXff ()

Returns archive X-files factor.

Returns
  • Archive X-files factor (between 0 and 1).
Throws
IOException Thrown in case of I/O error.

public void setXff (double xff)

Sets X-files factor to a new value.

Parameters
xff New X-files factor value. Must be >= 0 and < 1.
Throws
IOException Thrown in case of I/O error