Package org.rrd4j.core
Class Archive
java.lang.Object
org.rrd4j.core.Archive
- All Implemented Interfaces:
RrdUpdater<Archive>
Class to represent single RRD archive in a RRD with its internal state.
Normally, you don't need methods to manipulate archive objects directly
because Rrd4j framework does it automatically for you.
Each archive object consists of three parts: archive definition, archive state objects (one state object for each datasource) and round robin archives (one round robin for each datasource). API (read-only) is provided to access each of these parts.
- Author:
- Sasa Markovic
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription(package private) void
(package private) void
archive
(int dsIndex, double value, long numUpdates) void
copyStateTo
(Archive arc) copyStateTo.(package private) String
dump()
(package private) FetchData
fetchData
(FetchRequest request) getArcState
(int dsIndex) Returns the underlying archive state object.long
Returns archive time step in seconds.Returns archive consolidation function ("AVERAGE", "MIN", "MAX", "FIRST", "LAST" or "TOTAL").long
Returns current ending timestamp.(package private) RrdDb
getRobin
(int dsIndex) Returns the underlying round robin archive.int
getRows()
Returns the number of archive rows.Required to implement RrdUpdater interface.Returns the underlying storage (backend) object which actually performs all I/O operations.long
Returns current starting timestamp.int
getSteps()
Returns the number of archive steps.double
getXff()
Returns archive X-files factor.void
setXff
(double xff) Sets X-files factor to a new value.
-
Field Details
-
xff
-
steps
-
rows
-
-
Constructor Details
-
Archive
Archive(RrdDb parentDb, ArcDef arcDef) throws IOException - Throws:
IOException
-
Archive
Archive(RrdDb parentDb, DataImporter reader, int arcIndex) throws IOException - Throws:
IOException
-
-
Method Details
-
getArcStep
Returns archive time step in seconds. Archive step is equal to RRD step multiplied with the number of archive steps.- Returns:
- Archive time step in seconds
- Throws:
IOException
- Thrown in case of I/O error.
-
dump
- Throws:
IOException
-
getParentDb
RrdDb getParentDb() -
archive
- Throws:
IOException
-
getConsolFun
Returns archive consolidation function ("AVERAGE", "MIN", "MAX", "FIRST", "LAST" or "TOTAL").- Returns:
- Archive consolidation function.
- Throws:
IOException
- Thrown in case of I/O error.
-
getXff
Returns archive X-files factor.- Returns:
- Archive X-files factor (between 0 and 1).
- Throws:
IOException
- Thrown in case of I/O error.
-
getSteps
Returns the number of archive steps.- Returns:
- Number of archive steps.
- Throws:
IOException
- Thrown in case of I/O error.
-
getRows
Returns the number of archive rows.- Returns:
- Number of archive rows.
- Throws:
IOException
- Thrown in case of I/O error.
-
getStartTime
Returns current starting timestamp. This value is not constant.- Returns:
- Timestamp corresponding to the first archive row
- Throws:
IOException
- Thrown in case of I/O error.
-
getEndTime
Returns current ending timestamp. This value is not constant.- Returns:
- Timestamp corresponding to the last archive row
- Throws:
IOException
- Thrown in case of I/O error.
-
getArcState
Returns the underlying archive state object. Each datasource has its corresponding ArcState object (archive states are managed independently for each RRD datasource).- Parameters:
dsIndex
- Datasource index- Returns:
- Underlying archive state object
-
getRobin
Returns the underlying round robin archive. Robins are used to store actual archive values on a per-datasource basis.- Parameters:
dsIndex
- Index of the datasource in the RRD.- Returns:
- Underlying round robin archive for the given datasource.
-
fetchData
- Throws:
IOException
-
appendXml
- Throws:
IOException
-
copyStateTo
copyStateTo.
Copies object's internal state to another Archive object.- Specified by:
copyStateTo
in interfaceRrdUpdater<Archive>
- Parameters:
arc
- aRrdUpdater
object.- Throws:
IOException
- if any.
-
setXff
Sets X-files factor to a new value.- Parameters:
xff
- New X-files factor value. Must be >= 0 and < 1.- Throws:
IOException
- Thrown in case of I/O error
-
getRrdBackend
Returns the underlying storage (backend) object which actually performs all I/O operations.- Specified by:
getRrdBackend
in interfaceRrdUpdater<Archive>
- Returns:
- I/O backend object
-
getRrdAllocator
Required to implement RrdUpdater interface. You should never call this method directly.- Specified by:
getRrdAllocator
in interfaceRrdUpdater<Archive>
- Returns:
- Allocator object
-