netcharts.pro.common
Class NFAxisRange

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFRange
          netcharts.pro.common.NFAxisRange

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

Direct Known Subclasses:

NFScaleSetAxisRange, NFStripAxisRange

public class NFAxisRange
extends NFRange
implements NFCDLGenerator

The NFAxisRange maintains the minimum, maximum, and step for a particular axis. The minimum and maximum values may be defined with numeric values as well as date/time values. The step may be defined with a numeric value or a time unit value.

Constructor Summary

NFAxisRange()
Constructs a default axis range

NFAxisRange(java.util.Date min, java.util.Date max, double step)
Constructs an axis range with min, max and step.

NFAxisRange(double min, double max, double step)
Constructs an axis range with min, max and step.

Method Summary

void	getCDL(java.lang.StringBuffer sb, boolean includeParens) Append CDL parameters representing this range to the given StringBuffer.
double	getStep() Gets the range step.
NFTimeUnit	getStepAsTimeUnit() Gets the range step as time unit.
java.lang.Object	getStepObject() Gets the range step in object form (either a Date or Double or null if not defined.)
int	setCDL(java.lang.String[] elements, int offset) Configures this object from a CDL parameter representation.
void	setStep(double step) Sets the range step.
void	setStep(NFTimeUnit step) Sets the range step as a timeunit.

Methods inherited from class netcharts.pro.common.NFRange

getCDL, getMax, getMaxAsDate, getMaxObject, getMin, getMinAsDate, getMinObject, setCDL, setMax, setMax, setMax, setMin, setMin, setMin, toString

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

Methods inherited from interface netcharts.pro.common.NFCDLGenerator

getCDL, setCDL, toString

Constructor Detail

NFAxisRange

public NFAxisRange()

Constructs a default axis range

NFAxisRange

public NFAxisRange(double min,
                   double max,
                   double step)

Constructs an axis range with min, max and step.

Parameters:

min - range minimum

max - range maximum

step - range step

NFAxisRange

public NFAxisRange(java.util.Date min,
                   java.util.Date max,
                   double step)

Constructs an axis range with min, max and step.

Parameters:

min - range minimum

max - range maximum

step - range step

Method Detail

setStep

public void setStep(double step)

Sets the range step.

Parameters:

step -

setStep

public void setStep(NFTimeUnit step)

Sets the range step as a timeunit.

Parameters:

step -

getStep

public double getStep()

Gets the range step.

Returns:

step

getStepAsTimeUnit

public NFTimeUnit getStepAsTimeUnit()

Gets the range step as time unit.

Returns:

step

getStepObject

public java.lang.Object getStepObject()

Gets the range step in object form (either a Date or Double or null if not defined.)

Returns:

step

getCDL

public void getCDL(java.lang.StringBuffer sb,
                   boolean includeParens)

Append CDL parameters representing this range to the given StringBuffer.

Overrides:

getCDL in class NFRange

Parameters:

sb - Target buffer to append the CDL parameters

includeParens - If true, this will cause the parameters to be delimited with parenthesis.

setCDL

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

Configures this object from a CDL parameter representation.

Overrides:

setCDL in class NFRange

Parameters:

elements - Array of parameter elements. This array is expected to contain consecutive elements containing minimum, maximum and step information.

offset - Offset into the elements array.