com.aquenos.cassandra.pvarchiver.controlsystem

Class SampleWithSizeEstimate<SampleType extends Sample>

java.lang.Object

com.aquenos.cassandra.pvarchiver.controlsystem.SampleWithSizeEstimate<SampleType>

Type Parameters:

SampleType - type of the sample that is stored in this object.

public final class SampleWithSizeEstimate<SampleType extends Sample>
extends Object

Pair of a sample and its estimated size. This class is used when a sample is supposed to be written and thus not only the sample but also its estimated size is needed.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
SampleWithSizeEstimate(SampleType sample, int estimatedSampleSize) Creates a pair that stored the specified sample and estimated size.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getEstimatedSampleSize() Returns the estimated size of the sample that is returned by getSample().
SampleType	getSample() Returns the sample that is supposed to be written.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SampleWithSizeEstimate

public SampleWithSizeEstimate(SampleType sample,
                              int estimatedSampleSize)

Creates a pair that stored the specified sample and estimated size.

Parameters:

sample - sample that is supposed to be written.

estimatedSampleSize - estimated size of the specified sample when serialized into the database (in bytes). This information is used by the archiving code to keep track of the total size of the samples that are stored inside a bucket. As storing too much (or too little) data in a single bucket has an impact on performance, the archiving code will decide to start a new bucket when a certain size has been reached. Therefore, this estimate should be as accurate as possible. Must not be negative.

Throws:

IllegalArgumentException - if estimatedSampleSize is negative.

NullPointerException - if sample is null.

Method Detail

getEstimatedSampleSize

public int getEstimatedSampleSize()

Returns the estimated size of the sample that is returned by getSample(). The size is specified in bytes. This information is used by the archiving code to keep track of the total size of the samples that are stored inside a bucket.

Returns:

estimated size of the sample (always greater than or equal to zero).

getSample

public SampleType getSample()

Returns the sample that is supposed to be written.

Returns:

sample stored in this pair.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object