netcharts.pro.common
Class NFRange

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

All Implemented Interfaces:

java.lang.Cloneable, NFCDLGenerator

Direct Known Subclasses:

NFAxisRange, NFBubbleScale

public class NFRange
extends NFBaseClass
implements NFCDLGenerator

The NFRange object identifies the minimum and maximum values of a given scale. The minimum and maximum values may be defined with numeric values as well as date/time values. This object is used to identify scrolling ranges, axes ranges, and more.

Constructor Summary

NFRange()
Constructs a default range

NFRange(java.util.Date min, java.util.Date max)
Constructs a default range

NFRange(double min, double max)
Constructs a default range

Method Summary

java.lang.String	getCDL() Generate CDL parameters representing this range
void	getCDL(java.lang.StringBuffer sb, boolean includeParens) Append CDL parameters representing this range to the given StringBuffer.
double	getMax() Gets the range maximum
java.util.Date	getMaxAsDate() Gets the range maximum as a date object
java.lang.Object	getMaxObject() Gets the range maximum in object form (either a Date or Double or null if not defined.)
double	getMin() Gets the range minimum
java.util.Date	getMinAsDate() Gets the range minimum as a date object
java.lang.Object	getMinObject() Gets the range minimum in object form (either a Date or Double or null if not defined.)
void	setCDL(java.lang.String cdl) Configures this object from a CDL parameter representation.
int	setCDL(java.lang.String[] elements, int offset) Configures this object from a CDL parameter representation.
void	setMax(java.util.Date max) Sets the range maximum using a date value
void	setMax(double max) Sets the range maximum
void	setMax(java.lang.Object max) Sets the range max as an object - either null, Date or Double is expected.
void	setMin(java.util.Date min) Sets the range minimum using a date value
void	setMin(double min) Sets the range minimum
void	setMin(java.lang.Object min) Sets the range min as an object - either null, Date or Double is expected.
java.lang.String	toString() Returns a new String object representing this range.

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

NFRange

public NFRange()

Constructs a default range

NFRange

public NFRange(double min,
               double max)

Constructs a default range

NFRange

public NFRange(java.util.Date min,
               java.util.Date max)

Constructs a default range

Method Detail

setMin

public void setMin(double min)

Sets the range minimum

Parameters:

min - Value representing the low end of the scale.

setMin

public void setMin(java.util.Date min)

Sets the range minimum using a date value

Parameters:

min - Date value representing the low end of the scale

setMin

public void setMin(java.lang.Object min)

Sets the range min as an object - either null, Date or Double is expected.

Parameters:

min -

getMin

public double getMin()

Gets the range minimum

Returns:

min

getMinAsDate

public java.util.Date getMinAsDate()

Gets the range minimum as a date object

Returns:

min

getMinObject

public java.lang.Object getMinObject()

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

Returns:

min

setMax

public void setMax(double max)

Sets the range maximum

Parameters:

max -

setMax

public void setMax(java.util.Date max)

Sets the range maximum using a date value

Parameters:

max -

setMax

public void setMax(java.lang.Object max)

Sets the range max as an object - either null, Date or Double is expected.

Parameters:

max -

getMax

public double getMax()

Gets the range maximum

Parameters:

max -

getMaxObject

public java.lang.Object getMaxObject()

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

Returns:

max

getMaxAsDate

public java.util.Date getMaxAsDate()

Gets the range maximum as a date object

Returns:

min

toString

public java.lang.String toString()

Returns a new String object representing this range.

Specified by:

toString in interface NFCDLGenerator

Overrides:

toString in class java.lang.Object

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

Returns:

CDL in the form: (minimum,maximum)

getCDL

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

Append CDL parameters representing this range to the given StringBuffer.

Parameters:

sb - Target buffer to append the CDL parameters

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

setCDL

public void setCDL(java.lang.String cdl)

Configures this object from a CDL parameter representation.

Specified by:

setCDL in interface NFCDLGenerator

Parameters:

cdl - CDL in the form: (minimum,maximum)

setCDL

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

Configures this object from a CDL parameter representation.

Parameters:

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

offset - Offset into the elements array.