Archive (I2P Anonymous Network - Java Documentation

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

すべての実装されたインタフェース:

ConsolFuns, RrdUpdater
```
public class Archive
extends java.lang.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.

作成者:

Sasa Markovic

フィールドの概要
- インタフェースから継承されたフィールド org.jrobin.core.ConsolFuns
  CF_AVERAGE, CF_FIRST, CF_LAST, CF_MAX, CF_MIN, CF_TOTAL

コンストラクタの概要

コンストラクタ
コンストラクタ説明

Archive(RrdDb parentDb, ArcDef arcDef)

Archive(RrdDb parentDb, DataImporter reader, int arcIndex)

コンストラクタ
コンストラクタ	説明
`Archive(RrdDb parentDb, ArcDef arcDef)`
`Archive(RrdDb parentDb, DataImporter reader, int arcIndex)`

メソッドの概要

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`(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) java.lang.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.
`java.lang.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.
`java.lang.String`	`toString()`

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - Archive
```
Archive(RrdDb parentDb,
        ArcDef arcDef)
 throws java.io.IOException
```
    例外:
    
    java.io.IOException
  - Archive
```
Archive(RrdDb parentDb,
        DataImporter reader,
        int arcIndex)
 throws java.io.IOException,
        RrdException,
        RrdException
```
    例外:
    
    java.io.IOException
    
    RrdException
- メソッドの詳細
  - getArcStep
```
public long getArcStep()
                throws java.io.IOException
```
    Returns archive time step in seconds. Archive step is equal to RRD step multiplied with the number of archive steps.
    
    戻り値:
    
    Archive time step in seconds
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - dump
```
java.lang.String dump()
               throws java.io.IOException
```
    例外:
    
    java.io.IOException
  - getParentDb
```
RrdDb getParentDb()
```
  - archive
```
public void archive(int dsIndex,
                    double value,
                    long numStepUpdates)
             throws java.io.IOException
```
    例外:
    
    java.io.IOException
  - getConsolFun
```
public java.lang.String getConsolFun()
                              throws java.io.IOException
```
    Returns archive consolidation function ("AVERAGE", "MIN", "MAX" or "LAST").
    
    戻り値:
    
    Archive consolidation function.
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - getXff
```
public double getXff()
              throws java.io.IOException
```
    Returns archive X-files factor.
    
    戻り値:
    
    Archive X-files factor (between 0 and 1).
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - getSteps
```
public int getSteps()
             throws java.io.IOException
```
    Returns the number of archive steps.
    
    戻り値:
    
    Number of archive steps.
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - getRows
```
public int getRows()
            throws java.io.IOException
```
    Returns the number of archive rows.
    
    戻り値:
    
    Number of archive rows.
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - getStartTime
```
public long getStartTime()
                  throws java.io.IOException
```
    Returns current starting timestamp. This value is not constant.
    
    戻り値:
    
    Timestamp corresponding to the first archive row
    
    例外:
    
    java.io.IOException - Thrown in case of I/O error.
  - getEndTime
```
public long getEndTime()
                throws java.io.IOException
```
    Returns current ending timestamp. This value is not constant.
    
    戻り値:
    
    Timestamp corresponding to the last archive row
    
    例外:
    
    java.io.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).
    
    パラメータ:
    
    dsIndex - Datasource index
    
    戻り値:
    
    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.
    
    パラメータ:
    
    dsIndex - Index of the datasource in the RRD.
    
    戻り値:
    
    Underlying round robin archive for the given datasource.
  - fetchData
```
FetchData fetchData(FetchRequest request)
             throws java.io.IOException,
                    RrdException
```
    例外:
    
    java.io.IOException
    
    RrdException
  - appendXml
```
void appendXml(XmlWriter writer)
        throws java.io.IOException
```
    例外:
    
    java.io.IOException
  - copyStateTo
```
public void copyStateTo(RrdUpdater other)
                 throws java.io.IOException,
                        RrdException
```
    Copies object's internal state to another Archive object.
    
    定義:
    
    copyStateTo インタフェース内 RrdUpdater
    
    パラメータ:
    
    other - New Archive object to copy state to
    
    例外:
    
    java.io.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,
                   java.io.IOException
```
    Sets X-files factor to a new value.
    
    パラメータ:
    
    xff - New X-files factor value. Must be >= 0 and < 1.
    
    例外:
    
    RrdException - Thrown if invalid value is supplied
    
    java.io.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.
    
    定義:
    
    getRrdBackend インタフェース内 RrdUpdater
    
    戻り値:
    
    I/O backend object
  - getRrdAllocator
```
public RrdAllocator getRrdAllocator()
```
    Required to implement RrdUpdater interface. You should never call this method directly.
    
    定義:
    
    getRrdAllocator インタフェース内 RrdUpdater
    
    戻り値:
    
    Allocator object
  - toString
```
public java.lang.String toString()
```
    オーバーライド:
    
    toString クラス内 java.lang.Object

クラス Archive

フィールドの概要

インタフェースから継承されたフィールド org.jrobin.core.ConsolFuns

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

Archive

Archive

メソッドの詳細

getArcStep

dump

getParentDb

archive

getConsolFun

getXff

getSteps

getRows

getStartTime

getEndTime

getArcState

getRobin

fetchData

appendXml

copyStateTo

setXff

getRrdBackend

getRrdAllocator

toString