org.rrd4j.core.jrrd

Class Archive

java.lang.Object

org.rrd4j.core.jrrd.Archive

public class Archive
extends Object

Instances of this class model an archive section of an RRD file.

Version:

$Revision: 1.1 $

Author:

Ciaran Treanor

Method Summary

Methods

Modifier and Type	Method and Description
CDPStatusBlock	getCDPStatusBlock(int index) Returns the CDPStatusBlock at the specified position in this archive.
Iterator<CDPStatusBlock>	getCDPStatusBlocks() Returns an iterator over the CDP status blocks in this archive in proper sequence.
int	getPdpCount() Returns the number of primary data points required for a consolidated data point in this archive.
int	getRowCount() Returns the number of entries in this archive.
ConsolidationFunctionType	getType() Returns the type of function used to calculate the consolidated data point.
double[][]	getValues() Getter for the field values.
double	getXff() Returns the X-Files Factor for this archive.
String	toString() Returns a summary the contents of this archive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getType

public ConsolidationFunctionType getType()

Returns the type of function used to calculate the consolidated data point.

Returns:

the type of function used to calculate the consolidated data point.

getCDPStatusBlock

public CDPStatusBlock getCDPStatusBlock(int index)

Returns the CDPStatusBlock at the specified position in this archive.

Parameters:

index - index of CDPStatusBlock to return.

Returns:

the CDPStatusBlock at the specified position in this archive.

getCDPStatusBlocks

public Iterator<CDPStatusBlock> getCDPStatusBlocks()

Returns an iterator over the CDP status blocks in this archive in proper sequence.

Returns:

an iterator over the CDP status blocks in this archive in proper sequence.

See Also:

CDPStatusBlock

getValues

public double[][] getValues()
                     throws IOException

Getter for the field values.

Returns:

an array of double.

Throws:

IOException - if any.

getPdpCount

public int getPdpCount()

Returns the number of primary data points required for a consolidated data point in this archive.

Returns:

the number of primary data points required for a consolidated data point in this archive.

getRowCount

public int getRowCount()

Returns the number of entries in this archive.

Returns:

the number of entries in this archive.

getXff

public double getXff()

Returns the X-Files Factor for this archive.

Returns:

the X-Files Factor for this archive.

toString

public String toString()

Returns a summary the contents of this archive.

Overrides:

toString in class Object

Returns:

a summary of the information contained in this archive.