netcharts.pro.charts.pareto
Class NFParetochart

java.lang.Object
  |
  +--netcharts.pro.common.NFGraph
        |
        +--netcharts.pro.common.zoomable.NFZoomableChart
              |
              +--netcharts.pro.common.rectangular.NFDataChart
                    |
                    +--netcharts.pro.common.barset.NFAbstractBarchart
                          |
                          +--netcharts.pro.charts.pareto.NFParetochart

All Implemented Interfaces:

java.io.Externalizable, NFDragObserver, NFDwellObserver, NFGraphObserver, NFScrollObserver, NFValueLabelConstants, java.io.Serializable

public class NFParetochart

extends NFAbstractBarchart

implements NFValueLabelConstants

Represents a Pareto chart. Provides the ability to configure the chart via object manipulation or directly from CDL.

See Also:

Serialized Form

Field Summary

static int	DRAWBAR Draw bar
static int	DRAWFILL Draw fill
static int	DRAWLINE Draw line

Fields inherited from class netcharts.pro.common.barset.NFAbstractBarchart

barchartTypeMap, BOTTOMUP, GROUP, GROUPSTACK, HORIZONTAL, ITEM, orientationMap, ROWS, STACK, stackDisplayOrderMap, stackTypeMap, TOPDOWN, TOTAL, VERTICAL

Fields inherited from class netcharts.pro.common.zoomable.NFZoomableChart

NOZOOM, zoomActionsMap, ZOOMIN, ZOOMOUT

Fields inherited from class netcharts.pro.common.NFGraph

ANTIALIAS_OFF, ANTIALIAS_ON, ANTIALIAS_ONDRAW, ANTIALIAS_ONTEXT, antiAliasModeMap, BAR, BOX, BUBBLE, COMBO, DIAGRAM, DIAL, HEATMAP, LINE, MULTIPIE, PARETO, PIE, POLAR, RADAR, STOCK, STRIP, TIME, XY

Fields inherited from interface netcharts.pro.common.lineset.NFValueLabelConstants

BOTTOM, BOTTOMLEFT, BOTTOMRIGHT, CENTER, LEFT, NONE, RIGHT, TOP, TOPLEFT, TOPRIGHT

Constructor Summary

NFParetochart()
Constructs a default chart object.

NFParetochart(javax.swing.JPanel panel)
Constructs a chart object on the given JPanel.

NFParetochart(javax.swing.JPanel panel, java.util.Properties initProperties)
Constructs a chart object on the given JPanel with the specified properties.

NFParetochart(java.util.Properties initProperties)
Constructs a chart object with the specified properties.

Method Summary

