org.rrd4j.core.jrrd
Class Header

java.lang.Object
  org.rrd4j.core.jrrd.Header

public class Header
extends Object

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

Version:

$Revision: 1.1 $

Author:

Ciaran Treanor

Field Summary

static int	CF_NAM_SIZE
static String	COOKIE
static int	DS_NAM_SIZE
static int	DST_SIZE
static byte[]	FLOAT_COOKIE_BIG_ENDIAN
static byte[]	FLOAT_COOKIE_LITTLE_ENDIAN
static int	LAST_DS_LEN
static int	MAX_SUPPORTED_VERSION
static String	UNDEFINED_VERSION
static int	UNDEFINED_VERSION_AS_INT
static int	VERSION_WITH_LAST_UPDATE_SEC

Method Summary

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 Detail

DS_NAM_SIZE

public static final int DS_NAM_SIZE

See Also:

Constant Field Values

DST_SIZE

public static final int DST_SIZE

See Also:

Constant Field Values

CF_NAM_SIZE

public static final int CF_NAM_SIZE

See Also:

Constant Field Values

LAST_DS_LEN

public static final int LAST_DS_LEN

See Also:

Constant Field Values

COOKIE

public static final String COOKIE

See Also:

Constant Field Values

MAX_SUPPORTED_VERSION

public static final int MAX_SUPPORTED_VERSION

See Also:

Constant Field Values

UNDEFINED_VERSION

public static final String UNDEFINED_VERSION

See Also:

Constant Field Values

UNDEFINED_VERSION_AS_INT

public static final int UNDEFINED_VERSION_AS_INT

See Also:

Constant Field Values

VERSION_WITH_LAST_UPDATE_SEC

public static final int VERSION_WITH_LAST_UPDATE_SEC

See Also:

Constant Field Values

FLOAT_COOKIE_BIG_ENDIAN

public static final byte[] FLOAT_COOKIE_BIG_ENDIAN

FLOAT_COOKIE_LITTLE_ENDIAN

public static final byte[] FLOAT_COOKIE_LITTLE_ENDIAN

Method Detail

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.