Package org.jfree.chart.renderer
Class OutlierListCollection
- java.lang.Object
-
- org.jfree.chart.renderer.OutlierListCollection
-
public class OutlierListCollection extends java.lang.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
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
highFarOut
Unbelievably, outliers which are more than 2 * interquartile range are called far outs...private boolean
lowFarOut
A flag that indicates whether or not the collection contains low far out values.private java.util.List<OutlierList>
outlierLists
Storage for the outlier lists.
-
Constructor Summary
Constructors Constructor Description OutlierListCollection()
Creates a new empty collection.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
add(Outlier outlier)
Appends the specified element as a newOutlierList
to the end of this list if it does not overlap an outlier in an existing list.boolean
isHighFarOut()
A flag to indicate the presence of one or more far out values at the top end of the range.boolean
isLowFarOut()
A flag to indicate the presence of one or more far out values at the bottom end of the range.java.util.Iterator<OutlierList>
iterator()
Returns an iterator for the outlier lists.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.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.private boolean
updateOutlierList(OutlierList list, Outlier outlier)
Updates the outlier list by adding the outlier to the end of the list and setting the averaged outlier to the average x and y coordinate values of the outliers in the list.
-
-
-
Field Detail
-
outlierLists
private final java.util.List<OutlierList> outlierLists
Storage for the outlier lists.
-
highFarOut
private boolean highFarOut
Unbelievably, outliers which are more than 2 * interquartile range are called far outs... See Tukey EDA (a classic one of a kind...)
-
lowFarOut
private boolean lowFarOut
A flag that indicates whether or not the collection contains low far out values.
-
-
Method Detail
-
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
.
-
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.
-
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
.
-
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.
-
add
public boolean add(Outlier outlier)
Appends the specified element as a newOutlierList
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).
-
iterator
public java.util.Iterator<OutlierList> iterator()
Returns an iterator for the outlier lists.- Returns:
- An iterator.
-
updateOutlierList
private boolean updateOutlierList(OutlierList list, Outlier outlier)
Updates the outlier list by adding the outlier to the end of the list and setting the averaged outlier to the average x and y coordinate values of the outliers in the list.- Parameters:
list
- the outlier list to be updated.outlier
- the outlier to be added- Returns:
- true (as per the general contract of Collection.add).
-
-