int	getBarchartType() Get the bar chart type.
int	getBarDepth() Get 3D Depth for bars
java.lang.String	getCDLCumulativeLineValueLabelStyle() Get the cumulative line value label style as a CDL string.
java.lang.String	getCumulativeLineSetName() Get the cumulative line set name.
NFLineSetLine	getCumulativeLineStyle() Get the cumulative line style attributes
NFLineSetSymbol	getCumulativeLineSymbol() Get the cumulative line symbol attributes
NFModalLabel	getCumulativeLineValueLabel() Get the text style to use for cumulative line labels.
NFRegion	getCumulativeLineValueLabelRegion() Get the text background style to use for cumulative line labels.
int	getCumulativeLineValueLabelStyle() Get the type of text labeling for the cumulative line set.
java.lang.String	getDefaultData() Returns a string of default data
int[]	getDrawOrder() Get the draw order.
java.lang.String	getEightyLineSetName() Get name for the 80% line.
NFLineSetLine	getEightyTwentyLineStyle() Get the 80/20 line style attributes
NFLineSetSymbol	getEightyTwentyLineSymbol() Get the 80/20 line symbol attributes
int	getLineDepth() Get 3D Depth for lines
boolean	getLineLabelsEnabled() Get whether or not popups over lines are enabled.
int	getLineZWidth() Get the lineZWidth.
int	getOrientation() Get the bar orientation.
boolean	getShowEightyTwentyLines() Get whether the 80/20 lines should be shown on the graph.
java.lang.String	getTwentyLineSetName() Get the name for the 20% line.
int	getType() Gets the chart type.
void	resetState() Resets all of the parameter values to their initial state.
void	setBarDepth(int barDepth) Set 3D Depth for bars
void	setCDLCumulativeLineValueLabelStyle(java.lang.String cdl) Set the cumulative line value label style from a CDL string.
void	setCumulativeLineSetName(java.lang.String cumulativeLineSetName) Set the cumulative line set name.
void	setCumulativeLineStyle(NFLineSetLine cumulativeLineStyle) Set the cumulative line style attributes
void	setCumulativeLineSymbol(NFLineSetSymbol cumulativeLineSymbol) Set the cumulative line symbol attributes
void	setCumulativeLineValueLabel(NFModalLabel cumulativeLineValueLabel) Set the text style to use for cumulative line labels.
void	setCumulativeLineValueLabelRegion(NFRegion cumulativeLineValueRegion) Set the text background style to use for cumulative line labels.
void	setCumulativeLineValueLabelStyle(int cumulativeLineValueLabelStyle) Set the type of text labeling for the cumulative line set.
void	setDrawOrder(int[] drawOrder) Set the draw order.
void	setEightyLineSetName(java.lang.String eightyLineSetName) Set name for the 80% line.
void	setEightyTwentyLineStyle(NFLineSetLine eightyTwentyLineStyle) Set the 80/20 line style attributes
void	setEightyTwentyLineSymbol(NFLineSetSymbol eightyTwentyLineSymbol) Set the 80/20 line symbol attributes
void	setLineDepth(int lineDepth) Set 3D Depth for lines
void	setLineLabelsEnabled(boolean lineLabelsEnabled) Set enable popup labels over lines.
void	setLineZWidth(int lineZWidth) Set the line Z width.
void	setShowEightyTwentyLines(boolean showEightyTwentyLines) Set whether the 80/20 lines should be shown on the graph.
void	setTwentyLineSetName(java.lang.String twentyLineSetName) Set the name for the 20% line.
void	writeChart(java.lang.StringBuffer sb) Writes this chart into a string buffer
void	writeExternal(java.io.ObjectOutput out) Writes this chart into an object for serialization.

Methods inherited from class netcharts.pro.common.barset.NFAbstractBarchart

addBarSet, getBarActiveLabels, getBarBorder, getBarSeries, getBarValueLabel, getBarValueLabelRegion, getBarWidth, getDataLabels, getStackDisplayOrder, getStackType, getZAxisLabels, setBarActiveLabels, setBarBorder, setBarSeries, setBarValueLabel, setBarValueLabelRegion, setBarWidth, setDataLabels, setStackDisplayOrder, setStackType, setZAxisLabels

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

addGrid, getAutoscalePad, getAxesSizes, getAxisThickness, getBottomAxis, getBottomAxisSeries, getGrid, getGridDepth, getGridSeries, getLeftAxis, getLeftAxisSeries, getRightAxis, getRightAxisSeries, getTopAxis, getTopAxisSeries, setAutoscalePad, setAxesSizes, setAxisThickness, setBottomAxis, setBottomAxisSeries, setGrid, setGridDepth, setGridSeries, setLeftAxis, setLeftAxisSeries, setRightAxis, setRightAxisSeries, setTopAxis, setTopAxisSeries

Methods inherited from class netcharts.pro.common.zoomable.NFZoomableChart

getMouseControlDown, getMouseMetaDown, getMouseShiftDown, getZoomingEnabled, setMouseControlDown, setMouseMetaDown, setMouseShiftDown, setZoomingEnabled

Methods inherited from class netcharts.pro.common.NFGraph

