Package org.rrd4j.core.jrrd

Class Header

java.lang.Object

org.rrd4j.core.jrrd.Header

All Implemented Interfaces:

Constants

public class Header
extends Object
implements Constants

Instances of this class model the header section of an RRD file.

Version:

$Revision: 1.1 $

Author:

Ciaran Treanor

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	dsCount	Number of data sources
(package private) final int	pdpStep
(package private) final int	rraCount	Number of archives within file
(package private) final String	version

Fields inherited from interface org.rrd4j.core.jrrd.Constants

CF_NAM_SIZE, COOKIE, DS_NAM_SIZE, DST_SIZE, LAST_DS_LEN, MAX_SUPPORTED_VERSION, SIZE_OF_DOUBLE, UNDEFINED_VERSION, UNDEFINED_VERSION_AS_INT, VERSION_WITH_LAST_UPDATE_SEC

Constructor Summary

Constructors

Constructor	Description
Header(RRDFile file)

Method Summary

Modifier and Type	Method	Description
int	getDSCount()	Returns the number of DataSources in the database.
int	getPDPStep()	Returns the primary data point interval in seconds.
int	getRRACount()	Returns the number of Archives in the database.
String	getVersion()	Returns the version of the database.
int	getVersionAsInt()	Returns the version of the database as an integer.
String	toString()	Returns a summary the contents of this header.

Methods inherited from class java.lang.Object

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

Field Details

version

final String version

dsCount

final int dsCount

Number of data sources

rraCount

final int rraCount

Number of archives within file

pdpStep

final int pdpStep

Constructor Details

Header

Header(RRDFile file)
throws IOException

Throws:

IOException

Method Details

getVersion

public String getVersion()

Returns the version of the database.

Returns:

the version of the database.

getVersionAsInt

public int getVersionAsInt()

Returns the version of the database as an integer.

Returns:

the version of the database.

getDSCount

public int getDSCount()

Returns the number of DataSources in the database.

Returns:

the number of DataSources in the database.

getRRACount

public int getRRACount()

Returns the number of Archives in the database.

Returns:

the number of Archives in the database.

getPDPStep

public int getPDPStep()

Returns the primary data point interval in seconds.

Returns:

the primary data point interval in seconds.

toString

public String toString()

Returns a summary the contents of this header.

Overrides:

toString in class Object

Returns:

a summary of the information contained in this header.