com.imsl.chart.qc
Class ControlLimit

java.lang.Object
  com.imsl.chart.AbstractChartNode
      com.imsl.chart.ChartNode
          com.imsl.chart.Data
              com.imsl.chart.qc.ControlLimit

All Implemented Interfaces:

Serializable, Cloneable

public class ControlLimit
extends Data

ControlLimit is a control limit line on a process control chart.

This class draw either a horizontal line or a stair step line depending on the value of the attribute "Value". Its value is an array. If the has a just one entry then a horizontal line is drawn at y equal to this value. This line extends across the limit given by the x-axis window attribute. If the array has more than one entry then a stair step line is drawn using the array values as the y-coordinates of the stair step line.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.imsl.chart.ChartNode

AXIS_X_TOP, AXIS_Y_RIGHT, BAR_TYPE_HORIZONTAL, BAR_TYPE_VERTICAL, DASH_PATTERN_DASH, DASH_PATTERN_DASH_DOT, DASH_PATTERN_DOT, DASH_PATTERN_SOLID, DATA_TYPE_FILL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, DATA_TYPE_TUBE, DENDROGRAM_TYPE_HORIZONTAL, DENDROGRAM_TYPE_VERTICAL, FILL_TYPE_GRADIENT, FILL_TYPE_NONE, FILL_TYPE_PAINT, FILL_TYPE_SOLID, LABEL_TYPE_PERCENT, MARKER_TYPE_ASTERISK, MARKER_TYPE_CIRCLE_CIRCLE, MARKER_TYPE_CIRCLE_PLUS, MARKER_TYPE_CIRCLE_X, MARKER_TYPE_DIAMOND_PLUS, MARKER_TYPE_FILLED_CIRCLE, MARKER_TYPE_FILLED_DIAMOND, MARKER_TYPE_FILLED_SQUARE, MARKER_TYPE_FILLED_TRIANGLE, MARKER_TYPE_HOLLOW_CIRCLE, MARKER_TYPE_HOLLOW_DIAMOND, MARKER_TYPE_HOLLOW_SQUARE, MARKER_TYPE_HOLLOW_TRIANGLE, MARKER_TYPE_OCTAGON_PLUS, MARKER_TYPE_OCTAGON_X, MARKER_TYPE_PLUS, MARKER_TYPE_SQUARE_PLUS, MARKER_TYPE_SQUARE_X, MARKER_TYPE_X, TEXT_X_CENTER, TEXT_X_LEFT, TEXT_X_RIGHT, TEXT_Y_BOTTOM, TEXT_Y_CENTER, TEXT_Y_TOP

Fields inherited from class com.imsl.chart.AbstractChartNode

AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_Y, AXIS_Z, LABEL_TYPE_NONE, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, LABEL_TYPE_Z, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG

Method Summary

void	dataRange(double[] range) Update the data range, range = {xmin,xmax,ymin,ymax}.
double	getControlLimit() Returns the value of the attribute "ControlLimit".
double	getMaximumValue() Returns the maximum value of this control limit line.
double	getMinimumValue() Returns the minimum value of this control limit line.
double[]	getValue() Returns the value of this control limit line.
void	paint(Draw draw) Paints the horizontal control limit line as wide as the window.
void	setControlLimit(double controlLimit) Sets the attribute "ControlLimit".
void	setMaximumValue(double maximumValue) Set the maximum value of this control limit line.
void	setMinimumValue(double minimumValue) Set the minimum value of this control limit line.
void	setValue(double y) Sets the value of this control limit line.
void	setValue(double[] y) Sets the value of this control limit line to an array of values.

Methods inherited from class com.imsl.chart.Data

formatLabel

Methods inherited from class com.imsl.chart.ChartNode

