netcharts.pro.charts.box
Class NFBoxSet

java.lang.Object
  netcharts.pro.common.NFBaseClass
      netcharts.pro.common.NFVector
          netcharts.pro.common.NFBaseSet
              netcharts.pro.common.NFSet
                  netcharts.pro.common.rectangular.NFDataSet
                      netcharts.pro.charts.box.NFBoxSet

All Implemented Interfaces:

java.lang.Cloneable

public class NFBoxSet
extends NFDataSet

An NFBoxSet describes a single set of 1 dimensional data along with its appearance characteristics. Data can be added via the addElement(), setElementAt(), or loadDataModel() methods. A simple example of this object's usage is shown here:

        NFBoxchart bc = new NFBoxchart();
        NFBoxSet boxSet = new NFBoxSet("Apples", Color.red);
        for (int j=0; j < 20; j++)
                boxSet.addElement(j);

        bc.addBoxSet(boxSet);
 

Constructor Summary

NFBoxSet()
Constructs a default box set

NFBoxSet(java.awt.Color boxColor)
Constructs a box set with the given data color.

NFBoxSet(java.lang.String legendName, java.awt.Color boxColor)
Constructs a box set with the given legend name and data color.

Method Summary

void	addElement(double doubleValue) Add a double to the set.
void	addElement(int intValue) Add an integer to the set.
void	addElement(java.lang.Object data) Add a object to the set.
java.lang.Object	clone() Does a deep copy of this boxset object
java.lang.String	getCDLAppearance() Generate the CDL that creates the appearance information.
java.awt.Color	getColor() Gets the color for this set's box.
NFVector	getDataPointActiveLabels() Returns the data point active labels for this set.
NFLineSetSymbol	getDataPointSymbol() Returns the data point symbol.
NFVector	getFenceActiveLabels() Returns the fence active labels for this set
NFFillPattern	getFillPattern() Gets the fill pattern for this set's box.
java.lang.String	getLegendName() Returns the data set name used in the legend.
NFLineSetSymbol	getMeanSymbol() Returns the mean symbol.
boolean	getModifiedAppearance() Returns if the appearance of this dataset has changed.
boolean	getModifiedDataPointSymbols() Returns if the data point symbols of this dataset has changed.
boolean	getModifiedMeanSymbols() Returns if the mean symbols of this dataset has changed.
boolean	getModifiedOutlierSymbols() Returns if the outlier symbols of this dataset has changed.
NFVector	getOutlierActiveLabels() Returns the outlier active labels for this set
NFLineSetSymbol	getOutlierSymbol() Returns the outlier symbol.
void	setCDLAppearance(java.lang.String s) Configures the appearance information from a CDL parameter representation.
void	setColor(java.awt.Color boxColor) Sets the color for this set's box.
void	setDataPointActiveLabels(NFVector dataPointActiveLabels) Set the data point active labels for this set.
void	setDataPointSymbol(NFLineSetSymbol dataPointSymbol) Sets the data point symbol.
void	setElementAt(java.lang.Object data, int index) Set the object into the vector.
void	setFenceActiveLabels(NFVector fenceActiveLabels) Set the fence active labels for this set.
void	setFillPattern(NFFillPattern fillPattern) Sets the fill pattern for this set's box.
void	setLegendName(java.lang.String legendName) Set the data set name to use in legend.
void	setMeanSymbol(NFLineSetSymbol meanSymbol) Sets the mean symbol.
void	setOutlierActiveLabels(NFVector outlierActiveLabels) Set the outlier active labels for this set.
void	setOutlierSymbol(NFLineSetSymbol outlierSymbol) Sets the outlier symbol.

Methods inherited from class netcharts.pro.common.rectangular.NFDataSet

setXAxis, setYAxis

Methods inherited from class netcharts.pro.common.NFSet

getAxisMap, setAxisMap

Methods inherited from class netcharts.pro.common.NFBaseSet

addActiveLabel, getActiveLabels, getSetName, setActiveLabels, setSetName

Methods inherited from class netcharts.pro.common.NFVector

addElement, elementAt, elementAt, getCDL, getCDL, getCDL, getCDLHasTuples, getCDLKeyValues, getCDLKeyValuesHasPoints, getMaxDimensions, getQuoteStrings, getSize, isEmptyStringAsNull, loadDataModel, loadDataModel, loadDataModel, removeElementAt, reset, setCDL, setCDLHasTuples, setCDLNullString, setEmptyStringAsNull, setQuoteStrings, setSize, size, skipNulls, toArray, toString

Methods inherited from class netcharts.pro.common.NFBaseClass

getModified, getUserObject, setModified, setUserObject

Methods inherited from class java.lang.Object

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

Constructor Detail

NFBoxSet

public NFBoxSet()

Constructs a default box set

NFBoxSet

public NFBoxSet(java.awt.Color boxColor)

Constructs a box set with the given data color.

Parameters:

boxColor - The color of the box representing this data set.

NFBoxSet

public NFBoxSet(java.lang.String legendName,
                java.awt.Color boxColor)

Constructs a box set with the given legend name and data color.

Parameters:

legendName - The name that will appear in the legend for this set.

boxColor - The color of the box representing this data set.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Does a deep copy of this boxset object

Overrides:

clone in class NFSet

Returns:

Object

Throws:

java.lang.CloneNotSupportedException

addElement

public void addElement(int intValue)

Add an integer to the set.

Parameters:

intValue - datum to add

