org.jfree.data.statistics

Class BoxAndWhiskerItem

public class BoxAndWhiskerItem extends Object implements Serializable

Represents one data item within a box-and-whisker dataset. Instances of this class are immutable.
Constructor Summary
BoxAndWhiskerItem(Number mean, Number median, Number q1, Number q3, Number minRegularValue, Number maxRegularValue, Number minOutlier, Number maxOutlier, List outliers)
Creates a new box-and-whisker item.
BoxAndWhiskerItem(double mean, double median, double q1, double q3, double minRegularValue, double maxRegularValue, double minOutlier, double maxOutlier, List outliers)
Creates a new box-and-whisker item.
Method Summary
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
NumbergetMaxOutlier()
Returns the maximum outlier.
NumbergetMaxRegularValue()
Returns the maximum regular value.
NumbergetMean()
Returns the mean.
NumbergetMedian()
Returns the median.
NumbergetMinOutlier()
Returns the minimum outlier.
NumbergetMinRegularValue()
Returns the minimum regular value.
ListgetOutliers()
Returns a list of outliers.
NumbergetQ1()
Returns the first quartile.
NumbergetQ3()
Returns the third quartile.
StringtoString()
Returns a string representation of this instance, primarily for debugging purposes.

Constructor Detail

BoxAndWhiskerItem

public BoxAndWhiskerItem(Number mean, Number median, Number q1, Number q3, Number minRegularValue, Number maxRegularValue, Number minOutlier, Number maxOutlier, List outliers)
Creates a new box-and-whisker item.

Parameters: mean the mean (null permitted). median the median (null permitted). q1 the first quartile (null permitted). q3 the third quartile (null permitted). minRegularValue the minimum regular value (null permitted). maxRegularValue the maximum regular value (null permitted). minOutlier the minimum outlier (null permitted). maxOutlier the maximum outlier (null permitted). outliers the outliers (null permitted).

BoxAndWhiskerItem

public BoxAndWhiskerItem(double mean, double median, double q1, double q3, double minRegularValue, double maxRegularValue, double minOutlier, double maxOutlier, List outliers)
Creates a new box-and-whisker item.

Parameters: mean the mean. median the median q1 the first quartile. q3 the third quartile. minRegularValue the minimum regular value. maxRegularValue the maximum regular value. minOutlier the minimum outlier value. maxOutlier the maximum outlier value. outliers a list of the outliers.

Since: 1.0.7

Method Detail

equals

public boolean equals(Object obj)
Tests this object for equality with an arbitrary object.

Parameters: obj the object to test against (null permitted).

Returns: A boolean.

getMaxOutlier

public Number getMaxOutlier()
Returns the maximum outlier.

Returns: The maximum outlier (possibly null).

getMaxRegularValue

public Number getMaxRegularValue()
Returns the maximum regular value.

Returns: The maximum regular value (possibly null).

getMean

public Number getMean()
Returns the mean.

Returns: The mean (possibly null).

getMedian

public Number getMedian()
Returns the median.

Returns: The median (possibly null).

getMinOutlier

public Number getMinOutlier()
Returns the minimum outlier.

Returns: The minimum outlier (possibly null).

getMinRegularValue

public Number getMinRegularValue()
Returns the minimum regular value.

Returns: The minimum regular value (possibly null).

getOutliers

public List getOutliers()
Returns a list of outliers.

Returns: A list of outliers (possibly null).

getQ1

public Number getQ1()
Returns the first quartile.

Returns: The first quartile (possibly null).

getQ3

public Number getQ3()
Returns the third quartile.

Returns: The third quartile (possibly null).

toString

public String toString()
Returns a string representation of this instance, primarily for debugging purposes.

Returns: A string representation of this instance.

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.