netcharts.pro.charts.strip
Class NFStripAxisRange

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFRange
          netcharts.pro.common.NFAxisRange
              netcharts.pro.charts.strip.NFStripAxisRange

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

public class NFStripAxisRange
extends NFAxisRange
implements NFCDLGenerator

This object is used to define the range and behavior characteristics of the top and bottom strip chart axes.

Field Summary

static int	DYNAMIC Dynamic axis type (tics and labels move with the data)
static int	STATIC Static axis type (tics and labels do not move)
static java.util.Hashtable	stripAxisMap strip axis type hashtable

Constructor Summary

NFStripAxisRange()
Constructs a default stripchart axis range

NFStripAxisRange(int slotsPerTic, java.util.Date ticStart, NFTimeUnit ticStep, int type)
Constructs a stripchart axis range with the given slots per tic, tic Start, tic Step and axis type.

NFStripAxisRange(int slotsPerTic, double ticStart, double ticStep, int axisType)
Constructs a stripchart axis range with the given slots per tic, tic Start, tic Step and axis type.

Method Summary

int	getAxisType() Gets the axis type.
java.lang.String	getCDL() Generate CDL parameters representing this range
int	getSlotsPerTic() Gets the number of data slots per tic mark.
double	getStep() Gets the numeric tic value increment.
NFTimeUnit	getStepAsTimeUnit() Gets the date/time tic value increment.
double	getTicStart() Gets the first tic value as a number.
java.util.Date	getTicStartAsDate() Gets the first tic value as a date.
void	setAxisType(int axisType) Sets the axis type.
void	setCDL(java.lang.String cdl) Configures this object from a CDL parameter representation.
void	setSlotsPerTic(int slotsPerTic) Sets the number of data slots per tic mark.
void	setStep(double step) Sets the numeric tic value increment.
void	setStep(NFTimeUnit step) Sets the date/time tic value increment.
void	setTicStart(java.util.Date ticStart) Sets the first date-based tic value.
void	setTicStart(double ticStart) Sets the first numeric tic value.
java.lang.String	toString() Returns a new String object representing this range.

Methods inherited from class netcharts.pro.common.NFAxisRange

getCDL, getStepObject, setCDL

Methods inherited from class netcharts.pro.common.NFRange

getMax, getMaxAsDate, getMaxObject, getMin, getMinAsDate, getMinObject, setMax, setMax, setMax, setMin, setMin, setMin

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

Field Detail

STATIC

public static final int STATIC

Static axis type (tics and labels do not move)

See Also:

Constant Field Values

DYNAMIC

public static final int DYNAMIC

Dynamic axis type (tics and labels move with the data)

See Also:

Constant Field Values

stripAxisMap

public static java.util.Hashtable stripAxisMap

strip axis type hashtable

Constructor Detail

NFStripAxisRange

public NFStripAxisRange()

Constructs a default stripchart axis range

NFStripAxisRange

public NFStripAxisRange(int slotsPerTic,
                        double ticStart,
                        double ticStep,
                        int axisType)

Constructs a stripchart axis range with the given slots per tic, tic Start, tic Step and axis type.

Parameters:

slotsPerTic - The number of data slots between tic marks.

ticStart - Used when automatically generating labels. Indicates the first numeric tic value.

ticStep - Used when automatically generating labels. Indicates numerical increment between tics.

axisType - The axis behavior. One of STATIC, DYNAMIC

NFStripAxisRange

public NFStripAxisRange(int slotsPerTic,
                        java.util.Date ticStart,
                        NFTimeUnit ticStep,
                        int type)

Constructs a stripchart axis range with the given slots per tic, tic Start, tic Step and axis type.

Parameters:

slotsPerTic - The number of data slots between tic marks.

ticStart - Used when automatically generating labels. Indicates the first date based tic value.

ticStep - Used when automatically generating labels. Indicates time unit increment between tics.

axisType - The axis behavior. One of STATIC, DYNAMIC

Method Detail

setSlotsPerTic

public void setSlotsPerTic(int slotsPerTic)

Sets the number of data slots per tic mark.

Parameters:

Number - of data slots per tic mark.

getSlotsPerTic

public int getSlotsPerTic()

Gets the number of data slots per tic mark.

Returns:

number of data slots or 5 if not defined.

setAxisType

public void setAxisType(int axisType)

Sets the axis type. One of STATIC, DYNAMIC

If the value passed is not a valid strip chart axis type an IllegalArgumentException will be thrown.

Parameters:

axisType - The type of axis.

getAxisType

public int getAxisType()

Gets the axis type. One of STATIC, DYNAMIC

Returns:

the type of axis or STATIC if not defined.

setTicStart

public void setTicStart(double ticStart)

Sets the first numeric tic value. Used when automatically generating labels.

Parameters:

ticStart - first numeric tic value.

setTicStart

public void setTicStart(java.util.Date ticStart)

Sets the first date-based tic value. Used when automatically generating labels.

Parameters:

ticStart - first date-based tic value.

getTicStart

public double getTicStart()

Gets the first tic value as a number. Used when automatically generating labels.

Returns:

first numeric tic value or 0.0 if not defined.

getTicStartAsDate

public java.util.Date getTicStartAsDate()

Gets the first tic value as a date. Used when automatically generating labels.

Returns:

first date-based tic value or the current date/time if not defined.

setStep

public void setStep(double step)

Sets the numeric tic value increment. Used when automatically generating labels.

Overrides:

setStep in class NFAxisRange

Parameters:

step - numeric tic value increment.

setStep

public void setStep(NFTimeUnit step)

Sets the date/time tic value increment. Used when automatically generating labels.

Overrides:

setStep in class NFAxisRange

Parameters:

step - date/time tic value increment.

getStep

public double getStep()

Gets the numeric tic value increment. Used when automatically generating labels.

Overrides:

getStep in class NFAxisRange

Returns:

numeric tic value increment or 0.0 if not defined.

getStepAsTimeUnit

public NFTimeUnit getStepAsTimeUnit()

Gets the date/time tic value increment. Used when automatically generating labels.

Overrides:

getStepAsTimeUnit in class NFAxisRange

Returns:

step

toString

public java.lang.String toString()

Returns a new String object representing this range.

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class NFRange

Returns:

A new String object in the same form as that given by getCDL().

getCDL

public java.lang.String getCDL()

Generate CDL parameters representing this range

Specified by:

getCDL in interface NFCDLGenerator

Overrides:

getCDL in class NFRange

Returns:

CDL in the form: (slotsPerTic, ticStart, ticStep, axisType)

setCDL

public void setCDL(java.lang.String cdl)

Configures this object from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Overrides:

setCDL in class NFRange

Parameters:

cdl - CDL in the form: (slotsPerTic, ticStart, ticStep, axisType)