Package org.jrobin.core

Class ArcState

java.lang.Object

org.jrobin.core.ArcState

All Implemented Interfaces:

RrdUpdater

public class ArcState
extends Object
implements RrdUpdater

Class to represent internal RRD archive state for a single datasource. Objects of this class are never manipulated directly, it's up to JRobin framework to manage internal arcihve states.

Author:

Sasa Markovic

Constructor Summary

Constructors

Constructor	Description
ArcState(Archive parentArc, boolean shouldInitialize)

Method Summary

Modifier and Type	Method	Description
(package private) void	appendXml(XmlWriter writer)
void	copyStateTo(RrdUpdater other)	Copies object's internal state to another ArcState object.
(package private) String	dump()
double	getAccumValue()	Returns the value accumulated so far.
long	getNanSteps()	Returns the number of currently accumulated NaN steps.
Archive	getParent()	Returns the Archive object to which this ArcState object belongs.
RrdAllocator	getRrdAllocator()	Required to implement RrdUpdater interface.
RrdBackend	getRrdBackend()	Returns the underlying storage (backend) object which actually performs all I/O operations.
(package private) void	setAccumValue(double value)
(package private) void	setNanSteps(long value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ArcState

ArcState(Archive parentArc,
         boolean shouldInitialize)
  throws IOException

Throws:

IOException

Method Detail

dump

String dump()
     throws IOException

Throws:

IOException

setNanSteps

void setNanSteps(long value)
          throws IOException

Throws:

IOException

getNanSteps

public long getNanSteps()
                 throws IOException

Returns the number of currently accumulated NaN steps.

Returns:

Number of currently accumulated NaN steps.

Throws:

IOException - Thrown in case of I/O error

setAccumValue

void setAccumValue(double value)
            throws IOException

Throws:

IOException

getAccumValue

public double getAccumValue()
                     throws IOException

Returns the value accumulated so far.

Returns:

Accumulated value

Throws:

IOException - Thrown in case of I/O error

getParent

public Archive getParent()

Returns the Archive object to which this ArcState object belongs.

Returns:

Parent Archive object.

appendXml

void appendXml(XmlWriter writer)
        throws IOException

Throws:

IOException

copyStateTo

public void copyStateTo(RrdUpdater other)
                 throws IOException,
                        RrdException

Copies object's internal state to another ArcState object.

Specified by:

copyStateTo in interface RrdUpdater

Parameters:

other - New ArcState object to copy state to

Throws:

IOException - Thrown in case of I/O error

RrdException - Thrown if supplied argument is not an ArcState object

getRrdBackend

public RrdBackend getRrdBackend()

Returns the underlying storage (backend) object which actually performs all I/O operations.

Specified by:

getRrdBackend in interface RrdUpdater

Returns:

I/O backend object

getRrdAllocator

public RrdAllocator getRrdAllocator()

Required to implement RrdUpdater interface. You should never call this method directly.

Specified by:

getRrdAllocator in interface RrdUpdater

Returns:

Allocator object

toString

public String toString()

Overrides:

toString in class Object