addChartActionListener, addGraphObserver, addNote, addPropertyChangeListener, display, dwellDisplay, dwellPress, finalize, getActiveClicks, getAlwaysUpdate, getAntiAlias, getAntiAliasMode, getBackgroundFillPattern, getBackgroundRegion, getCDL, getChartElementSpacing, getChartName, getChartSize, getColorTable, getDataActiveLabelsEnabled, getDwell, getDwellOffset, getErrors, getFooter, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphFromTemplate, getGraphGraphics, getHeader, getLeftTitle, getLegend, getMetaData, getMinimumSize, getNoteSeries, getNumberFormat, getNumErrors, getPanel, getPlotArea, getPreferredSize, getRightTitle, getRootPanel, getScaleFactor, graphDrawn, graphTooSmall, initializeFromFile, initializeFromString, initializeFromURL, loadFromTemplate, loadFromTemplate, loadFromTemplate, loadLicenseFile, paint, postDrag, postScroll, preDrag, preScroll, readExternal, removeChartActionListener, removeGraphObserver, removePropertyChangeListener, sendData, sendData, sendData, sendData, sendUpdate, set, set, set, set, set, set, setActiveClicks, setAlwaysUpdate, setAntiAlias, setAntiAliasMode, setBackgroundFillPattern, setBackgroundRegion, setChartElementSpacing, setChartName, setChartSize, setColorTable, setDataActiveLabelsEnabled, setDocumentBase, setDwell, setDwellOffset, setFooter, setHeader, setLeftTitle, setLegend, setLicenseKey, setMetaData, setNoteSeries, setNumberFormat, setParentApplet, setPlotArea, setRightTitle, setScaleFactor, setSize, setSize, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

DRAWBAR

public static final int DRAWBAR

Draw bar

DRAWLINE

public static final int DRAWLINE

Draw line

DRAWFILL

public static final int DRAWFILL

Draw fill

Constructor Detail

NFParetochart

public NFParetochart()

Constructs a default chart object.

NFParetochart

public NFParetochart(javax.swing.JPanel panel)

Constructs a chart object on the given JPanel.

Parameters:

panel - Panel to draw chart on.

NFParetochart

public NFParetochart(java.util.Properties initProperties)

Constructs a chart object with the specified properties.

Parameters:

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

NFParetochart

public NFParetochart(javax.swing.JPanel panel,
                     java.util.Properties initProperties)

Constructs a chart object on the given JPanel with the specified properties.

Parameters:

panel - Panel to draw chart on.

initProperties - A java.util.Properties object containing the set of runtime properties to use when generating the chart. See the netcharts.pro.common.NFGraph(java.util.Properties) constructor for a list of valid Properties.

Method Detail

getDefaultData

public java.lang.String getDefaultData()

Returns a string of default data

Overrides:

getDefaultData in class NFGraph

Following copied from class: netcharts.pro.common.NFGraph

Returns:

The default data used to initialize a chart.

getType

public int getType()

Gets the chart type.

Overrides:

getType in class NFGraph

Returns:

the type of this chart, always netcharts.pro.common.NFGraph.PARETO

getBarchartType

public int getBarchartType()

Get the bar chart type. Always returns STACK.

Returns:

the bar chart type

getOrientation

public int getOrientation()

Get the bar orientation. Always returns VERTICAL.

Returns:

orientation

setBarDepth

public void setBarDepth(int barDepth)

Set 3D Depth for bars

Parameters:

barDepth - 3D shadow depth for bars

getBarDepth

public int getBarDepth()

Get 3D Depth for bars

Returns:

3D shadow depth for bars

setLineLabelsEnabled

public void setLineLabelsEnabled(boolean lineLabelsEnabled)

Set enable popup labels over lines.

Parameters:

lineLabelsEnabled - When popups will appear over lines of the chart.

getLineLabelsEnabled

public boolean getLineLabelsEnabled()

Get whether or not popups over lines are enabled.

Returns:

When popups will appear over lines of the chart.

setLineDepth

