Archive (I2P Anonymous Network - Java Documentation

java.lang.Object
- org.jrobin.core.Archive

All Implemented Interfaces:

ConsolFuns, RrdUpdater
```
public class Archive
extends Object
implements RrdUpdater, ConsolFuns
```
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 JRobin 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.

Author:

Sasa Markovic

Field Summary
- Fields inherited from interface org.jrobin.core.ConsolFuns
  CF_AVERAGE, CF_FIRST, CF_LAST, CF_MAX, CF_MIN, CF_TOTAL

Constructor Summary

Constructors
Constructor Description

Archive(RrdDb parentDb, ArcDef arcDef)

Archive(RrdDb parentDb, DataImporter reader, int arcIndex)

Constructors
Constructor	Description
`Archive(RrdDb parentDb, ArcDef arcDef)`
`Archive(RrdDb parentDb, DataImporter reader, int arcIndex)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`(package private) void`	`appendXml(XmlWriter writer)`
`void`	`archive(int dsIndex, double value, long numStepUpdates)`
`void`	`copyStateTo(RrdUpdater other)`	Copies object's internal state to another Archive object.
`(package private) String`	`dump()`
`(package private) FetchData`	`fetchData(FetchRequest request)`
`ArcState`	`getArcState(int dsIndex)`	Returns the underlying archive state object.
`long`	`getArcStep()`	Returns archive time step in seconds.
`String`	`getConsolFun()`	Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").
`long`	`getEndTime()`	Returns current ending timestamp.
`(package private) RrdDb`	`getParentDb()`
`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.
`String`	`toString()`

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

- Constructor Detail
  - Archive
```
Archive(RrdDb parentDb,
        ArcDef arcDef)
 throws IOException
```
    Throws:
    
    IOException
  - Archive
```
Archive(RrdDb parentDb,
        DataImporter reader,
        int arcIndex)
 throws IOException,
        RrdException,
        RrdException
```
    Throws:
    
    IOException
    
    RrdException
- Method Detail
  - getArcStep
```
public long getArcStep()
                throws IOException
```
    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.
  - dump
```
String dump()
     throws IOException
```
    Throws:
    
    IOException
  - getParentDb
```
RrdDb getParentDb()
```
  - archive
```
public void archive(int dsIndex,
                    double value,
                    long numStepUpdates)
             throws IOException
```
    Throws:
    
    IOException
  - getConsolFun
```
public String getConsolFun()
                    throws IOException
```
    Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").
    
    Returns:
    
    Archive consolidation function.
    
    Throws:
    
    IOException - Thrown in case of I/O error.
  - getXff
```
public double getXff()
              throws IOException
```
    Returns archive X-files factor.
    
    Returns:
    
    Archive X-files factor (between 0 and 1).
    
    Throws:
    
    IOException - Thrown in case of I/O error.
  - getSteps
```
public int getSteps()
             throws IOException
```
    Returns the number of archive steps.
    
    Returns:
    
    Number of archive steps.
    
    Throws:
    
    IOException - Thrown in case of I/O error.
  - getRows
```
public int getRows()
            throws IOException
```
    Returns the number of archive rows.
    
    Returns:
    
    Number of archive rows.
    
    Throws:
    
    IOException - Thrown in case of I/O error.
  - getStartTime
```
public long getStartTime()
                  throws IOException
```
    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.
  - getEndTime
```
public long getEndTime()
                throws IOException
```
    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.
  - getArcState
```
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
  - getRobin
```
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.
  - fetchData
```
FetchData fetchData(FetchRequest request)
             throws IOException,
                    RrdException
```
    Throws:
    
    IOException
    
    RrdException
  - appendXml
```
void appendXml(XmlWriter writer)
        throws IOException
```
    Throws:
    
    IOException
  - copyStateTo
```
public void copyStateTo(RrdUpdater other)
                 throws IOException,
                        RrdException
```
    Copies object's internal state to another Archive object.
    
    Specified by:
    
    copyStateTo in interface RrdUpdater
    
    Parameters:
    
    other - New Archive object to copy state to
    
    Throws:
    
    IOException - Thrown in case of I/O error
    
    RrdException - Thrown if supplied argument is not an Archive object
  - setXff
```
public void setXff(double xff)
            throws RrdException,
                   IOException
```
    Sets X-files factor to a new value.
    
    Parameters:
    
    xff - New X-files factor value. Must be >= 0 and < 1.
    
    Throws:
    
    RrdException - Thrown if invalid value is supplied
    
    IOException - Thrown in case of I/O error
  - getRrdBackend
```
public RrdBackend getRrdBackend()
```
    Returns the underlying storage (backend) object which actually performs all I/O operations.
    
    Specified by:
    
    getRrdBackend in interface RrdUpdater
    
    Returns:
    
    I/O backend object
  - getRrdAllocator
```
public RrdAllocator getRrdAllocator()
```
    Required to implement RrdUpdater interface. You should never call this method directly.
    
    Specified by:
    
    getRrdAllocator in interface RrdUpdater
    
    Returns:
    
    Allocator object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Archive

Field Summary

Fields inherited from interface org.jrobin.core.ConsolFuns

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Archive

Archive

Method Detail

getArcStep

dump

getParentDb

archive

getConsolFun

getXff

getSteps

getRows

getStartTime

getEndTime

getArcState

getRobin

fetchData

appendXml

copyStateTo

setXff

getRrdBackend

getRrdAllocator

toString