org.opennms.netmgt.rrd.model

Class AbstractRRD

java.lang.Object

org.opennms.netmgt.rrd.model.AbstractRRD

Direct Known Subclasses:

RRDv1, RRDv3

public abstract class AbstractRRD
extends Object

The Abstract RRD (Round Robin Database).

Author:

Alejandro Galue

Constructor Summary

Constructors

Constructor and Description
AbstractRRD()

Method Summary

Modifier and Type	Method and Description
abstract void	addDataSource(AbstractDS ds) Adds the data source.
abstract void	addRRA(AbstractRRA rra) Adds the RRA.
protected abstract AbstractRRD	createRRD() Creates the RRD.
Row	findRowByTimestamp(AbstractRRA rra, Long timestamp) Gets the row that corresponds to a specific time stamp (expressed in seconds since 1970-01-01 UTC).
Long	findTimestampByRow(AbstractRRA rra, Row row) Finds the row time stamp, expressed in seconds since 1970-01-01 UTC.
boolean	formatEquals(AbstractRRD rrd) Format equals.
abstract AbstractDS	getDataSource(int index) Gets the data source.
abstract List<? extends AbstractDS>	getDataSources() Gets the data sources.
Long	getEndTimestamp(AbstractRRA rra) Gets the end time stamp, expressed in seconds since 1970-01-01 UTC.
protected int	getIndex(String dsName) Gets the index.
Long	getLastUpdate() Gets the last update.
AbstractRRA	getMergeableRRA(AbstractRRA rraSrc) Gets the mergeable RRA.
abstract List<? extends AbstractRRA>	getRras() Gets the RRAs.
Long	getStartTimestamp(AbstractRRA rra) Gets the start time stamp, expressed in seconds since 1970-01-01 UTC.
Long	getStep() Gets the step (interval) expressed in seconds.
String	getVersion() Gets the version of the RRD Dump.
boolean	hasEqualsRras(AbstractRRD rrd) Checks for equals RRAs.
boolean	hasMergeableRRAs(AbstractRRD rrdSrc) Checks for mergeable RRAs.
void	merge(AbstractRRD rrdSrc) Merge.
void	merge(List<? extends AbstractRRD> rrdList) Merge.
void	reset() Resets the row values for all the RRAs.
void	setLastUpdate(Long lastUpdate) Sets the last update.
void	setStep(Long step) Sets the step.
void	setVersion(String version) Sets the version.
List<AbstractRRD>	split() Split.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRRD

public AbstractRRD()

Method Detail

createRRD

protected abstract AbstractRRD createRRD()

Creates the RRD.

Returns:

the abstract RRD

getDataSources

public abstract List<? extends AbstractDS> getDataSources()

Gets the data sources.

Returns:

the data sources

getRras

public abstract List<? extends AbstractRRA> getRras()

Gets the RRAs.

Returns:

the RRAs

addRRA

public abstract void addRRA(AbstractRRA rra)

Adds the RRA.

Parameters:

rra - the RRA

addDataSource

public abstract void addDataSource(AbstractDS ds)

Adds the data source.

Parameters:

ds - the DS

getDataSource

public abstract AbstractDS getDataSource(int index)

Gets the data source.

Parameters:

index - the index

Returns:

the data source

getVersion

public String getVersion()

Gets the version of the RRD Dump.

Returns:

the version

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the new version

getStep

public Long getStep()

Gets the step (interval) expressed in seconds.

Returns:

the step

setStep

public void setStep(Long step)

Sets the step.

Parameters:

step - the new step

getLastUpdate

public Long getLastUpdate()

Gets the last update.

Returns:

the last update

setLastUpdate

public void setLastUpdate(Long lastUpdate)

Sets the last update.

Parameters:

lastUpdate - the new last update

getStartTimestamp

public Long getStartTimestamp(AbstractRRA rra)

Gets the start time stamp, expressed in seconds since 1970-01-01 UTC.

Parameters:

rra - the RRA

Returns:

the start time stamp (in seconds)

getEndTimestamp

public Long getEndTimestamp(AbstractRRA rra)

Gets the end time stamp, expressed in seconds since 1970-01-01 UTC.

Parameters:

rra - the RRA

Returns:

the end time stamp (in seconds)

findTimestampByRow

public Long findTimestampByRow(AbstractRRA rra,
                               Row row)

Finds the row time stamp, expressed in seconds since 1970-01-01 UTC.

Parameters:

rra - the RRA object

row - the Row object

Returns:

the long

findRowByTimestamp

public Row findRowByTimestamp(AbstractRRA rra,
                              Long timestamp)

Gets the row that corresponds to a specific time stamp (expressed in seconds since 1970-01-01 UTC).

Parameters:

rra - the RRA

timestamp - the row time stamp

Returns:

the row object

merge

public void merge(AbstractRRD rrdSrc)
           throws IllegalArgumentException

Merge.

Merge the content of rrdSrc into this RRD.

The format must be equal in order to perform the merge operation.

Parameters:

rrdSrc - the RRD source

Throws:

IllegalArgumentException - the illegal argument exception

hasMergeableRRAs

public boolean hasMergeableRRAs(AbstractRRD rrdSrc)

Checks for mergeable RRAs.

Parameters:

rrdSrc - the RRD source

Returns:

true, if there are mergeable RRAs

getMergeableRRA

public AbstractRRA getMergeableRRA(AbstractRRA rraSrc)

Gets the mergeable RRA.

Parameters:

rraSrc - the source RRA

Returns:

the local RRA mergeable with rraSrc

merge

public void merge(List<? extends AbstractRRD> rrdList)
           throws IllegalArgumentException

Merge.

Parameters:

rrdList - the RRD list

Throws:

IllegalArgumentException - the illegal argument exception

split

public List<AbstractRRD> split()
                        throws IllegalArgumentException

Split.

If the RRD contain several data sources, it will return one RRD per DS. Otherwise, it will throw an exception.

Returns:

the RRD list

Throws:

IllegalArgumentException - the illegal argument exception

formatEquals

public boolean formatEquals(AbstractRRD rrd)

Format equals.

Parameters:

rrd - the RRD object

Returns:

true, if successful

hasEqualsRras

public boolean hasEqualsRras(AbstractRRD rrd)

Checks for equals RRAs.

Parameters:

rrd - the RRD object

Returns:

true, if successful

reset

public void reset()

Resets the row values for all the RRAs.

Double.NaN will be stored on each slot

getIndex

protected int getIndex(String dsName)

Gets the index.

Parameters:

dsName - the DS name

Returns:

the index