netcharts.pro.charts.histogram
Class NFHistogramScale

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.charts.histogram.NFHistogramScale

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFHistogramScale
extends NFBaseClass
implements NFCDLGenerator

Constructor Summary

NFHistogramScale()
Constructs a default histogram scale object.

NFHistogramScale(int min, int max)
Constructs a histogram scale object with the given beginning and end data range

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this histogram scale
void	getCDL(java.lang.StringBuffer sb) Append CDL parameters representing this histogram scale to the given StringBuffer.
java.lang.Integer	getMax() Gets the end of the data range
java.lang.Integer	getMin() Gets the beginning of the data range
void	setCDL(java.lang.Object cdlObject) Configures this histogram scale object from a CDL parameter object.
void	setCDL(java.lang.String cdl) Configures this histogram scale object from a CDL parameter string representation.
int	setCDL(java.lang.String[] elements, int offset) Configures this histogram scale object from a CDL parameter string representation.
void	setMax(int max) Sets the end of the data range
void	setMax(java.lang.Integer max) Sets the end of the data range
void	setMin(int min) Sets the beginning of the data range
void	setMin(java.lang.Integer min) Sets the beginning of the data range
java.lang.String	toString() Returns a string representing this histogram scale.

Methods inherited from class netcharts.pro.common.NFBaseClass

clone, getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NFHistogramScale

public NFHistogramScale()

Constructs a default histogram scale object. The beginning of the data range will be defaulted to the lowest number in the data set(s) and the end of the data range will be defaulted to the largest number in the data set(s).

NFHistogramScale

public NFHistogramScale(int min,
                        int max)

Constructs a histogram scale object with the given beginning and end data range

Parameters:

min - beginning of the data range

max - end of the data range

Method Detail

setMin

public void setMin(int min)

Sets the beginning of the data range

Parameters:

min - beginning of the data range

setMin

public void setMin(java.lang.Integer min)

Sets the beginning of the data range

Parameters:

min - beginning of the data range

getMin

public java.lang.Integer getMin()

Gets the beginning of the data range

Returns:

the beginning of the data range

setMax

public void setMax(int max)

Sets the end of the data range

Parameters:

min - end of the data range

setMax

public void setMax(java.lang.Integer max)

Sets the end of the data range

Parameters:

min - end of the data range

getMax

public java.lang.Integer getMax()

Gets the end of the data range

Returns:

the end of the data range

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this histogram scale

Specified by:

getCDL in interface NFCDLGenerator

Returns:

CDL in the form: (min, max)

getCDL

public void getCDL(java.lang.StringBuffer sb)

Append CDL parameters representing this histogram scale to the given StringBuffer.

Parameters:

sb - target buffer to append the CDL parameters

toString

public java.lang.String toString()

Returns a string representing this histogram scale. The string that is returned is the same as calling getCDL()

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class java.lang.Object

Returns:

string in the the form: (min, max)

setCDL

public void setCDL(java.lang.Object cdlObject)

Configures this histogram scale object from a CDL parameter object.

Parameters:

cdlObject - CDL in string form or in a user object.

setCDL

public void setCDL(java.lang.String cdl)

Configures this histogram scale object from a CDL parameter string representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in string form: (min, max)

setCDL

public int setCDL(java.lang.String[] elements,
                  int offset)

Configures this histogram scale object from a CDL parameter string representation.

Parameters:

elements - array of parameter elements containing consecutive elements histogram scale min and histogram scale max

offset - offset into the elements array