public void setLineDepth(int lineDepth)

Set 3D Depth for lines

Parameters:

lineDepth - 3D shadow depth

getLineDepth

public int getLineDepth()

Get 3D Depth for lines

Returns:

3D shadow depth

setLineZWidth

public void setLineZWidth(int lineZWidth)

Set the line Z width. This percentage value (0-100) or (0.0-1.0) determines the amount of space actually used to display 3D lines when depth is greater than 1. If 100 percent is specified, then each line will completely fill the amount of space specified by depth in the Z dimension. If 50 percent is specified, then each line will occupy only 50 percent of that space, which will result in a visible separation between each line set. The default value is 100.

Parameters:

lineZWidth - line Z width

getLineZWidth

public int getLineZWidth()

Get the lineZWidth. This percentage value (0-100) or (0.0-1.0) determines the amount of space actually used to display 3D lines when depth is greater than 1. If 100 percent is specified, then each line will completely fill the amount of space specified by depth in the Z dimension. If 50 percent is specified, then each line will occupy only 50 percent of that space, which will result in a visible separation between each line set. The default value is 100.

Returns:

line Z width

setCumulativeLineValueLabel

public void setCumulativeLineValueLabel(NFModalLabel cumulativeLineValueLabel)

Set the text style to use for cumulative line labels.

Parameters:

cumulativeLineValueLabel - text style for cumulative line labels

getCumulativeLineValueLabel

public NFModalLabel getCumulativeLineValueLabel()

Get the text style to use for cumulative line labels.

Returns:

text style for cumulative line labels

setCumulativeLineValueLabelRegion

public void setCumulativeLineValueLabelRegion(NFRegion cumulativeLineValueRegion)

Set the text background style to use for cumulative line labels.

Parameters:

cumulativeLineValueRegion - Text background style.

getCumulativeLineValueLabelRegion

public NFRegion getCumulativeLineValueLabelRegion()

Get the text background style to use for cumulative line labels.

Returns:

text background style.

setCumulativeLineValueLabelStyle

public void setCumulativeLineValueLabelStyle(int cumulativeLineValueLabelStyle)

Set the type of text labeling for the cumulative line set.

If the value passed is not a valid line value label style an IllegalArgumentException will be thrown.

Parameters:

cumulativeLineValueLabelStyle - One of NONE, RIGHT, LEFT, BOTTOM, TOPLEFT, TOPRIGHT, BOTTOMRIGHT, BOTTOMLEFT, CENTER

getCumulativeLineValueLabelStyle

public int getCumulativeLineValueLabelStyle()

Get the type of text labeling for the cumulative line set.

Returns:

One of NONE, RIGHT, LEFT, BOTTOM, TOPLEFT, TOPRIGHT, BOTTOMRIGHT, BOTTOMLEFT, CENTER or BOTTOM if not set.

getCDLCumulativeLineValueLabelStyle

public java.lang.String getCDLCumulativeLineValueLabelStyle()

Get the cumulative line value label style as a CDL string.

Returns:

cumulative line value label style cdl

setCDLCumulativeLineValueLabelStyle

public void setCDLCumulativeLineValueLabelStyle(java.lang.String cdl)

Set the cumulative line value label style from a CDL string.

Parameters:

cumulative - line value label style cdl

setShowEightyTwentyLines

public void setShowEightyTwentyLines(boolean showEightyTwentyLines)

Set whether the 80/20 lines should be shown on the graph.

Parameters:

showEightyTwentyLines - true if the 80/20 lines should be shown, false otherwise.

getShowEightyTwentyLines

public boolean getShowEightyTwentyLines()

Get whether the 80/20 lines should be shown on the graph.

Returns:

true if the 80/20 lines should be shown, false otherwise.

setCumulativeLineStyle

public void setCumulativeLineStyle(NFLineSetLine cumulativeLineStyle)

Set the cumulative line style attributes

Parameters:

cumulativeLineStyle - line style attributes

