quadbase.util
Interface IHistogramInfo

public interface IHistogramInfo

This interface is used to set/get different properties associated with a histogram. Users can obtain a handle to this by calling the gethHistogramInfo() function in QbChart

Method Summary

java.lang.Object	getLowerBound() Get the lower bound for the histogram.
java.lang.Number	getScale() Get the scale value used to do the rounding operation in the histogram.
java.lang.Object	getUpperBound() Get the upper bound for the histogram.
boolean	isHistogram() This function is used to find out if the current chart is a histogram or not.
boolean	isLinearScale() This function is used to determine if a linear scale has been plotted in the histogram.
boolean	isRounded() Are the values rounded off prior to plotting in the histogram.
void	setHistogram(boolean histState) This function is used to set/unset the histogram option in a chart.
void	setLinearScale(boolean isLinear) State whether or not to use a linear scale in the histogram.
void	setLowerBound(java.lang.Object lowerBound) Set the lower bound for the histogram.
void	setRounded(boolean isRounded) State whether or not to round values before plotting the histogram.
void	setScale(java.lang.Number value) Set the scale value to use in the rounding operation.
void	setUpperBound(java.lang.Object upperBound) Set the upper bound for the histogram.

Method Detail

isHistogram

public boolean isHistogram()

This function is used to find out if the current chart is a histogram or not.

Returns:

True if the chart is a histogram, false otherwise.

setHistogram

public void setHistogram(boolean histState)

This function is used to set/unset the histogram option in a chart.

Parameters:

histState - Set it to true if a histogram plot is required.

isLinearScale

public boolean isLinearScale()

This function is used to determine if a linear scale has been plotted in the histogram.

Returns:

True if a linear scale is being used, false otherwise.

setLinearScale

public void setLinearScale(boolean isLinear)

State whether or not to use a linear scale in the histogram. Linear scale can be set to true only if rounding is enabled

Parameters:

isLinear - Set it to true if a linear scale is desired.

See Also:

setRounded(boolean)

getLowerBound

public java.lang.Object getLowerBound()

Get the lower bound for the histogram. The data type returned matches the datatype of the category column.

Returns:

The lower bound of the values plotted for the histogram.

The object returned can have the following type:

   Integer, Short, Long, Float, Double, String
 

setLowerBound

public void setLowerBound(java.lang.Object lowerBound)

Set the lower bound for the histogram. This can also be set to null.

Parameters:

lowerBound - The lower bound desired in the plot.

See Also:

getLowerBound()

getUpperBound

public java.lang.Object getUpperBound()

Get the upper bound for the histogram.

Returns:

The upper bound of the values plotted for the histogram.

See Also:

getLowerBound()

setUpperBound

public void setUpperBound(java.lang.Object upperBound)

Set the upper bound for the histogram. This can also be set to null.

Parameters:

upperBound - The upper bound desired in the plot.

See Also:

setLowerBound(java.lang.Object)

isRounded

public boolean isRounded()

Are the values rounded off prior to plotting in the histogram.

Returns:

True if the values are rounded off, false otherwise.

setRounded

public void setRounded(boolean isRounded)

State whether or not to round values before plotting the histogram.

Parameters:

isRounded - Set to true if rounding is desired, false otherwise.

getScale

public java.lang.Number getScale()

Get the scale value used to do the rounding operation in the histogram.

Returns:

The scale value used to do the rounding.

setScale

public void setScale(java.lang.Number value)

Set the scale value to use in the rounding operation.

Parameters:

value - The number to use while rounding off values in the histogram.

See Also:

setRounded(boolean)