graphana.model

Class Histogram

java.lang.Object

graphana.model.Histogram

public class Histogram
extends java.lang.Object

Contains a mapping from integral numbers to float numbers.

Constructor Summary

Constructors

Constructor and Description
Histogram() Creates an instance with an initial size of 10
Histogram(int initialSize) The constructor of Histogram.
Histogram(java.lang.String csv, java.lang.String separator) Creates a Histogram and uses the CSV string as preface.

Method Summary

Modifier and Type	Method and Description
void	createFromString(java.lang.String string, java.lang.String separator) Converts the given CSV-string into a histogram.
float	getFirstValueIndex() Returns the smallest index that contains a non-zero value
int	getFirstValueIndexUnscaled() Returns the smallest index that contains a non-zero value without taking the x-scale into account
java.lang.String	getKeyHeading() Returns the key heading of the CSV output.
int	getMaxIndex() Returns the largest index with an explicit value.
float	getMaxValue() Returns the maximum value of all entries.
float	getValue(float index) Returns the value at the given index.
int	getValueCount() Returns the current amount of allocated values.
java.lang.String	getValueHeading() Returns the value heading of the CSV output.
float	getValueUnscaled(int index) Same as getValue, but does not multiply the given index with the x-scale factor.
int	getXScale()
void	incValue(float index) Increments the value at the given index by 1.
void	incValue(float index, java.lang.Float value) Increments the value at the given index by the given value.
void	setCsvValueListMode(boolean csvValueListMode) Specifies whether the toString method shall return the string representation as a CSV string or as a simple list without indices.
void	setDefaultSeparator(java.lang.String separator) Sets the default key-value-separator for CSV output.
void	setHeadingLine(java.lang.String keyHeading, java.lang.String valueHeading) Sets the first line of the CSV output.
void	setIntOutput() After calling this method, the CSV output will output the values without fractional digits.
void	setValue(float index, java.lang.Float value) Sets the value at the given index.
Histogram	setXScale(int scale) Sets the x-scale.
java.lang.String	toCSV() Returns the histogram in its CSV representation with the default separator.
java.lang.String	toCSV(java.lang.String separator) Returns the histogram in its CSV representation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Histogram

public Histogram(java.lang.String csv,
                 java.lang.String separator)
          throws java.lang.NumberFormatException

Creates a Histogram and uses the CSV string as preface.

Parameters:

csv - A string which contains integral numbers in the first column and float numbers as the second

separator - the separator of a key-value-pair.

Throws:

java.lang.NumberFormatException

Histogram

public Histogram(int initialSize)

The constructor of Histogram.

Parameters:

initialSize - Determines the initial number of allocated indices. However, this is not the capacity. New indices are allocated automatically if it is necessary.

Histogram

public Histogram()

Creates an instance with an initial size of 10

Method Detail

setHeadingLine

public void setHeadingLine(java.lang.String keyHeading,
                           java.lang.String valueHeading)

Sets the first line of the CSV output. If null is given, then the CSV output will not have a heading line.

Parameters:

keyHeading - the first column of the heading.

valueHeading - the second column of the heading.

setIntOutput

public void setIntOutput()

After calling this method, the CSV output will output the values without fractional digits.

setDefaultSeparator

public void setDefaultSeparator(java.lang.String separator)

Sets the default key-value-separator for CSV output. String separator the separator to set.

getKeyHeading

public java.lang.String getKeyHeading()

Returns the key heading of the CSV output.

Returns:

the key heading of the CSV output.

getValueHeading

public java.lang.String getValueHeading()

Returns the value heading of the CSV output.

Returns:

the value heading of the CSV output.

setCsvValueListMode

public void setCsvValueListMode(boolean csvValueListMode)

Specifies whether the toString method shall return the string representation as a CSV string or as a simple list without indices.

Parameters:

csvValueListMode - The value list mode

getValueCount

public int getValueCount()

Returns the current amount of allocated values. This is not the maximum capacity. The value count automatically increases whenever the value count is exceeded.

Returns:

The current value count

getValue

public float getValue(float index)

Returns the value at the given index.

Parameters:

index - The index to read

Returns:

The respective value or 0, if the given index is smaller than 0 or bigger or equal than the value count

getValueUnscaled

public float getValueUnscaled(int index)

Same as getValue, but does not multiply the given index with the x-scale factor.

setValue

public void setValue(float index,
                     java.lang.Float value)

Sets the value at the given index.

Parameters:

index - The index of the entry which shall be set

value - The new value

incValue

public void incValue(float index,
                     java.lang.Float value)

Increments the value at the given index by the given value.

Parameters:

index - The index of the entry which shall be set

value - The value which shall be added (may be negative, too).

incValue

public void incValue(float index)

Increments the value at the given index by 1.

Parameters:

index - The index of the entry of which the value is supposed to be incremented

toCSV

public java.lang.String toCSV(java.lang.String separator)

Returns the histogram in its CSV representation.

Returns:

the histogram as CSV string.

toCSV

public java.lang.String toCSV()

Returns the histogram in its CSV representation with the default separator.

Returns:

the histogram as CSV string.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createFromString

public void createFromString(java.lang.String string,
                             java.lang.String separator)
                      throws java.lang.NumberFormatException

Converts the given CSV-string into a histogram.

Parameters:

string - a string which contains integral numbers in the first column and float numbers as the second.

separator - the separator for a key-value-pair.

Throws:

java.lang.NumberFormatException

getMaxValue

public float getMaxValue()

Returns the maximum value of all entries.

Returns:

the maximum value.

getMaxIndex

public int getMaxIndex()

Returns the largest index with an explicit value. This is equal to getValueCount()-1.

Returns:

the maximum index.

getFirstValueIndex

public float getFirstValueIndex()

Returns the smallest index that contains a non-zero value

getXScale

public int getXScale()

setXScale

public Histogram setXScale(int scale)

Sets the x-scale. The x-scale determines, how many values are contained between to integral numbers on the x-axis.

Returns:

this instance

getFirstValueIndexUnscaled

public int getFirstValueIndexUnscaled()

Returns the smallest index that contains a non-zero value without taking the x-scale into account