public class

RRDatabase

extends Object
java.lang.Object
   ↳ org.rrd4j.core.jrrd.RRDatabase

Class Overview

Instances of this class model Round Robin Database (RRD) files.

Summary

Public Constructors
RRDatabase(String name)
Creates a database to read from.
RRDatabase(File file)
Creates a database to read from.
Public Methods
void close()
Closes this database stream and releases any associated system resources.
Archive getArchive(int index)
Returns the Archive at the specified position in this database.
Iterator<Archive> getArchives(ConsolidationFunctionType type)
Returns an iterator over the archives in this database of the given type in proper sequence.
Iterator<Archive> getArchives()
Returns an iterator over the archives in this database in proper sequence.
DataChunk getData(ConsolidationFunctionType type)
Returns data from the database corresponding to the given consolidation function and a step size of 1.
DataChunk getData(ConsolidationFunctionType type, long step)
Returns data from the database corresponding to the given consolidation function.
DataSource getDataSource(int index)
Returns the DataSource at the specified position in this database.
Iterator<DataSource> getDataSources()
Returns an iterator over the data sources in this database in proper sequence.
Header getHeader()
Returns the Header for this database.
Date getLastUpdate()
Returns the date this database was last updated.
int getNumArchives()
Returns the number of archives in this database.
void printInfo(PrintStream s)
Outputs the header information of the database to the given print stream using the default number format.
void printInfo(PrintStream s, NumberFormat numberFormat)
Outputs the header information of the database to the given print stream using the given number format.
String toString()
Returns a summary the contents of this database.
void toXml(PrintStream s)
Outputs the content of the database to the given print stream as a stream of XML.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public RRDatabase (String name)

Creates a database to read from.

Parameters
name the filename of the file to read from.
Throws
IOException if an I/O error occurs.

public RRDatabase (File file)

Creates a database to read from.

Parameters
file the file to read from.
Throws
IOException if an I/O error occurs.

Public Methods

public void close ()

Closes this database stream and releases any associated system resources.

Throws
IOException if an I/O error occurs.

public Archive getArchive (int index)

Returns the Archive at the specified position in this database.

Parameters
index index of Archive to return.
Returns
  • the Archive at the specified position in this database.

public Iterator<Archive> getArchives (ConsolidationFunctionType type)

Returns an iterator over the archives in this database of the given type in proper sequence.

Parameters
type the consolidation function that should have been applied to the data.
Returns
  • an iterator over the archives in this database of the given type in proper sequence.

public Iterator<Archive> getArchives ()

Returns an iterator over the archives in this database in proper sequence.

Returns
  • an iterator over the archives in this database in proper sequence.

public DataChunk getData (ConsolidationFunctionType type)

Returns data from the database corresponding to the given consolidation function and a step size of 1.

Parameters
type the consolidation function that should have been applied to the data.
Returns
  • the raw data.
Throws
IllegalArgumentException if there was a problem locating a data archive with the requested consolidation function.
IOException if there was a problem reading data from the database.

public DataChunk getData (ConsolidationFunctionType type, long step)

Returns data from the database corresponding to the given consolidation function.

Parameters
type the consolidation function that should have been applied to the data.
step the step size to use.
Returns
  • the raw data.
Throws
IllegalArgumentException if there was a problem locating a data archive with the requested consolidation function.
IOException if there was a problem reading data from the database.

public DataSource getDataSource (int index)

Returns the DataSource at the specified position in this database.

Parameters
index index of DataSource to return.
Returns
  • the DataSource at the specified position in this database

public Iterator<DataSource> getDataSources ()

Returns an iterator over the data sources in this database in proper sequence.

Returns
  • an iterator over the data sources in this database in proper sequence.

public Header getHeader ()

Returns the Header for this database.

Returns
  • the Header for this database.

public Date getLastUpdate ()

Returns the date this database was last updated. To convert this date to the form returned by rrdtool last call Date.getTime() and divide the result by 1000.

Returns
  • the date this database was last updated.

public int getNumArchives ()

Returns the number of archives in this database.

Returns
  • the number of archives in this database.

public void printInfo (PrintStream s)

Outputs the header information of the database to the given print stream using the default number format. The default format for double is 0.0000000000E0.

Parameters
s the PrintStream to print the header information to.

public void printInfo (PrintStream s, NumberFormat numberFormat)

Outputs the header information of the database to the given print stream using the given number format. The format is almost identical to that produced by rrdtool info

Parameters
s the PrintStream to print the header information to.
numberFormat the format to print doubles as.

public String toString ()

Returns a summary the contents of this database.

Returns
  • a summary of the information contained in this database.

public void toXml (PrintStream s)

Outputs the content of the database to the given print stream as a stream of XML. The XML format is almost identical to that produced by rrdtool dump

Parameters
s the PrintStream to send the XML to.