org.jfree.chart.renderer

Class OutlierListCollection

public class OutlierListCollection extends Object

A collection of outlier lists for a box and whisker plot. Each collection is associated with a single box and whisker entity. Outliers are grouped in lists for each entity. Lists contain one or more outliers, determined by whether overlaps have occurred. Overlapping outliers are grouped in the same list.

See Also: OutlierList

Constructor Summary
OutlierListCollection()
Creates a new empty collection.
Method Summary
booleanadd(Outlier outlier)
Appends the specified element as a new OutlierList to the end of this list if it does not overlap an outlier in an existing list.
booleanisHighFarOut()
A flag to indicate the presence of one or more far out values at the top end of the range.
booleanisLowFarOut()
A flag to indicate the presence of one or more far out values at the bottom end of the range.
Iteratoriterator()
Returns an iterator for the outlier lists.
voidsetHighFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the top end of the range.
voidsetLowFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the bottom end of the range.

Constructor Detail

OutlierListCollection

public OutlierListCollection()
Creates a new empty collection.

Method Detail

add

public boolean add(Outlier outlier)
Appends the specified element as a new OutlierList to the end of this list if it does not overlap an outlier in an existing list. If it does overlap, it is appended to the outlier list which it overlaps and that list is updated.

Parameters: outlier element to be appended to this list.

Returns: true (as per the general contract of Collection.add).

isHighFarOut

public boolean isHighFarOut()
A flag to indicate the presence of one or more far out values at the top end of the range.

Returns: A boolean.

isLowFarOut

public boolean isLowFarOut()
A flag to indicate the presence of one or more far out values at the bottom end of the range.

Returns: A boolean.

iterator

public Iterator iterator()
Returns an iterator for the outlier lists.

Returns: An iterator.

setHighFarOut

public void setHighFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the top end of the range.

Parameters: farOut the flag.

setLowFarOut

public void setLowFarOut(boolean farOut)
Sets the flag that indicates the presence of one or more far out values at the bottom end of the range.

Parameters: farOut the flag.