addPickListener, firePickListeners, getALT, getAxis, getBackground, getBarGap, getBarType, getBarWidth, getChart, getChartTitle, getChildren, getClipData, getComponent, getConcatenatedViewport, getDataType, getDoubleBuffering, getExplode, getFillOutlineColor, getFillOutlineType, getFillPaint, getFillType, getGradient, getHREF, getLegend, getLineDashPattern, getMarkerDashPattern, getMarkerThickness, getMarkerType, getParent, getReference, getScreenAxis, getScreenSize, getScreenViewport, getSize, getSkipWeekends, getTextAngle, getTextColor, getTitle, getToolTip, getViewport, isBitSet, prePaint, removePickListener, setALT, setBarGap, setBarType, setBarWidth, setChartTitle, setClipData, setCustomTransform, setDataType, setDoubleBuffering, setExplode, setFillOutlineColor, setFillOutlineColor, setFillOutlineType, setFillPaint, setFillPaint, setFillPaint, setFillType, setGradient, setGradient, setGradient, setHREF, setImage, setLineDashPattern, setMarkerDashPattern, setMarkerThickness, setMarkerType, setReference, setScreenSize, setSize, setSkipWeekends, setTextAngle, setTextColor, setTextColor, setTitle, setTitle, setToolTip, setViewport, setViewport

Methods inherited from class com.imsl.chart.AbstractChartNode

clone, clone, clone, clone, getAbstractParent, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getBooleanAttribute, getChildList, getColorAttribute, getCustomTransform, getDensity, getDoubleAttribute, getFillColor, getFont, getFontName, getFontSize, getFontStyle, getImage, getIntegerAttribute, getLabelType, getLightColor, getLineColor, getLineWidth, getLocale, getMarkerColor, getMarkerSize, getName, getNumber, getPaint, getStringAttribute, getTextFormat, getTickLength, getTransform, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, parseColor, remove, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setDensity, setFillColor, setFillColor, setFont, setFontName, setFontSize, setFontStyle, setImage, setLabelType, setLightColor, setLightColor, setLineColor, setLineColor, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerSize, setName, setNumber, setPaint, setTextFormat, setTextFormat, setTickLength, setTransform, setX, setY, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

dataRange

public void dataRange(double[] range)

Update the data range, range = {xmin,xmax,ymin,ymax}. The entries in range are updated to reflect the extent of the data in this node. The argument range is an input/output variable. Its value should be updated only if the data in this node is outside the range already in the array.

Overrides:

dataRange in class Data

Parameters:

range - a double array which contains the updated range, {xmin,xmax,ymin,ymax}

getControlLimit

public double getControlLimit()

Returns the value of the attribute "ControlLimit". This is the i-coordinate at which the line is drawn.

getMaximumValue

public double getMaximumValue()

Returns the maximum value of this control limit line.

Returns:

the maximum value for this control limit line. The default maximum value is positive infinity (no upper limit).

getMinimumValue

public double getMinimumValue()

Returns the minimum value of this control limit line.

Returns:

the minimum value for this control limit line. The default minimum value is negative infinity (no lower limit).

getValue

public double[] getValue()

Returns the value of this control limit line.

Returns:

the y-coordinate at which this control limit line is drawn.

paint

public void paint(Draw draw)

Paints the horizontal control limit line as wide as the window.

Overrides:

paint in class Data

Parameters:

draw - the Draw object to be painted

setControlLimit

public void setControlLimit(double controlLimit)

Sets the attribute "ControlLimit".

Parameters:

controlLimit - is the value of the "ControlLimit" attribute. This is the y-coordinate at which the line is drawn. Its default value is zero.

setMaximumValue

public void setMaximumValue(double maximumValue)

Set the maximum value of this control limit line. The default maximum value is positive infinity (no upper limit).

Parameters:

maximumValue - is the maximum value for this control limit line.

setMinimumValue

public void setMinimumValue(double minimumValue)

Set the minimum value of this control limit line. The default minimum value is negative infinity (no lower limit).

Parameters:

minimumValue - is the minimum value for this control limit line.

setValue

public void setValue(double y)

Sets the value of this control limit line. The actual value used is subject to minimum and maximum values set as attributes to this object.

Parameters:

y - is the y-coordinate at which this control limit line is drawn.

setValue

public void setValue(double[] y)

Sets the value of this control limit line to an array of values.

Parameters:

y - is an array containing the y-coordinates of a stair step line.