Module org.jfree.chart

Package org.jfree.data.statistics

Class BoxAndWhiskerItem

java.lang.Object

org.jfree.data.statistics.BoxAndWhiskerItem

All Implemented Interfaces:

Serializable

public class BoxAndWhiskerItem
extends Object
implements Serializable

Represents one data item within a box-and-whisker dataset. Instances of this class are immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BoxAndWhiskerItem(double mean, double median, double q1, double q3, double minRegularValue, double maxRegularValue, double minOutlier, double maxOutlier, List<? extends Number> outliers)	Creates a new box-and-whisker item.
BoxAndWhiskerItem(Number mean, Number median, Number q1, Number q3, Number minRegularValue, Number maxRegularValue, Number minOutlier, Number maxOutlier, List<? extends Number> outliers)	Creates a new box-and-whisker item.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Tests this object for equality with an arbitrary object.
Number	getMaxOutlier()	Returns the maximum outlier.
Number	getMaxRegularValue()	Returns the maximum regular value.
Number	getMean()	Returns the mean.
Number	getMedian()	Returns the median.
Number	getMinOutlier()	Returns the minimum outlier.
Number	getMinRegularValue()	Returns the minimum regular value.
List<? extends Number>	getOutliers()	Returns a list of outliers.
Number	getQ1()	Returns the first quartile.
Number	getQ3()	Returns the third quartile.
int	hashCode()
String	toString()	Returns a string representation of this instance, primarily for debugging purposes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BoxAndWhiskerItem

public BoxAndWhiskerItem(Number mean,
                         Number median,
                         Number q1,
                         Number q3,
                         Number minRegularValue,
                         Number maxRegularValue,
                         Number minOutlier,
                         Number maxOutlier,
                         List<? extends Number> 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<? extends Number> 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

getMean

public Number getMean()

Returns the mean.

Returns:

The mean (possibly null).

getMedian

public Number getMedian()

Returns the median.

Returns:

The median (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).

getMinRegularValue

public Number getMinRegularValue()

Returns the minimum regular value.

Returns:

The minimum regular value (possibly null).

getMaxRegularValue

public Number getMaxRegularValue()

Returns the maximum regular value.

Returns:

The maximum regular value (possibly null).

getMinOutlier

public Number getMinOutlier()

Returns the minimum outlier.

Returns:

The minimum outlier (possibly null).

getMaxOutlier

public Number getMaxOutlier()

Returns the maximum outlier.

Returns:

The maximum outlier (possibly null).

getOutliers

public List<? extends Number> getOutliers()

Returns a list of outliers.

Returns:

A list of outliers (possibly null).

toString

public String toString()

Returns a string representation of this instance, primarily for debugging purposes.

Overrides:

toString in class Object

Returns:

A string representation of this instance.

equals

public boolean equals(Object obj)

Tests this object for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object to test against (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Overrides:

hashCode in class Object