addElement

public void addElement(double doubleValue)

Add a double to the set.

Parameters:

doubleValue - datum to add

addElement

public void addElement(java.lang.Object data)

Add a object to the set. The object is expected to either be null or of type Number or Date.

If the value passed is not a valid data item an IllegalArgumentException will be thrown.

Overrides:

addElement in class NFVector

Parameters:

data - Object

setElementAt

public void setElementAt(java.lang.Object data,
                         int index)

Set the object into the vector. The object is expected to either be null or of type Number or Date.

If the value passed is not a valid data item an IllegalArgumentException will be thrown.

Overrides:

setElementAt in class NFVector

Parameters:

data - object to add

index - Row index to put the object.

getModifiedAppearance

public boolean getModifiedAppearance()

Returns if the appearance of this dataset has changed.

Returns:

modified

getModifiedDataPointSymbols

public boolean getModifiedDataPointSymbols()

Returns if the data point symbols of this dataset has changed.

Returns:

modifiedDataPointSymbols

getModifiedMeanSymbols

public boolean getModifiedMeanSymbols()

Returns if the mean symbols of this dataset has changed.

Returns:

modifiedMeanSymbols

getModifiedOutlierSymbols

public boolean getModifiedOutlierSymbols()

Returns if the outlier symbols of this dataset has changed.

Returns:

modifiedOutlierSymbols

setColor

public void setColor(java.awt.Color boxColor)

Sets the color for this set's box.

Parameters:

boxColor - The color for this set's box

getColor

public java.awt.Color getColor()

Gets the color for this set's box.

Returns:

the color for this set's box

setFillPattern

public void setFillPattern(NFFillPattern fillPattern)

Sets the fill pattern for this set's box.

Parameters:

fillPattern - Fill pattern for this set's box.

getFillPattern

public NFFillPattern getFillPattern()

Gets the fill pattern for this set's box.

Parameters:

fill - pattern for this set's box.

setLegendName

public void setLegendName(java.lang.String legendName)

Set the data set name to use in legend.

Parameters:

legendName - Name to use in legend

getLegendName

public java.lang.String getLegendName()

Returns the data set name used in the legend.

Returns:

the legend name

setMeanSymbol

public void setMeanSymbol(NFLineSetSymbol meanSymbol)

Sets the mean symbol. The MeanSymbol is used to define the style in which to draw the mean value.

Parameters:

meanSymbol - NFSymbol object

getMeanSymbol

public NFLineSetSymbol getMeanSymbol()

Returns the mean symbol. The MeanSymbol is used to define the style in which to draw the mean value.

Returns:

meanSymbol The NFSymbol representing the mean symbol.

setDataPointSymbol

public void setDataPointSymbol(NFLineSetSymbol dataPointSymbol)

Sets the data point symbol. The DataPointSymbol is used to define the style in which to draw data points when displaying raw data.

Parameters:

dataPointSymbol - NFSymbol object

getDataPointSymbol

public NFLineSetSymbol getDataPointSymbol()

Returns the data point symbol. The DataPointSymbol is used to define the style in which to draw data points when displaying raw data.

Returns:

dataPointSymbol The NFSymbol representing the data point symbol.

setOutlierSymbol

public void setOutlierSymbol(NFLineSetSymbol outlierSymbol)

Sets the outlier symbol. The OutlierSymbol is used to define the style in which to draw the mean value.

Parameters:

outlierSymbol - NFSymbol object

getOutlierSymbol

public NFLineSetSymbol getOutlierSymbol()

Returns the outlier symbol. The OutlierSymbol is used to define the style in which to draw the mean value.

Returns:

outlierSymbol The NFSymbol representing the outlier symbol.

setDataPointActiveLabels

public void setDataPointActiveLabels(NFVector dataPointActiveLabels)

Set the data point active labels for this set.

If the vector contains elements that are not NFActiveLabel objects, an IllegalArgumentException will be thrown.

Parameters:

dataPointActiveLabels - Vector of NFActiveLabels

getDataPointActiveLabels

public NFVector getDataPointActiveLabels()

Returns the data point active labels for this set.

Returns:

the vector of NFActiveLabel objects.

setFenceActiveLabels

public void setFenceActiveLabels(NFVector fenceActiveLabels)

Set the fence active labels for this set.

If the vector contains elements that are not NFActiveLabel objects, an IllegalArgumentException will be thrown.

Parameters:

fenceActiveLabels - Vector of NFActiveLabels

getFenceActiveLabels

public NFVector getFenceActiveLabels()

Returns the fence active labels for this set

Returns:

the vector of NFActiveLabel objects.

setOutlierActiveLabels

public void setOutlierActiveLabels(NFVector outlierActiveLabels)

Set the outlier active labels for this set.

If the vector contains elements that are not NFActiveLabel objects, an IllegalArgumentException will be thrown.

Parameters:

outlierActiveLabels - Vector of NFActiveLabels

getOutlierActiveLabels

public NFVector getOutlierActiveLabels()

Returns the outlier active labels for this set

Returns:

the vector of NFActiveLabel objects.

getCDLAppearance

public java.lang.String getCDLAppearance()

Generate the CDL that creates the appearance information.

Returns:

CDL in the form: ("legendName", boxColor)

setCDLAppearance

public void setCDLAppearance(java.lang.String s)

Configures the appearance information from a CDL parameter representation.

Parameters:

cdl - CDL in the form: ("legendName", boxColor)