getCumulativeLineStyle

public NFLineSetLine getCumulativeLineStyle()

Get the cumulative line style attributes

Returns:

line style attributes

setCumulativeLineSymbol

public void setCumulativeLineSymbol(NFLineSetSymbol cumulativeLineSymbol)

Set the cumulative line symbol attributes

Parameters:

cumulativeLineSymbol - symbol to be drawn at data point locations

getCumulativeLineSymbol

public NFLineSetSymbol getCumulativeLineSymbol()

Get the cumulative line symbol attributes

Returns:

symbol to be drawn at data point locations

setCumulativeLineSetName

public void setCumulativeLineSetName(java.lang.String cumulativeLineSetName)

Set the cumulative line set name. Used as a default for the legend label.

Parameters:

cumulativeLineSetName - cumulative line set name

getCumulativeLineSetName

public java.lang.String getCumulativeLineSetName()

Get the cumulative line set name. Used as a default for the legend label.

Returns:

legend name for the cumulative line

setEightyTwentyLineStyle

public void setEightyTwentyLineStyle(NFLineSetLine eightyTwentyLineStyle)

Set the 80/20 line style attributes

Parameters:

eightyTwentyLineStyle - 80/20 line style attributes

getEightyTwentyLineStyle

public NFLineSetLine getEightyTwentyLineStyle()

Get the 80/20 line style attributes

Returns:

80/20 line style attributes

setEightyTwentyLineSymbol

public void setEightyTwentyLineSymbol(NFLineSetSymbol eightyTwentyLineSymbol)

Set the 80/20 line symbol attributes

Parameters:

eightyTwentyLineSymbol - symbol to be drawn at data point locations

getEightyTwentyLineSymbol

public NFLineSetSymbol getEightyTwentyLineSymbol()

Get the 80/20 line symbol attributes

Returns:

symbol to be drawn at data point locations

setEightyLineSetName

public void setEightyLineSetName(java.lang.String eightyLineSetName)

Set name for the 80% line. Used as a default for the legend label.

Parameters:

eightyLineSetName - legend name for the 80% line

getEightyLineSetName

public java.lang.String getEightyLineSetName()

Get name for the 80% line. Used as a default for the legend label.

Returns:

legend name for the 80% line

setTwentyLineSetName

public void setTwentyLineSetName(java.lang.String twentyLineSetName)

Set the name for the 20% line. Used as a default for the legend label.

Parameters:

twentyLineSetName - legend name for the 20% line

getTwentyLineSetName

public java.lang.String getTwentyLineSetName()

Get the name for the 20% line. Used as a default for the legend label.

Returns:

legend name for the 20% line

setDrawOrder

public void setDrawOrder(int[] drawOrder)
                  throws NFParamException

Set the draw order. This determines the order in which data elements of this chart will be drawn. The drawOrder is sent in as an int array. Each element is expected to contain one of: NFParetochart.DRAWBAR, NFParetochart.DRAWLINE or NFParetochart.DRAWFILL. The objects will be drawn according to their position in the list (e.g. the first in the list is drawn first).

Parameters:

drawOrder - Chart draw order

getDrawOrder

public int[] getDrawOrder()

Get the draw order. This determines the order in which data elements of this chart will be drawn. The drawOrder is sent in as an int array. Each element is expected to contain one of: NFParetochart.DRAWBAR, NFParetochart.DRAWLINE or NFParetochart.DRAWFILL. The objects will be drawn according to their position in the list (e.g. the first in the list is drawn first).

Returns:

chart draw order

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Writes this chart into an object for serialization.

Overrides:

writeExternal in class NFAbstractBarchart

writeChart

public void writeChart(java.lang.StringBuffer sb)

Writes this chart into a string buffer

Overrides:

writeChart in class NFAbstractBarchart

resetState

public void resetState()

Resets all of the parameter values to their initial state.

Overrides:

resetState in class NFAbstractBarchart